allox subkeys, step 1 (keys not active)
[fanfix.git] / src / be / nikiroo / fanfix / bundles / config.properties
index 6151843c7660ae82c12f72fe5922de6454cffd33..63b7642a769e5773d183ec93422367a59c0bbf8d 100644 (file)
@@ -5,10 +5,18 @@
 # language (example: en-GB, fr-BE...) or nothing for default system language
 # (FORMAT: LOCALE) Force the language (can be overwritten again with the env variable $LANG)
 LANG = 
-# reader type (CLI = simple output to console, LOCAL = use local system file handler)
+# reader type (CLI = simple output to console, TUI = Text User Interface with menus and windows, GUI = a GUI with locally stored files)
 # (FORMAT: FIXED_LIST) Select the default reader to use to read stories
-# ALLOWED VALUES: "CLI" "LOCAL"
+# ALLOWED VALUES: "CLI" "GUI" "TUI"
 READER_TYPE = 
+# The type of output for the Local Reader for non-images documents
+# (FORMAT: COMBO_LIST) One of the known output type
+# ALLOWED VALUES: "INFO_TEXT" "EPUB" "HTML" "TEXT"
+NON_IMAGES_DOCUMENT_TYPE = INFO_TEXT
+# The type of output for the Local Reader for images documents
+# (FORMAT: COMBO_LIST) 
+# ALLOWED VALUES: "CBZ" "HTML"
+IMAGES_DOCUMENT_TYPE = CBZ
 # absolute path, $HOME variable supported, / is always accepted as dir separator
 # (FORMAT: DIRECTORY) The directory where to store temporary files, defaults to directory 'tmp' in the conig directory (usually $HOME/.fanfix)
 CACHE_DIR = 
@@ -17,23 +25,42 @@ CACHE_DIR =
 CACHE_MAX_TIME_CHANGING = 24
 # delay in hours, or 0 for no cache, or -1 for infinite time (default)
 # (FORMAT: INT) The delay after which a cached resource that is thought to change rarely is considered too old and triggers a refresh
-CACHE_MAX_TIME_STABLE = 
+CACHE_MAX_TIME_STABLE = 720
 # string (FORMAT: STRING) The user-agent to use to download files
 USER_AGENT = Mozilla/5.0 (X11; Linux x86_64; rv:44.0) Gecko/20100101 Firefox/44.0 -- ELinks/0.9.3 (Linux 2.6.11 i686; 80x24)
 # absolute path, $HOME variable supported, / is always accepted as dir separator
 # (FORMAT: DIRECTORY) The directory where to get the default story covers
-DEFAULT_COVERS_DIR = $HOME/bin/epub/
+DEFAULT_COVERS_DIR = $HOME/.fanfix/covers/
+# string (FORMAT: STRING) The default library to use (KEY:SERVER:PORT), or empty for the local library
+DEFAULT_LIBRARY = 
+# The port on which we can start the server
+# (FORMAT: INT) A valid port
+SERVER_PORT = 58365
+# The encryption key for the server (NOT including a subkey)
+# (FORMAT: PASSWORD) cannot contain the pipe character (|)
+SERVER_KEY = 
+# Allow write access to the clients by default (download story, move story...)
+# (FORMAT: BOOLEAN) 
+SERVER_RW = 
+# If not empty, only the EXACT listed sources will be available for clients
+# (FORMAT: STRING) list is comma-separated (,) and values are surrounded by double quotes ("); any double quote in the value must be backslash-escaped (with \")
+SERVER_WHITELIST = 
+# The subkeys that the server will allow, including the modes
+# (FORMAT: STRING) list is comma-separated (,) and values are surrounded by double quotes ("); any double quote in the value must be backslash-escaped (with \")
+SERVER_ALLOWED_SUBKEYS = 
 # absolute path, $HOME variable supported, / is always accepted as dir separator
 # (FORMAT: DIRECTORY) The directory where to store the library
 LIBRARY_DIR = $HOME/Books
 # boolean (FORMAT: BOOLEAN) Show debug information on errors
 DEBUG_ERR = false
+# boolean (FORMAT: BOOLEAN) Show debug trace information
+DEBUG_TRACE = false
 # image format (FORMAT: COMBO_LIST) Image format to use for cover images
 # ALLOWED VALUES: "PNG" "JPG" "BMP"
-IMAGE_FORMAT_COVER = png
+IMAGE_FORMAT_COVER = PNG
 # image format (FORMAT: COMBO_LIST) Image format to use for content images
 # ALLOWED VALUES: "PNG" "JPG" "BMP"
-IMAGE_FORMAT_CONTENT = png
+IMAGE_FORMAT_CONTENT = JPG
 # This item is used as a group, its content is not expected to be used.
 LATEX_LANG = 
 # LaTeX output language: English
@@ -65,3 +92,17 @@ LOGIN_YIFFSTAR_PASS =
 # If the last update check was done at least that many days, check for updates at startup (-1 for 'no checks' -- default is 1 day)
 # (FORMAT: INT) 
 UPDATE_INTERVAL = 
+#  (FORMAT: STRING) Format is ((user(:pass)@)proxy:port), with ':' being system proxy and an empty String being no proxy
+USE_PROXY = 
+# An API key required to create a token from FimFiction
+# (FORMAT: STRING) 
+LOGIN_FIMFICTION_APIKEY_CLIENT_ID = 
+# An API key required to create a token from FimFiction
+# (FORMAT: PASSWORD) 
+LOGIN_FIMFICTION_APIKEY_CLIENT_SECRET = 
+# Do not use the new API, even if we have a token, and force HTML scraping (default is false, use API if token or ID present)
+# (FORMAT: BOOLEAN) 
+LOGIN_FIMFICTION_APIKEY_FORCE_HTML = 
+# A token is required to use the beta APIv2 from FimFiction (see APIKEY_CLIENT_*)
+# (FORMAT: PASSWORD) 
+LOGIN_FIMFICTION_APIKEY_TOKEN = Bearer WnZ5oHlzQoDocv1GcgHfcoqctHkSwL-D