aquatix / digimarks

Simple bookmarking service

digimarks

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

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>

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

• vhost for Apache2.4
• uwsgi.ini

What's new?

See the Changelog.

Attributions

'M' favicon by Freepik.

digimarks's Issues

AttributeError: module 'settings' has no attribute 'MASHAPE_API_KEY'

I installed digimarks with README.rst instruction.
but, when I bookmark add, following Error occured at brower screen and log .

127.0.0.1 - - [28/Apr/2020 10:01:02] "POST /0b239ff2044ef51995db310acdba97a36973af73616cf424/adding HTTP/1.1" 500 -
Traceback (most recent call last):
  File "/opt/ws/digimarks/p3/lib/python3.7/site-packages/flask/app.py", line 2463, in __call__
    return self.wsgi_app(environ, start_response)
  File "/opt/ws/digimarks/p3/lib/python3.7/site-packages/flask/app.py", line 2449, in wsgi_app
    response = self.handle_exception(e)
  File "/opt/ws/digimarks/p3/lib/python3.7/site-packages/flask/app.py", line 1866, in handle_exception
    reraise(exc_type, exc_value, tb)
  File "/opt/ws/digimarks/p3/lib/python3.7/site-packages/flask/_compat.py", line 39, in reraise
    raise value
  File "/opt/ws/digimarks/p3/lib/python3.7/site-packages/flask/app.py", line 2446, in wsgi_app
    response = self.full_dispatch_request()
  File "/opt/ws/digimarks/p3/lib/python3.7/site-packages/flask/app.py", line 1951, in full_dispatch_request
    rv = self.handle_user_exception(e)
  File "/opt/ws/digimarks/p3/lib/python3.7/site-packages/flask/app.py", line 1820, in handle_user_exception
    reraise(exc_type, exc_value, tb)
  File "/opt/ws/digimarks/p3/lib/python3.7/site-packages/flask/_compat.py", line 39, in reraise
    raise value
  File "/opt/ws/digimarks/p3/lib/python3.7/site-packages/flask/app.py", line 1949, in full_dispatch_request
    rv = self.dispatch_request()
  File "/opt/ws/digimarks/p3/lib/python3.7/site-packages/flask/app.py", line 1935, in dispatch_request
    return self.view_functions[rule.endpoint](**req.view_args)
  File "/opt/ws/digimarks/digimarks.py", line 781, in addingbookmark
    bookmark = updatebookmark(userkey)
  File "/opt/ws/digimarks/digimarks.py", line 765, in updatebookmark
    bookmark.set_favicon()
  File "/opt/ws/digimarks/digimarks.py", line 412, in set_favicon
    self._set_favicon_with_realfavicongenerator(domain)
  File "/opt/ws/digimarks/digimarks.py", line 362, in _set_favicon_with_realfavicongenerator
    headers={'User-Agent': DIGIMARKS_USER_AGENT, 'X-Mashape-Key': settings.MASHAPE_API_KEY}
AttributeError: module 'settings' has no attribute 'MASHAPE_API_KEY'

and I add MASHAPE_API_KEY at settings.py like this

MASHAPE_API_KEY = '[MY-SECRET-API-KEY]'

Digimarks looks like run normaly.
My suggestion, description of MASHAPE_API_KEY add to README.rst

Redirect fail with digimarks behinde reverse proxy.

I installed digimarks server behind reverse proxy.

https:// ====> reverse proxt : http:// =====> digimarks

in case, digimarks fail redirect after bookmark adding, editing ....

workaround: these code put in before app.run()

if name == 'main':
# run the application
#----- from here
from werkzeug.contrib.fixers import ProxyFix
app.wsgi_app = ProxyFix(app.wsgi_app)
#----- to
app.run(host='0.0.0.0', port=9999, debug=True)

chrome extension

It would be great if there was a chrome extension for managing bookmarks that integrated with digimarks.

An alternative would be for digimarks to e.g. implement an existing API (del.icio.us?) so that existing extensions for that API can be used with digimarks.

Allow for switching themes by url request

https://marks.example.com/[bookmarkpageID]/[secretkey1]/theme/lightblue would set the theme for bookmarkpageID to 'lightblue'.

Ensure Python 3 compatibility

Currently, digimarks sort of assumes Python 2, which is... well... not optimal. Ensure it works under Python 3.5/3.6 too, or maybe even only support Python 3.

I would like to have an alternative for the default (green) theme

Implement theming support, having the user choose between some pre-defined colour schemes.

Option to hide bookmarks with certain tags

Ability to hide bookmarks based on a set of tags (for example, 'work', or 'surpiseparty').

unit tests

digimarks currently does not have any unit tests, which makes making refactoring/improvements harder.

Replace defunct favicon service with RealFaviconGenerator

More on https://realfavicongenerator.net/api/download_website_favicon and https://rapidapi.com/realfavicongenerator/api/RealFaviconGenerator/functions/Website%20icon

Create UI overlay for bookmarklet

I think it will be cool to have a popup style bookmarklet with some javascript injected into the page instead of being redirected away from the page. The injected javascript can do the API calls

Allow people to create their own page

As you can already kind of do so by just randomly enter a URL and start adding bookmarks [1], allow people to create a page on their own.

Preferably by using something like https://github.com/trezor/python-mnemonic for more friendly url's, or offer the choice between that and a more secret random string.

This can easily be implemented by a button on the homepage of a digimarks installation.

[1] which is slightly buggy as you don't have a User object, so you can't create public tag pages

Allow for better access control

By changing to a url scheme of:

https://marks.example.com/[bookmarkpageID]/
https://marks.example.com/[bookmarkpageID]/[secretkey1]
https://marks.example.com/[bookmarkpageID]/[secretkey2]

one can allow for sharing bookmark 'accounts' read-only and giving select people secret keys to be able to add and edit bookmarks (and tags).