diff options
Diffstat (limited to 'sproxy.yml.example')
| -rw-r--r-- | sproxy.yml.example | 62 |
1 files changed, 38 insertions, 24 deletions
diff --git a/sproxy.yml.example b/sproxy.yml.example index d539956..9fba77b 100644 --- a/sproxy.yml.example +++ b/sproxy.yml.example @@ -1,8 +1,13 @@ --- # Sproxy configuration. Don't remove this line. This is YAML: https://en.wikipedia.org/wiki/YAML +# Logging level: debug, info, warn, error. +# Optional. Default is debug. +# +# log_level: debug + # The port Sproxy listens on (HTTPS). # Optional. Default is 443. -# +# # listen: 443 # Listen on port 80 and redirect HTTP requests to HTTPS. @@ -24,10 +29,32 @@ # # home: "." + +# File with SSL certificate. Required. +# It can be a bundle with the server certificate coming first: +# cat me-cert.pem CA-cert.pem > cert.pem +# Once again: most wanted certs go first ;-) +# Or you can opt in using of `ssl_cert_chain` +ssl_cert: /path/cert.pem + +# File with SSL key (secret!). Required. +ssl_key: /path/key.pem + +# Chain SSL certificate files. +# Optional. Default is an empty list +# Example: +# ssl_cert_chain: +# - /path/foo.pem +# - /path/bar.pem +# +# ssl_cert_chain: [] + + # PostgreSQL database connection string. # Optional. If specified, sproxy will periodically pull the data from this # database into internal SQLite3 database. Define password in a file # referenced by the PGPASSFILE environment variable. Or use the "pgpassfile" option. +# Cannot be used with the "datafile" option. # Example: # database: "user=sproxy-readonly dbname=sproxy port=6001" # @@ -40,10 +67,16 @@ # # pgpassfile: -# Logging level: debug, info, warn, error. -# Optional. Default is debug. -# -# log_level: debug + +# YAML file used to fill internal SQLite3 database. +# Optional. If specified, Sproxy will import it on start overwriting +# and existing data in the internal database. +# Useful for development or some simple deployments. +# Cannot be used with the "database" option. +# For example see the datafile.yml.example +# +# datafile: /path/data.yml + # A file with arbitrary content used to sign sproxy cookie and other things (secret!). # Optional. If not specified, a random key is generated on startup, and @@ -54,25 +87,6 @@ # # key: /run/keys/sproxy.secret -# File with SSL certificate. Required. -# It can be a bundle with the server certificate coming first: -# cat me-cert.pem CA-cert.pem > cert.pem -# Once again: most wanted certs go first ;-) -# Or you can opt in using of `ssl_cert_chain` -ssl_cert: /path/cert.pem - -# File with SSL key (secret!). Required. -ssl_key: /path/key.pem - -# Chain SSL certificate files. -# Optional. Default is an empty list -# Example: -# ssl_cert_chain: -# - /path/foo.pem -# - /path/bar.pem -# -# ssl_cert_chain: [] - # Credentials for supported OAuth2 providers. # Currently supported: "google", "linkedin" |