diginaut/digimarks
1
0
Fork 0
mirror of https://codeberg.org/diginaut/digimarks.git synced 2026-03-22 00:00:48 +01:00
Code Issues Releases Wiki Activity

Updates and fixes

Browse Source
This commit is contained in:
Michiel Scholten
2026-02-11 14:15:43 +01:00
parent dae6c5da18
commit 71d5c6533d
1 changed files with 27 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
README.rst
View File

@@ -3,11 +3,15 @@ digimarks
|PyPI version| |PyPI license| |Code health| |Codacy|
Simple bookmarking service, using a SQLite database to store bookmarks, supporting tags and automatic title fetching.
📚 Overview
----------
Simple bookmarking service, using a SQLite database to store bookmarks, supporting tags and automatic title fetching. Notes can be added, the items are cached locally in the browser, and the API is documented so everything can be accessed through that too.
Installation
------------
📥 Installation
--------------
From PyPI
~~~~~~~~~
@@ -16,6 +20,10 @@ Assuming you already are inside a virtualenv:
.. code-block:: bash
# Using the wonderfully fast uv
uv pip install digimarks
# Alternatively, use Python pip
pip install digimarks
@@ -37,8 +45,8 @@ necessary packages:
uv sync --active
Migrating from version 1
------------------------
⚙️ Migrating from version 1
--------------------------
To be able to use the new database schema's, you will need to migrate your existing ``bookmarks.db`` to one under the control of the ``alembic`` migrations tool.
@@ -48,23 +56,24 @@ Then, stamp the initial migration into the database, and migrate to the latest v
.. code-block:: bash
# Initiate migrations with the first one (only needs to be done once!)
alembic stamp 115bcd2e1a38
# Apply all migrations to get up-to-date
alembic upgrade head
Usage / example configuration
-----------------------------
🛠️ Usage / example configuration
-------------------------------
OUT OF DATE!
⚠️ OUT OF DATE! ⚠️
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>`_.
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.
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>``
@@ -94,7 +103,7 @@ To easily save a link from your browser, open its bookmark manager and create a
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:
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
@@ -105,22 +114,22 @@ digimarks will then redirect to the bookmarks overview page of the new user. Ple
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
~~~~~~~~~~~~~~~~~~~~
🔧 Server configuration
~~~~~~~~~~~~~~~~~~~~~~
* `systemd for digimarks API`_ which uses the `gunicorn config`_
* `nginx for digimarks API`_
* `more config`_
What's new?
-----------
✨ What's new?
-------------
See the `Changelog`_.
Attributions
------------
🙏 Attributions
--------------
'M' favicon by `Freepik`_.