Simple bookmarking service, using a SQLite database to store bookmarks, supporting tags and automatic title fetching.

Assuming you already are inside a virtualenv:

pip install digimarks

Create a new virtualenv (if you are not already in one) and install the necessary packages:

git clone https://github.com/aquatix/digimarks.git
cd digimarks
mkvirtualenv digimarks # or whatever project you are working on
pip install -r requirements.txt

Copy settings.py from example_config to the parent directory and configure to your needs (at the least change the value of SYSTEMKEY).

Do not forget to fill in the MASHAPE_API_KEY value, which you [can request on the RapidAPI website](https://rapidapi.com/realfavicongenerator/api/realfavicongenerator).

Run digimarks as a service under nginx or apache and call the appropriate url's when wanted.

Url's are of the form https://marks.example.com/<userkey>/<action>

digimarks can also be run from the command line: uvicorn digimarks:app --reload

Be sure to export/set the SECRETKEY environment variable before running, it's needed for some management URI's.

Run gunicorn -k uvicorn.workers.UvicornWorker for production. For an example of how to set up a server see this article with configuration for nginx, uvicorn, systemd, security and such.

The RQ background worker can be run from the command line: rq worker --with-scheduler

Url's are of the form https://hook.example.com/app/<appkey>/<triggerkey>

API documentation is auto-generated, and can be browsed at https://hook.example.com/docs

To easily save a link from your browser, open its bookmark manager and create a new bookmark with as url:

javascript:location.href='http://marks.example.com/1234567890abcdef/add?url='+encodeURIComponent(location.href);

After having set up the `settings.py` as under Usage, you can add a new user, by going to this path on your digimarks server:

/<secretkey>/adduser

where secretkey is the value set in settings.SYSTEMKEY

digimarks will then redirect to the bookmarks overview page of the new user. Please remember the user key (the hash in the url), as it will not be visible otherwise in the interface.

If you for whatever reason would lose this user key, just either look on the console (or webserver logs) where the list of available user keys is printed on digimarks startup, or open bookmarks.db with a SQLite editor.

• systemd for digimarks API which uses the gunicorn config
• `nginx for digimarks API`_
• more config

See the Changelog.

'M' favicon by Freepik.