diff --git a/README.org b/README.org new file mode 100644 index 0000000..ab29175 --- /dev/null +++ b/README.org @@ -0,0 +1,20 @@ +#+title: Readme + +Vrobbler is a pretty simple Django-powered web app for scrobbling video plays from you favorite Jellyfin installation. + +At the most basic level, you should be able to run `pip install vrobbler` to the latest version from pypi.org. + +Then configure a handful of options in your vrobbler.conf files, which can live in /etc/ or /usr/local/etc/ depending on your configuration. + +You can checkout the `scrobbler.conf.example` file in the source for this project, or refer to the following guide: + +``` +VROBBLER_DEBUG=True +VROBBLER_JSON_LOGGING=True +VROBBLER_LOG_LEVEL="DEBUG" +VROBBLER_MEDIA_ROOT = "/media/" +VROBBLER_TMDB_API_KEY = "" +VROBBLER_KEEP_DETAILED_SCROBBLE_LOGS=True +VROBBLER_DATABASE_URL="postgres://vrobbler:@db.service:5432/vrobbler" +VROBBLER_REDIS_URL="redis://:@cache.service:6379/0" +``` diff --git a/vrobbler.conf.example b/vrobbler.conf.example index e6d13ee..0c1099e 100644 --- a/vrobbler.conf.example +++ b/vrobbler.conf.example @@ -1,5 +1,11 @@ # You can use this file to set environment variables for your local setup # -VROBBLER_MEDIA_ROOT="/media" -VROBBLER_DATABASE_URL="postgres://USER:PASSWORD@HOST:PORT/NAME" +VROBBLER_DEBUG=True VROBBLER_JSON_LOGGING=True +VROBBLER_LOG_LEVEL="DEBUG" +VROBBLER_MEDIA_ROOT = "/media/" +VROBBLER_TMDB_API_KEY = "KEY" +VROBBLER_KEEP_DETAILED_SCROBBLE_LOGS=True + +VROBBLER_DATABASE_URL="postgres://USER:PASSWORD@HOST:PORT/NAME" +VROBBLER_REDIS_URL="redis://:PASS@HOST:6379/0"