r3-config/README.md

36 lines
1.5 KiB
Markdown
Raw Normal View History

2018-04-12 10:58:35 +02:00
#R3 - Configuration Package
2016-11-08 12:34:17 +01:00
2018-04-12 10:58:35 +02:00
This package contains all R3 configuration variables which should be unique to each deployment of R3
2016-11-08 12:34:17 +01:00
2018-11-18 08:00:15 +01:00
#Authentication
2018-04-12 10:58:35 +02:00
config.js contains the client password
2016-11-08 12:34:17 +01:00
2018-04-12 10:58:35 +02:00
secure.js should only be included 'server' side and contains the server password.
2016-11-08 12:34:17 +01:00
2018-04-12 10:58:35 +02:00
For updates to the API to be successful (saving, deleting of components and uploads), these passwords have to match.
2016-11-08 12:34:17 +01:00
2018-11-18 08:00:15 +01:00
#Nginx Config
The nginx config for r3-api lives in this package under nginx subfolder. The default location for installation of all r3 packages is /usr/share/cybafelo.
When you install into this location (i.e. /usr/share/cybafelo/r3, /usr/share/cybafelo/r3-api ...) you will not have to modify the nginx configuration.
#SSL
For SSL web server deployments you are free to use the files:
cybafelo.local.cert.pem -> this is the certificate file in the nginx config
cybafelo.local.key.pem -> this is the private key used to generate the certificate
For your browser to accept this certificate and not display a red warning, you can import the following certificate chain file into the CA section of your browser options.
ca-chain.cert.pem
And no - R3 does NOT support the silly web browser from a giant corrupt software company that now owns github.com
#Hosts
The hosts file contains the host aliases for localhost - it allows the nginx config to determine the mode (live or development), application (r3-api, r3-editor, etc) and the domain associated with the SSL certificate (in our case cybafelo.local)