소스 검색

Update some docs

Colin Powell 2 년 전
부모
커밋
f274aa7d0e
2개의 변경된 파일28개의 추가작업 그리고 2개의 파일을 삭제
  1. 20 0
      README.org
  2. 8 2
      vrobbler.conf.example

+ 20 - 0
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 = "<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"
+```

+ 8 - 2
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"