Theunis Botha
f2e9697788
|
||
|---|---|---|
| nginx/sites-available | ||
| .gitignore | ||
| README.md | ||
| bash_aliases | ||
| build_latest | ||
| ca-chain.cert.pem | ||
| checkout_all | ||
| config.js | ||
| cybafelo.local.cert.pem | ||
| cybafelo.local.key.pem | ||
| delete | ||
| hosts | ||
| logs | ||
| package-lock.json | ||
| package.json | ||
| restart | ||
| secure.js | ||
| start | ||
| start_r3_api | ||
| status_all | ||
| stop | ||
| track_all | ||
| update_all | ||
README.md
#R3 - Configuration Package
This package contains all R3 configuration variables which should be unique to each deployment of R3
#Authentication
* config.js -> contains the client password
* secure.js -> should only be included 'server' side and contains the server password.
For updates to the API to be successful (saving, deleting of components and uploads), these passwords have to match.
#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)