allox subkeys, step 1 (keys not active)
[fanfix.git] / src / be / nikiroo / fanfix / bundles / config.properties
1 # Configuration options
2 #
3
4
5 # language (example: en-GB, fr-BE...) or nothing for default system language
6 # (FORMAT: LOCALE) Force the language (can be overwritten again with the env variable $LANG)
7 LANG =
8 # reader type (CLI = simple output to console, TUI = Text User Interface with menus and windows, GUI = a GUI with locally stored files)
9 # (FORMAT: FIXED_LIST) Select the default reader to use to read stories
10 # ALLOWED VALUES: "CLI" "GUI" "TUI"
11 READER_TYPE =
12 # The type of output for the Local Reader for non-images documents
13 # (FORMAT: COMBO_LIST) One of the known output type
14 # ALLOWED VALUES: "INFO_TEXT" "EPUB" "HTML" "TEXT"
15 NON_IMAGES_DOCUMENT_TYPE = INFO_TEXT
16 # The type of output for the Local Reader for images documents
17 # (FORMAT: COMBO_LIST)
18 # ALLOWED VALUES: "CBZ" "HTML"
19 IMAGES_DOCUMENT_TYPE = CBZ
20 # absolute path, $HOME variable supported, / is always accepted as dir separator
21 # (FORMAT: DIRECTORY) The directory where to store temporary files, defaults to directory 'tmp' in the conig directory (usually $HOME/.fanfix)
22 CACHE_DIR =
23 # delay in hours, or 0 for no cache, or -1 for infinite time (default)
24 # (FORMAT: INT) The delay after which a cached resource that is thought to change ~often is considered too old and triggers a refresh
25 CACHE_MAX_TIME_CHANGING = 24
26 # delay in hours, or 0 for no cache, or -1 for infinite time (default)
27 # (FORMAT: INT) The delay after which a cached resource that is thought to change rarely is considered too old and triggers a refresh
28 CACHE_MAX_TIME_STABLE = 720
29 # string (FORMAT: STRING) The user-agent to use to download files
30 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)
31 # absolute path, $HOME variable supported, / is always accepted as dir separator
32 # (FORMAT: DIRECTORY) The directory where to get the default story covers
33 DEFAULT_COVERS_DIR = $HOME/.fanfix/covers/
34 # string (FORMAT: STRING) The default library to use (KEY:SERVER:PORT), or empty for the local library
35 DEFAULT_LIBRARY =
36 # The port on which we can start the server
37 # (FORMAT: INT) A valid port
38 SERVER_PORT = 58365
39 # The encryption key for the server (NOT including a subkey)
40 # (FORMAT: PASSWORD) cannot contain the pipe character (|)
41 SERVER_KEY =
42 # Allow write access to the clients by default (download story, move story...)
43 # (FORMAT: BOOLEAN)
44 SERVER_RW =
45 # If not empty, only the EXACT listed sources will be available for clients
46 # (FORMAT: STRING) list is comma-separated (,) and values are surrounded by double quotes ("); any double quote in the value must be backslash-escaped (with \")
47 SERVER_WHITELIST =
48 # The subkeys that the server will allow, including the modes
49 # (FORMAT: STRING) list is comma-separated (,) and values are surrounded by double quotes ("); any double quote in the value must be backslash-escaped (with \")
50 SERVER_ALLOWED_SUBKEYS =
51 # absolute path, $HOME variable supported, / is always accepted as dir separator
52 # (FORMAT: DIRECTORY) The directory where to store the library
53 LIBRARY_DIR = $HOME/Books
54 # boolean (FORMAT: BOOLEAN) Show debug information on errors
55 DEBUG_ERR = false
56 # boolean (FORMAT: BOOLEAN) Show debug trace information
57 DEBUG_TRACE = false
58 # image format (FORMAT: COMBO_LIST) Image format to use for cover images
59 # ALLOWED VALUES: "PNG" "JPG" "BMP"
60 IMAGE_FORMAT_COVER = PNG
61 # image format (FORMAT: COMBO_LIST) Image format to use for content images
62 # ALLOWED VALUES: "PNG" "JPG" "BMP"
63 IMAGE_FORMAT_CONTENT = JPG
64 # This item is used as a group, its content is not expected to be used.
65 LATEX_LANG =
66 # LaTeX output language: English
67 # (FORMAT: STRING) LaTeX full name
68 LATEX_LANG_EN = english
69 # LaTeX output language: French
70 # (FORMAT: STRING) LaTeX full name
71 LATEX_LANG_FR = french
72 # other 'by' prefixes before author name, used to identify the author
73 # (FORMAT: STRING)
74 # (This item accept a list of comma-separated values)
75 BYS = by,par,de,©,(c)
76 # List of languages codes used for chapter identification (should not be changed)
77 # (FORMAT: STRING) EN,FR
78 # (This item accept a list of comma-separated values)
79 CHAPTER = EN,FR
80 # Chapter identification String: English
81 # (FORMAT: STRING) used to identify a starting chapter in text mode
82 CHAPTER_EN = Chapter
83 # Chapter identification String: French
84 # (FORMAT: STRING) used to identify a starting chapter in text mode
85 CHAPTER_FR = Chapitre
86 # Login information (username) for YiffStar to have access to all the stories (should not be necessary anymore)
87 # (FORMAT: STRING)
88 LOGIN_YIFFSTAR_USER =
89 # Login information (password) for YiffStar to have access to all the stories (should not be necessary anymore)
90 # (FORMAT: PASSWORD)
91 LOGIN_YIFFSTAR_PASS =
92 # 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)
93 # (FORMAT: INT)
94 UPDATE_INTERVAL =
95 # (FORMAT: STRING) Format is ((user(:pass)@)proxy:port), with ':' being system proxy and an empty String being no proxy
96 USE_PROXY =
97 # An API key required to create a token from FimFiction
98 # (FORMAT: STRING)
99 LOGIN_FIMFICTION_APIKEY_CLIENT_ID =
100 # An API key required to create a token from FimFiction
101 # (FORMAT: PASSWORD)
102 LOGIN_FIMFICTION_APIKEY_CLIENT_SECRET =
103 # 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)
104 # (FORMAT: BOOLEAN)
105 LOGIN_FIMFICTION_APIKEY_FORCE_HTML =
106 # A token is required to use the beta APIv2 from FimFiction (see APIKEY_CLIENT_*)
107 # (FORMAT: PASSWORD)
108 LOGIN_FIMFICTION_APIKEY_TOKEN = Bearer WnZ5oHlzQoDocv1GcgHfcoqctHkSwL-D