Server Environment Reference
DEBUG
Default: none
Type: string
Description:
Enable debug using the popular debug Npm package. To limit logs to Metroline, use DEBUG=metroline.server*.
METROLINE_JWT_SECRET
Default: none
Type: string
Description:
Secret used to sign and verify JWT tokens. Can be generated with openssl rand 32 -hex.
METROLINE_JWT_TOKEN_EXPIRATION
Default: 259200 (30 days)
Type: number
Description:
Expiration time (in seconds) of JWT tokens.
METROLINE_UI_URL
Default: none
Type: string
Description:
URL of the Metroline UI.
METROLINE_MONGO_URI
Default: none
Type: string
Description:
URI of a MongoDB instance.
METROLINE_GITLAB_URL
Default: https://gitlab.com
Type: string
Description:
URL of your Gitlab instance
METROLINE_GITLAB_CLIENT_ID
Default: none
Type: string
Description:
Gitlab application ID (see here).
METROLINE_GITLAB_CLIENT_SECRET
Default: none
Type: string
Description:
Gitlab application secret (see here).
METROLINE_GITLAB_WEBHOOK_SSL_VERIFY
Default: true
Type: boolean
Description:
Whether to enable Gitlab webhook SSL verification for hooks created by Metroline.
METROLINE_GITEA_URL
Default: none
Type: string
Description:
URL of your Gitea instance
METROLINE_GITEA_CLIENT_ID
Default: none
Type: string
Description:
Client ID of an OAuth app registered in your Gitea instance.
METROLINE_GITEA_CLIENT_SECRET
Default: none
Type: string
Description:
Client secret of an OAuth app registered in your Gitea instance.
METROLINE_GITHUB_URL
Default: https://github.com
Type: string
Description:
URL of your Github instance.
METROLINE_GITHUB_CLIENT_ID
Default: none
Type: string
Description:
Client ID of a Github OAuth app.
METROLINE_GITHUB_CLIENT_SECRET
Default: none
Type: string
Description:
Client secret of a Github OAuth app.
METROLINE_GITHUB_WEBHOOK_SSL_VERIFY
Default: true
Type: boolean
Description:
Whether your Github instance should verify the SSL certificate of Metroline when calling webhooks.
METROLINE_PORT
Default: 3000 (local development) / 80 (Dockerfile)
Type: number
Description:
Port on which metroline is listening.
METROLINE_HOST
Default: none
Type: string
Description:
Host of your metroline server. For example metroline.company.com:3000. You can include host and port, but it should not contain protocol as this is handled internally. This value is used for providing correct redirect URL when doing OAuth flows and should
METROLINE_WEBHOOK_HOST
Default: METROLINE_HOST
Type: string
Description:
Host used for building the webhook URL when setting up a repository. This is useful when you are working locally as you've probably set METROLINE_HOST to localhost. When your Git server calls webhooks, localhost will point to itself. The solution is to set METROLINE_WEBHOOK_HOST to host.docker.internal (OS X) or to your IP.
METROLINE_MIGRATE_ROLLBACK
Default: false
Type: boolean
Description:
Forces the server to rollback the last migration, then exit. Use this when you're trying to downgrade.
METROLINE_JOB_TIMEOUT
Default: 86400
Type: number
Description:
How much time (in seconds) a job has to complete. The server automatically cancels jobs that haven't completed within this amount of time.
METROLINE_RUNNER_SECRET
Default: none
Type: string
Description:
Secret that should be sent by runners to authenticate.
METROLINE_GLOBAL_SECRETS
Default: none
Type: string
Description:
An array of global secrets, formatted as a one line JSON string. See global secrets.
For example:
METROLINE_GLOBAL_SECRETS=[{"name":"test","value":"val"},{"name":"test2","value":"val","protectedBranchesOnly":true,"branches":["master"]}]
Each object of the array should have the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
| name | string | true | Global secret name. Should match /^[a-zA-Z_][a-zA-Z0-9_]*$/. |
| value | string | true | Global secret value. |
| protectedBranchesOnly | boolean | false | Whether this secret should be available on protected branches. |
METROLINE_MAX_JOBS_PER_PIPELINE
Default: 100
Type: number
Description:
Maximum number of jobs per pipeline. Indirectly, this determines the maximum numbr of job entries in your .metroline.yml.
METROLINE_SYNC_INTERVAL
Default: 1800 (30 minutes)
Type: number
Description:
How often (in seconds) user repositories should be synchronized.
METROLINE_CLEAN_JOBS_INTERVAL
Default: 5
Type: number
Description:
How often (in seconds) we should check for jobs that need to be cancelled due to a timeout.
METROLINE_ORGS
Default: none
Type: string
Description:
A comma separated list of organization names (not ID !) to which login and repos should be limited. For example:
METROLINE_ORGS=octocat
METROLINE_SSL_KEY
Default: none
Type: string
Description:
An SSL private key in PEM format. See SSL.
METROLINE_SSL_CERT
Default: none
Type: string
Description:
An SSL certificate in PEM format. See SSL.
METROLINE_REQUIRE_LOGIN_FOR_PUBLIC_REPOS
Default: true
Type: boolean
Description:
When set to false, public repositories of your Git server will also be public in Metroline. This grants guests read-only access to pipelines, jobs and logs.
METROLINE_REFRESH_TOKEN_TASK_PERIOD
Default: 10
Type: number
Description:
How often (in seconds) to check for tokens that need to be refreshed.
METROLINE_COOKIE_SAMESITE
Default: null
Type: string
Description:
Allows you to set the SameSite property for cookies defined by the server. Useful when your Metroline server has a different host or URL than your UI.
METROLINE_COOKIE_SECURE
Default: false
Type: boolean
Description:
Allows you to set the Secure property for cookies defined by the server. Some browsers, like Chrome, require it to be true to use cookies for cross site requests (which implies you need a secure backend).
METROLINE_COMMIT_MESSAGE_SKIP_MARKER
Default: [skip ci],[ci skip]
Type: string
Description:
A comma-separated list of patterns Javascript regular expressions to match against commit messages. When a pattern matches, no pipeline is created.