ZanSara/notes

A self-hosted, database-less note taking web app that utilises a flat folder of markdown files for storage.

Log into the demo site and take a look around. Note: This site resets every 15 minutes.

Design Principle

flatnotes is designed to be a distraction free note taking app that puts your note content first. This means:

A clean and simple user interface.
No folders, notebooks or anything like that. Just all of your notes, backed by powerful search and tagging functionality.
Quick access to a full text search from anywhere in the app (keyboard shortcut "/").

Another key design principle is not to take your notes hostage. Your notes are just markdown files. There's no database, proprietary formatting, complicated folder structures or anything like that. You're free at any point to just move the files elsewhere and use another app.

Equally, the only thing flatnotes caches is the search index and that's incrementally synced on every search (and when flatnotes first starts). This means that you're free to add, edit & delete the markdown files outside of flatnotes even whilst flatnotes is running.

Installation

The easiest way to install flatnotes is using Docker.

Note: To use either of the options below, please ensure the current directory contains a folder called "data" and that it's writable by user 1000.

Example Docker Run Command

docker run -d \
  -e "FLATNOTES_AUTH_TYPE=password" \
  -e "FLATNOTES_USERNAME=user" \
  -e "FLATNOTES_PASSWORD=changeMe" \
  -e "FLATNOTES_SECRET_KEY=aLongRandomSeriesOfCharacters" \
  -v "$(pwd)/data:/app/data" \
  -p "80:80" \
  dullage/flatnotes:latest

Example Docker Compose

version: "3"

services:
  flatnotes:
    container_name: flatnotes
    image: dullage/flatnotes:latest
    environment:
      FLATNOTES_AUTH_TYPE: "password"
      FLATNOTES_USERNAME: "user"
      FLATNOTES_PASSWORD: "changeMe!"
      FLATNOTES_SECRET_KEY: "aLongRandomSeriesOfCharacters"
    volumes:
      - "./data:/app/data"
      # - "./index:/app/data/.flatnotes"
      # Optional. Allows you to save the search index in a different location. 
    ports:
      - "80:80"
    restart: unless-stopped

See the Environment Variables article in the wiki for a full list of configuration options.

Q&A

Where is the database?

There is no database, only a single folder of markdown files (and the .flatnotes sub-folder).

What is the .flatnotes sub-folder for?

This stores a full text index of your note content allowing for rapid search times.

Can I delete the .flatnotes sub-folder?

As long as flatnotes isn't running, sure! It'll just get rebuilt then next time flatnotes is run.

Can I add, edit & delete the markdown files outside of flatnotes?

Yup. The only thing flatnotes caches is the search index and that's synced on every search (and when flatnotes first starts).

Can I perform advanced searches?

Yes! See the Advanced Searching wiki page.

How do I get my notes out of flatnotes?

They're just markdown files. You're free to just move the files elsewhere and use another app.

Is there an API?

Yes. The docs are available at the /docs endpoint. See demo.flatnotes.io/docs as an example.

If there aren't any folders, how to I organise my notes?

The first option is to choose not to. This frees you from the burden of organisation. You can then rely on flatnotes' powerful search functionality to find the note you are looking for.

Additionally you are able to tag notes by using a hashtag anywhere in the note content e.g. #work. Tags are indexed separately from the rest of the content and so can be searched separately either by using the field prefix e.g. "tags:work" or using the hashtag shortcut e.g. "#work".

What types of authentication are supported?

There are 3 types:

None = No authentication, the site is open to anyone with access.
Password = The site is protected by a username and password.
TOTP = In addition to a username and password, the site is also protected by a time based one-time-password.

See the Environment Variables article in the wiki for more information.

Roadmap

I want to keep flatnotes as simple and distraction free as possible which means limiting new features. This said, I welcome feedback and suggestions.

One feature I do plan to implement is the ability to share a note. In the spirit of simple and database-less, the current plan is to generate temporary pre-signed URLs but this needs to be explored.

Sponsorship

If you find this project useful, please consider buying me a coffee. It would make my day.

Thanks

A special thanks to 2 fantastic open source projects that make flatnotes possible.

Whoosh - A fast, pure Python search engine library.
TOAST UI Editor - A GFM Markdown and WYSIWYG editor for the browser.

ZanSara / notes