diff --git a/README.rst b/README.rst index e079140..2518ab5 100644 --- a/README.rst +++ b/README.rst @@ -33,18 +33,36 @@ necessary packages: pip install -r requirements.txt +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. + +To do so, start with making a backup of this ``bookmarks.db`` file to a safe place. + +Then, stamp the initial migration into the database, and migrate to the latest version: + +.. code-block:: bash + + alembic stamp 115bcd2e1a38 + + alembic upgrade head + + Usage / example configuration ----------------------------- +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 `_. 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// +Url's are of the form ``https://marks.example.com//`` digimarks can also be run from the command line: ``uvicorn digimarks:app --reload``