Simple bookmarking service
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
example_config
static
templates
.gitignore
CHANGELOG.md
LICENSE
README.rst
__init__.py
digimarks.py
requirements-dev.in
requirements-dev.txt
requirements.in
requirements.txt
setup.py
wsgi.py

README.rst

digimarks

PyPI version PyPI license Code Health Codacy Badge

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

Installation

From PyPI

Assuming you already are inside a virtualenv:

pip install digimarks

From Git

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

Usage / example configuration

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

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>

Bookmarklet

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);

Creating a new user

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.

Server configuration

What's new?

See the Changelog.

Attributions

'M' favicon by Freepik.