From 315c664fcc1d546d2e3e612391f6bb6cf102a953 Mon Sep 17 00:00:00 2001 From: Michiel Scholten Date: Wed, 6 May 2020 14:04:33 +0200 Subject: [PATCH] Document the RapidAPI (MashApe) key for favicons --- README.rst | 10 ++-------- example_config/settings.py | 4 ++++ 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index 0d93c15..06cf965 100644 --- a/README.rst +++ b/README.rst @@ -39,6 +39,8 @@ 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. @@ -69,14 +71,6 @@ 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. -MASHAPE_API_KEY ---------------- - -and MASHAPE_API_KET value add in setting.py. - -MASHAPE_API_KEY = 'new-api-key' - - Server configuration ~~~~~~~~~~~~~~~~~~~~ diff --git a/example_config/settings.py b/example_config/settings.py index 1e1f1ac..73e22ce 100644 --- a/example_config/settings.py +++ b/example_config/settings.py @@ -10,6 +10,10 @@ DEBUG = False # echo -n "yourstring" | sha1sum SYSTEMKEY = 'S3kr1t' +# RapidAPI key for favicons +# https://rapidapi.com/realfavicongenerator/api/realfavicongenerator +MASHAPE_API_KEY = 'your_MASHAPE_key' + LOG_LOCATION = 'digimarks.log' #LOG_LOCATION = '/var/log/digimarks/digimarks.log' # How many logs to keep in log rotation: