-
Notifications
You must be signed in to change notification settings - Fork 2
Environment Variables
This project uses dotenv to allow the definition of global variables in config files. There are twoconfig files in the project:
The postgres connection URL for the application database. This is the URL Knex will refer to.
_ex: _postgresql://makerspace:pgpassword@localhost:5433/pgdb
The name of the cookie that will be used to store the login session information. This can be any single-word string.
_ex: _super_secret
The url of the client react application. This is what the server runner will point to for page requests.
_ex: _http://localhost:3000
The url of the base url that clients should navigate to to access the web application. This will often be the same as REACT_APP_ORIGIN.
The postgres user name. This user should have complete read/write permissions for the database.
The password for the postgress user.
The postgress database slug.
_ex: _pgdb
The type of environment mode the server should start in. This makes a major difference in how user authentication will work. See Authentication.
_options: _development, staging, production
The NameID format that will be specified in any SAML requests. This should match the format expected by the IdP.
_ex: _"urn:oasis:names:tc:SAML:2.0:nameid-format:unspecified"
The public key to be used for the SAML requests. This should start with -----BEGIN CERTIFICATE----- and end with -----END CERTIFICATE-----. This is a multi-line variable.
The private key to be used for the SAML requests. This should start with -----BEGIN PRIVATE KEY----- and end with -----END PRIVATE KEY-----. This is a multi-line variable.
The public key of the IDP. This should not include any headers and is a single-line value. This value can be found in the metadata of the IdP in between the ds:X509Certificate tags.
The url the user will be redirected to log in. SAML requests will also be directed here.
_ex: _"https://mocksaml.com/api/saml/sso"
The url the IdP will send the user to after logging in at the Entry Point.
The url of the location of the SP's (this application's) SAML metadata. For use with Shibboleth, this value should be the public IP or domain of the application (not localhost) + /Shibboleth.sso/metadata.
_ex: _"http://129.21.158.138:3000/Shibboleth.sso/metadata"
Set this as TEST if using a Test IDP. This will avoid using RIT Shibboleth specific settings during user serialization. For production solutions, this attribute is not necessary.