-
Notifications
You must be signed in to change notification settings - Fork 19
Environmental variables
- APICORE_SERVER_NAME - string, required
- APICORE_SERVER_URL - string, required
- APICORE_SERVER_INTERFACE - string, required
- APICORE_SERVER_PATH_PREFIX - string, optional
- APICORE_SERVER_MAX_UPLOAD_FILESIZE - number, 50
- APICORE_AUTH_ALLOW_LOGIN - boolean, optional
- APICORE_AUTH_ALLOW_REGISTRATIONS - boolean, optional
- APICORE_AUTH_REGISTRATION_DOMAINS - string, optional (comma separated)
- APICORE_AUTH_ALLOW_INVITATIONS - boolean, optional
- APICORE_AUTH_INVITATION_DOMAINS - string, optional (comma separated)
- APICORE_JWT_SECRET - string, required
- APICORE_DATABASE_HOST - string, required
- APICORE_DATABASE_PORT - number, 5432
- APICORE_DATABASE_DATABASE - string, required
- APICORE_DATABASE_USER - string, required
- APICORE_DATABASE_PASSWORD - string, required
- APICORE_DATABASE_LOGGING - boolean, false
- APICORE_MAIL_EMAIL - string, required
- APICORE_MAIL_MAILGUN_DOMAIN - string, required
- APICORE_MAIL_MAILGUN_KEY - string, required
- APICORE_STORAGE_S3_ENABLED - boolean, optional
- APICORE_STORAGE_S3_BUCKET - string, optional
- APICORE_STORAGE_S3_REGION - string, optional
- APICORE_STORAGE_S3_ACCESS_KEY - string, optional
- APICORE_STORAGE_S3_SECRET_KEY - string, optional
- APICORE_AUTH_GITHUB_ENABLED - boolean, optional
- APICORE_AUTH_GITHUB_CLIENT - string, optional
- APICORE_AUTH_GITHUB_SECRET - string, optional
- APICORE_AUTH_GITHUB_HOST - string, optional
- APICORE_AUTH_GITHUB_API - string, optional
- APICORE_AUTH_GITHUB_TEAMS - array, optional
- APICORE_AUTH_GITLAB_ENABLED - boolean, optional
- APICORE_AUTH_GITLAB_APPLICATION - string, optional
- APICORE_AUTH_GITLAB_SECRET - string, optional
- APICORE_AUTH_GITLAB_HOST - string, optional
- APICORE_AUTH_GITLAB_API - string, optional
- APICORE_AUTH_GITLAB_GROUPS - array, optional
Name of the server; used mainly to identify server as a whole in frontend applications
Available in
/info
Full url of the API sever (ex. https://api.string.cz/
); Used to generate links in API endpoints
Available in
/info
Full url of a frontend interface (ex. https://appstore.string.cz/
); Used to generate links in API endpoints
Available in
/info
(Optional) In some cases API and a web app can be configured to work on the same endpoint, just separate virtual path (ex. with NGINX). This will allow you to specify that the root of your API is in a subfolder.
For example:
Web: https://appstore.example.com
API: https://appstore.example.com/api
The value of the variable would be api
in the above case
Maximum file upload file size in Mb, default is 50, recommended 800
Default value is secret
which will cause application to crash in production mode. Please set a secure random string to this variable to ensure your signing JWT tokens won't be open to exploitation
PostgreSQL database host url
Default 5432
. PostgreSQL database port
PostgreSQL database name
PostgreSQL database user
PostgreSQL database password
Default false
. Enable logging of all SQL queries into the command line
Sender email for all email communication originating from the server (forgotten password, registrations, etc). (ex. no-reply@example.com
)
Domain name from your Mailgun account (SMTP will be supported later)
API key from your Mailgun account
Enable S3 storage for your files; if disabled (default setting), local storage will be used instead
S3 bucket name
S3 region (ex. eu-central-1
)
S3 access key
S3 secret key
Default false
. Enable Github authentication
Available in
/info
Github oAuth app client ID
Github oAuth app secret
Default https://github.com
. Used to initiate the login process
Default https://api.github.com
. Used to retrieve user info after successful authentication
Optional. Coma separated list, of server-wide Github organisations, allowed to login using Github.
Default false
. Enable Gitlab authentication
Available in
/info
Application identifier
Application secret
URL of the authentication server; Default if https://gitlab.com
URL of the API server; Default if https://gitlab.com/api/v4
Reserved, currently not in use
Example: Apple,Einstore,manGoweb,LiveUI
Further settings will be available at the Team level in the Einstore admin panel