v3.0.0-rc.3

To use this pre-release please use the docker image tag dullage/flatnotes:v3.0.0-rc.3.

🚨 Breaking Changes

• The port flatnotes uses inside the Docker container has been changed to 8080 (previously 80). If you using Docker to deploy flatnotes you will need to update your docker/docker-compose commands accordingly. This change was made to smooth the onboarding process for environments where privileged ports cannot be used by non-privileged users (see #28).
• To accompany the above change, support for the PORT environment variable has been removed.
• The note directory inside the Docker container has moved from /app/data to simply /data. If you using Docker to deploy flatnotes you will need to update your docker/docker-compose commands accordingly.

🗒️ Notable changes

• flatnotes now has a dark theme! 🌚
• New PUID and GUID environment variables are now supported for Docker deployments. These allow you to specify the user and group that flatnotes will run as inside the Docker container. This is useful to avoid permission issues when mounting a directory from the host.
• To support the above change, upon container start, the ownership of all files and directories in the data directory will be recursively changed to the specified user and group.

v2.2.0

Notable changes:

• The last mode used for the editor (e.g. markdown or wysiwyg) is now remembered on each device.
• There is now a friendly error message when a note title contains an invalid character (<>:"/\|?*). Previously this would just display a generic error message.
• Fixed an issue whereby draft content was not cleared if a note was saved with no changes.

v2.1.1

Notable changes:

• Fixed an issue whereby a server error would be reported after deleting a note.
• Bumped dependencies.
• Bumping the ToastUI Editor dependency resolved an issue when using the toolbar to add a table to a note.

v2.1.0

Notable changes:

• There are now 3 authentication types: "none", "password" (default) and "totp" (2FA). See the Environment Variables article in the wiki for more information.

v2.0.0

Notable changes:

• You are now able to tag documents 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 seperatly either by using the field prefix e.g. "tags:work" or using the hashtag shortcut e.g. "#work".
• Search results can now be ordered by score (default), title or last modified date.
• Search highlights can now be hidden in search results allowing for a compact view.
• You are now able to search on last modified date e.g. "last_modified:today" or "last_modified:[20220919 to 20220923]".
• Search speed has been dramatically improved.
• Searches no longer have a maximum number of results (previously this was 10).
• The /notes page has been removed in favour of a search for all notes /search?term=*.
• The related /api/notes endpoint has also been removed in favour of a search for all notes.
• The /api/search endpoint now includes sort, order and limit parameters.
• When ordering by score the /api/search endpoint now includes a score in the returned data.
• A new /api/tags endpoint has been added providing API users with a list of all indexed tags. This is currently unused in the frontend.
• There is a new index schema. Indexes using an older schema will be automatically rebuilt when flatnotes is first started.

v2.0.0-rc.1

Notable changes:

• You are now able to tag documents 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 seperatly either by using the field prefix e.g. "tags:work" or using the hashtag shortcut e.g. "#work".
• Search results can now be ordered by score (default), title or last modified date.
• Search highlights can now be hidden in search results allowing for a compact view.
• You are now able to search on last modified date e.g. "last_modified:today" or "last_modified:[20220919 to 20220923]".
• Search speed has been dramatically improved.
• Searches no longer have a maximum number of results (previously this was 10).
• The /notes page has been removed in favour of a search for all notes /search?term=*.
• The related /api/notes endpoint has also been removed in favour of a search for all notes.
• The /api/search endpoint now includes sort, order and limit parameters.
• When ordering by score the /api/search endpoint now includes a score in the returned data.
• A new /api/tags endpoint has been added providing API users with a list of all indexed tags. This is currently unused in the frontend.
• There is a new index schema. Indexes using an older schema will be automatically rebuilt when flatnotes is first started.

v1.0.4

Notable changes:

• A new PORT environment variable is now available to control the port flatnotes binds to within the container. This is useful for environments where unprivileged users are unable to bind to ports lower than 1025 within containers. See #28.

v1.0.3

Notable changes:

• Improved URL encoding when notes/search terms contain special characters.

v1.0.2

Notable changes:

• Mitigate timing attacks on /api/token endpoint.

v1.0.1

Notables changes:

• Username checks are now case insensitive.