Table of Contents
Configuration Variables
Basic Configurations
- GNVERSION: The current version of GN2
- GN2PROXY: URL to the GN2 proxy service
- GNSERVERURL: URL to the GN3 REST API server
- GN2BASEURL: ??
- GN2BRANCHURL:
- SERVERPORT: The port on which to run GN2. This is passed on to Flask.
- SECRETHMACCODE:
- GENENETWORKFILES: Base directory for all static data files
- HOME: The home directory of the user that GN2 runs as
Redis Configurations
- REDISURL: The url to use to connect to the running redis instance
- USEREDIS: Redis caching
Database (MySQL) Configurations
- SQLURI: The URI to the database server in the form
mysql://<username>:<password>@<host>:<port>/<dbname>. Replace the items in the angle brackets with the appropriate values for each item. - SQLALCHEMYPOOLRECYCLE: Probably obsoleted - the use of ORMs (ha/i)s be(en/ing) phased off
Flask-Specific Configurations
- TRAPBADREQUESTERRORS:
- SECURITYCONFIRMABLE:
- SECURITYTRACKABLE:
- SECURITYREGISTERABLE:
- SECURITYRECOVERABLE:
- SECURITYEMAILSENDER:
- SECURITYPOSTLOGINVIEW:
External Services
GitHub Configurations
- GITHUBCLIENTID: Client identifier key for GitHub OAuth authentication
- GITHUBCLIENTSECRET: Client authentication token for github
- GITHUBAUTHURL: The url to use for authenticating the client (GN2) with GitHub. Default: https://github.com/login/oauth/authorize
- GITHUBAPIURL: Once the client (GN2) is authenticated with GitHub, this URI is the used to authenticate users using GitHub. The default value is https://api.github.com/user
ORCID Configurations
- ORCIDCLIENTID: Client identifier key for ORCID OAuth authentication
- ORCIDCLIENTSECRET: Client authentication token for ORCID
- ORCIDAUTHURL: The url to use for authenticating the client (GN2) with ORCID. Default: https://orcid.org/oauth/authorize
- ORCIDTOKENURL: The URI to acquire a token once GN2 has been authenticated with ORCID. This token is used to authenticate users with the ORCID service. The default value is https://orcid.org/oauth/token
Mail Configurations
- SMTPCONNECT:
- SMTPUSERNAME:
- SMTPPASSWORD:
Javascript Configurations
- JSGNPATH: Path to local javascript libraries for development purposes only. See ./development.html for more details
External Commands Configurations
- REAPERCOMMAND: The path to the reaper command/executable
Behavioral Settings
- WEBSERVERMODE: Determines how the service is run.
If the value is
DEBUG, the service is run in debug mode - debug tools are activated for the application. If the value isDEV, the service is run in development mode; logging is activated. - WEBSERVERBRANDING: Probably unused - verify and remove.
- WEBSERVERDEPLOY: Probably unused - verify and remove.
- WEBSERVERURL: Probably unused - verify and remove.
- LOGLEVEL:
- LOGLEVELDEBUG:
- LOGSQL:
- LOGSQLALCHEMY:
- LOGBENCH:
- USEGNSERVER: ??