summaryrefslogtreecommitdiff
path: root/beinc_config_sample.json.readme
diff options
context:
space:
mode:
Diffstat (limited to 'beinc_config_sample.json.readme')
-rw-r--r--beinc_config_sample.json.readme26
1 files changed, 18 insertions, 8 deletions
diff --git a/beinc_config_sample.json.readme b/beinc_config_sample.json.readme
index 12a1b2d..3ac85a9 100644
--- a/beinc_config_sample.json.readme
+++ b/beinc_config_sample.json.readme
@@ -16,17 +16,27 @@ documentation to better illustrate the comments.
16 # It is only used by beinc_server.py and ignored by all other 16 # It is only used by beinc_server.py and ignored by all other
17 # components 17 # components
18 18
19 "general": { # Applies to the whole server (cherrypy) For more info: 19 "general": { # Applies to the whole server
20 # http://docs.cherrypy.org/en/latest/refman/_cpserver.html
21
22 # The name of a registered SSL adaptation module
23 "ssl_module": "pyopenssl",
24 20
25 # The filename of the private key to use with SSL. 21 # The filename of the private key to use with SSL.
26 "ssl_private_key": "/home/user/keys/key.pem", # default: None 22 "ssl_private_key": "/home/user/keys/key.pem", # default: None
27 23
28 # The filename of the SSL certificate to use 24 # The filename of the SSL certificate to use
29 "ssl_certificate": "/home/user/certs/cert.crt" # default: None 25 "ssl_certificate": "/home/user/certs/cert.crt", # default: None
26
27 # A list of allowed ciphers in the format of 'openssl ciphers'
28 # "auto" - use the Twisted / OpenSSL defaults
29 "ssl_acceptable_ciphers": "auto", # default: "auto"
30
31 # Encryption method for the BEINC server
32 # Possible values:
33 # "auto" - Let Twisted decide (use the newest possible method)
34 # "SSLv3" - SSLv3 (weak)
35 # "TLSv1" - TLSv1.0
36 # "TLSv1_1" - TLSv1.1
37 # "TLSv1_2" - TLSv1.2 (most secure, but requires OpenSSL >= 1.0.1e)
38 "ssl_method": "auto", # default: "auto"
39
30 }, 40 },
31 41
32 # A list of instances. Check README for general information about them! 42 # A list of instances. Check README for general information about them!
@@ -185,10 +195,10 @@ documentation to better illustrate the comments.
185 ] 195 ]
186 }, 196 },
187 # The version of this config file 197 # The version of this config file
188 # Default: 1 (you should really never leave it undefined) 198 # Default: 2 (you should really never leave it undefined)
189 # Used by beinc_server and beinc_weechat to check whether 199 # Used by beinc_server and beinc_weechat to check whether
190 # the config (.json) file is outdated. 200 # the config (.json) file is outdated.
191 # Every future version of BEINC will be shipped with 201 # Every future version of BEINC will be shipped with
192 # beinc_config_sample.json and beinc_config_sample.json.readme 202 # beinc_config_sample.json and beinc_config_sample.json.readme
193 "config_version": 1 203 "config_version": 2
194} 204}