SCM-Manager v3 can be configured in several ways. We recommend using config.yml to have most of the settings in\none place. However, if required, each option in this configuration can also be set via environment variables.\nSee the relevant topics below for more information.
The listener host and port of your SCM-Server can directly be edited in the top level of your config.yml.\nIf you want your server without a context path (use root path), you can change this option to be /.
config.yml
\n# This is the host adresse, `0.0.0.0` means it listens on every interface\naddressBinding: 0.0.0.0\n# This is the exposed port for your application\nport: 8080\ncontextPath: /\nhttpHeaderSize: 16384Environment variables
\n| Environment Variable | \nCorresponding config.yml property | \nExample | \n
|---|---|---|
| SCM_ADDRESS_BINDING | \naddressBinding | \nexport SCM_ADDRESS_BINDING=0.0.0.0 | \n
| SCM_PORT | \nport | \nexport SCM_PORT=8080 | \n
| SCM_CONTEXT_PATH | \ncontextPath | \nexport SCM_CONTEXT_PATH=/ | \n
| SCM_HTTP_HEADER_SIZE | \nhttpHeaderSize | \nexport SCM_HTTP_HEADER_SIZE=16384 | \n
In order to use https with SCM-Server, you need a keystore with a certificate and the corresponding secret key.\nIn the following we will use openssl to create a self-signed certificate for demonstration purposes.
\nWarning: Do not use self-signed certificates in production, this is only for demonstration purposes.
\nopenssl req -new -x509 -newkey rsa:2048 -sha256 -keyout tls.key -out tls.crtThis command will ask a few questions about metadata for generated certificate:
\nMake sure that the common name matches the fqdn, which you are using to access SCM-Manager.
\nIn order to use a self-signed certificate the certificate must be imported into you browser.
\nTo use git with a self-signed certificate, we have to add the certificate path to the configuration.
\ngit config http.sslCAInfo /complete/path/to/tls.crtTo use mercurial with a self-signed certificate, we have to add the certificate path to the configuration.
\n[web]\ncacerts = /complete/path/to/cert.pemCreate a keystore in pkcs12 format. This command can be used with the self-signed certificate from above or with a valid\ncertificate from an authority.
\nopenssl pkcs12 -inkey tls.key -in tls.crt -export -out keystore.pkcs12If your secret key is protected with a passphrase, you must enter this first. You must then enter an export password to\nprotect your keystore.
\nAdjust your config.yml to apply your prepared keystore with configured certificate or set them via environment variables.
config.yml
\nhttps:\n # If the key store path is not set, the https config will be ignored entirely.\n # This must be set to your created keystore from above.\n keyStorePath: /conf/keystore.pkcs12\n # The password of your keystore.\n keyStorePassword: secret\n # The type of your keystore. Use pkcs12 or jks for java keystore.\n keyStoreType: PKCS12\n # The port of your https connector\n sslPort: 443\n # Automatically redirects incoming http requests to this https connector\n redirectHttpToHttps: trueEnvironment variables
\n| Environment Variable | \nCorresponding config.yml property | \nExample | \n
|---|---|---|
| SCM_HTTPS_KEY_STORE_PATH | \nhttps.keyStorePath | \nexport SCM_HTTPS_KEY_STORE_PATH=/conf/keystore.pkcs12 | \n
| SCM_HTTPS_KEY_STORE_PASSWORD | \nhttps.keyStorePassword | \nexport SCM_HTTPS_KEY_STORE_PASSWORD=secret | \n
| SCM_HTTPS_KEY_STORE_TYPE | \nhttps.keyStoreType | \nexport SCM_HTTPS_KEY_STORE_TYPE=PKCS12 | \n
| SCM_HTTPS_SSL_PORT | \nhttps.sslPort | \nexport SCM_HTTPS_PORT=443 | \n
| SCM_HTTPS_REDIRECT_HTTP_TO_HTTPS | \nhttps.redirectHttpToHttps | \nexport SCM_HTTPS_REDIRECT_HTTP_TO_HTTPS=true | \n
The default directories are platform-specific and therefore could be different if you try scm-server on different\noperational systems. Paths starting with / are absolute to your file system. If you use relative paths without a\nstarting /, your configured path will be located relative to your base directory of your scm-server (\nlike /opt/scm-server\non unix-based packages).
For technical reasons the tempDir is located at the top level of your config.yml. All other path-based config options\nare located under webapp.
config.yml
\ntempDir: /tmp\n\nwebapp:\n homeDir: ./scm-home\n workDir: /etc/scm/workEnvironment variables
\n| Environment Variable | \nCorresponding config.yml property | \nExample | \n
|---|---|---|
| SCM_TEMP_DIR | \ntempDir | \nexport SCM_TEMP_DIR=/tmp | \n
| SCM_WEBAPP_HOMEDIR | \nwebapp.homeDir | \nexport SCM_WEBAPP_HOMEDIR=./scm-home | \n
| SCM_WEBAPP_WORKDIR | \nwebapp.workDir | \nexport SCM_WEBAPP_WORKDIR=/etc/scm/work | \n
If your SCM-Manager instance is behind a reverse proxy like NGINX, you most likely will have to enable\nX-Forward-Headers.\nThese HTTP headers are being appended to the requests which are redirected by your reverse proxy server. Without\nthis option set, your SCM-Server may run into connection issues. This option is disabled by default, because without a\nreverse proxy it could cause security issues.
\nMany reverse proxies will also cache response streams. This can lead to timeouts, especially when working with large\nrepositories. To avoid this, you might want to increase the idleTimeout to a higher value, depending on the size of\nyour repositories (you might want to start with 300000, that would be five minutes).
config.yml
\nforwardHeadersEnabled: true\nidleTimeout: 300000Environment variables
\n| Environment Variable | \nCorresponding config.yml property | \nExample | \n
|---|---|---|
| SCM_FORWARD_HEADERS_ENABLED | \nforwardHeadersEnabled | \nexport SCM_FORWARD_HEADERS_ENABLED=true | \n
| SCM_IDLE_TIMEOUT | \nidleTimeout | \nexport SCM_IDLE_TIMEOUT=300000 | \n
The webapp configuration consists of anything that is not webserver or logging related.\nMost of the available options should be set to the recommended values of your default config.yml file.\nYou can also override these options with environment variables.
config.yml
\nwebapp:\n ## Sets explicit working directory for internal processes, empty means default java temp dir\n workDir:\n ## Home directory \"scm-home\" which is also set for classpath\n homeDir: /var/lib/scm\n cache:\n dataFile:\n enabled: true\n store:\n enabled: true\n # name of initial admin user (this is normally set over the ui on the first start)\n initialUser: scmadmin\n # password of initial admin user (this is normally set over the ui on the first start)\n initialPassword: scmadmin\n # if true skip the creation of initial admin user completely\n skipAdminCreation: false\n ## Warning: Enabling this option can lead to security issue.\n endlessJwt: false\n ## Number of async threads\n asyncThreads: 4\n ## Max seconds to abort async execution\n maxAsyncAbortSeconds: 60\n ## Amount of central work queue workers\n centralWorkQueue:\n workers: 4\n ## Strategy for the working copy pool implementation [sonia.scm.repository.work.NoneCachingWorkingCopyPool, sonia.scm.repository.work.SimpleCachingWorkingCopyPool]\n workingCopyPoolStrategy: sonia.scm.repository.work.SimpleCachingWorkingCopyPool\n ## Amount of \"cached\" working copies\n workingCopyPoolSize: 5\n ## Settings for queryable stores, which are backed by an SQLite database.\n ## Timeouts and lifetimes are in seconds\n queryableStores:\n maxPoolSize: 10\n connectionTimeout: 30\n idleTimeout: 600\n maxLifetime: 1800\n leakDetectionThreshold: 30\n\nEnvironment variables
\n| Environment Variable | \nCorresponding config.yml property | \nExample | \n
|---|---|---|
| SCM_WEBAPP_WORKDIR | \nwebapp.workDir | \nexport SCM_WEBAPP_WORKDIR=/tmp/scm-work | \n
| SCM_WEBAPP_HOMEDIR | \nwebapp.homeDir | \nexport SCM_WEBAPP_HOMEDIR=/var/lib/scm | \n
| SCM_WEBAPP_CACHE_DATAFILE_ENABLED | \nwebapp.cache.datafile.enabled | \nexport SCM_WEBAPP_CACHE_DATAFILE_ENABLED=true | \n
| SCM_WEBAPP_CACHE_STORE_ENABLED | \nwebapp.cache.store.enabled | \nexport SCM_WEBAPP_CACHE_STORE_ENABLED=true | \n
| SCM_WEBAPP_ENDLESSJWT | \nwebapp.endlessJwt | \nexport SCM_WEBAPP_ENDLESSJWT=false | \n
| SCM_WEBAPP_ASYNCTHREADS | \nwebapp.asyncThreads | \nexport SCM_WEBAPP_ASYNCTHREADS=4 | \n
| SCM_WEBAPP_MAXASYNCABORTSECONDS | \nwebapp.maxAsyncAbortSeconds | \nexport SCM_WEBAPP_MAXASYNCABORTSECONDS=60 | \n
| SCM_WEBAPP_CENTRALWORKQUEUE_WORKERS | \nwebapp.centralWorkQueue.workers | \nexport SCM_WEBAPP_CENTRALWORKQUEUE_WORKERS=4 | \n
| SCM_WEBAPP_WORKINGCOPYPOOLSTRATEGY | \nwebapp.workingCopyPoolStrategy | \nexport SCM_WEBAPP_WORKINGCOPYPOOLSTRATEGY=sonia.scm.repository.work.SimpleCachingWorkingCopyPool | \n
| SCM_WEBAPP_WORKINGCOPYPOOLSIZE | \nwebapp.workingCopyPoolSize | \nexport SCM_WEBAPP_WORKINGCOPYPOOLSIZE=5 | \n
| SCM_WEBAPP_INITIALUSER | \nwebapp.initialUser | \nexport SCM_WEBAPP_INITIALUSER=scmadmin | \n
| SCM_WEBAPP_INITIALPASSWORD | \nwebapp.initialPassword | \nexport SCM_WEBAPP_INITIALPASSWORD=scmadmin | \n
| SCM_WEBAPP_SKIPADMINCREATION | \nwebapp.skipAdminCreation | \nexport SCM_WEBAPP_SKIPADMINCREATION=true | \n
| SCM_WEBAPP_QUERYABLESTORES_MAXPOOLSIZE | \nwebapp.queryableStores.maxPoolSize | \nexport SCM_WEBAPP_QUERYABLESTORES_MAXPOOLSIZE=20 | \n
| SCM_WEBAPP_QUERYABLESTORES_CONNECTIONTIMEOUT | \nwebapp.queryableStores.connectionTimeout | \nexport SCM_WEBAPP_QUERYABLESTORES_CONNECTIONTIMEOUT=30 | \n
| SCM_WEBAPP_QUERYABLESTORES_IDLETIMEOUT | \nwebapp.queryableStores.idleTimeout | \nexport SCM_WEBAPP_QUERYABLESTORES_IDLETIMEOUT=600 | \n
| SCM_WEBAPP_QUERYABLESTORES_MAXLIFETIME | \nwebapp.queryableStores.maxLifetime | \nexport SCM_WEBAPP_QUERYABLESTORES_MAXLIFETIME=1800 | \n
| SCM_WEBAPP_QUERYABLESTORES_LEAKDETECTIONTHRESHOLD | \nwebapp.queryableStores.leakDetectionThreshold | \nexport SCM_WEBAPP_QUERYABLESTORES_LEAKDETECTIONTHRESHOLD=1800 | \n