https://github.com/klingtnet/notes

A personal note/journal server with extended markdown support and full text search.
https://github.com/klingtnet/notes

go journal notebook notes sqlcipher

Last synced: about 2 months ago
JSON representation

A personal note/journal server with extended markdown support and full text search.

• Host: GitHub
• URL: https://github.com/klingtnet/notes
• Owner: klingtnet
• License: agpl-3.0
• Created: 2020-10-07T17:58:18.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-11-21T08:40:52.000Z (over 5 years ago)
• Last Synced: 2024-03-21T21:49:13.758Z (almost 2 years ago)
• Topics: go, journal, notebook, notes, sqlcipher
• Language: Go
• Homepage:
• Size: 439 KB
• Stars: 7
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# notes - a journal server

- ![CI](https://github.com/klingtnet/notes/workflows/CI/badge.svg)

- [Releases][releases]

`notes` is a web service equivalent to a notebook, you can store ideas and look for them with a full text search.  The search makes it even better than a notebook.

Notes are stored in a encrypted SQLite database using SQLCipher.

It supports github flavored markdown and everything is contained in a single binary (execpt the database file).

I am happy to get pull requests and here a couple of improvement ideas:

- [ ] mark tasks as finished by clicking on a checkbox

- [ ] only show open tasks

- [ ] add pagination or date filtering

## Installation

For Linux users with a working Go setup the easiest way is to install the server and its systemd user service using by running `make install`.

You can also [grab a prebuilt binary from the releases page][releases] and copy it into your `$PATH`.

A database file is created on the first start at `$XDG_CONFIG_HOME/notes/notes.db` or wherever you set the argument of `--database-path` to.

It is important to set a proper database password on the first run using `DATABASE_PASSPHRASE` environment variable (you can use the flag as well but [this comes with some security downsides][so-password].)

At the moment there is no option to change the password but you should be able to achieve that in a db shell session (`scripts/dbshell` shows how to start such a session).

[releases]: https://github.com/klingtnet/notes/releases

[so-password]: https://security.stackexchange.com/questions/14000/environment-variable-accessibility-in-linux/14009#14009