Update some docs
This commit is contained in:
20
README.org
Normal file
20
README.org
Normal file
@ -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 = "<key>"
|
||||||
|
VROBBLER_KEEP_DETAILED_SCROBBLE_LOGS=True
|
||||||
|
VROBBLER_DATABASE_URL="postgres://vrobbler:<pass>@db.service:5432/vrobbler"
|
||||||
|
VROBBLER_REDIS_URL="redis://:<pass>@cache.service:6379/0"
|
||||||
|
```
|
||||||
@ -1,5 +1,11 @@
|
|||||||
# You can use this file to set environment variables for your local setup
|
# You can use this file to set environment variables for your local setup
|
||||||
#
|
#
|
||||||
VROBBLER_MEDIA_ROOT="/media"
|
VROBBLER_DEBUG=True
|
||||||
VROBBLER_DATABASE_URL="postgres://USER:PASSWORD@HOST:PORT/NAME"
|
|
||||||
VROBBLER_JSON_LOGGING=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"
|
||||||
|
|||||||
Reference in New Issue
Block a user