-
Notifications
You must be signed in to change notification settings - Fork 65
Configuration
Rekono backend can be configured in different ways with that priority order:
- From environment variables
- From config.yaml file
- Default values
The supported proporties are:
| Environment Variable | Configuration Property | Default Value | Description |
|---|---|---|---|
REKONO_HOME |
N/A |
/opt/rekono or where the source code lives |
Path to the Rekono home directory |
RKN_FRONTEND_URL |
frontend.url |
https://127.0.0.1 |
URL used to include links to the Rekono frontend in notifications |
RKN_ROOT_PATH |
rootpath |
N/A | Subpath where Rekono is deployed. This value is only used to set in on API documentation |
RKN_TRUSTED_PROXY |
N/A | False |
Indicate if Rekono is running with a trusted reverse proxy |
RKN_ALLOWED_HOSTS |
security.allowed-hosts |
[localhost, 127.0.0.1, ::1] |
Hosts allowed to access Rekono |
RKN_SECRET_KEY |
security.secret-key |
Generated randomly | Security key used to sign JWT tokens |
RKN_DB_NAME |
database.name |
rekono |
Database name |
RKN_DB_USER |
database.user |
N/A | Database user |
RKN_DB_PASSWORD |
database.password |
N/A | Database password |
RKN_DB_HOST |
database.host |
127.0.0.1 |
Database host |
RKN_DB_PORT |
database.port |
5432 |
Database port |
RKN_RQ_HOST |
rq.host |
127.0.0.1 |
Redis Queue host |
RKN_RQ_PORT |
rq.port |
6379 |
Redis Queue port |
RKN_EMAIL_HOST |
email.host |
127.0.0.1 |
SMTP host |
RKN_EMAIL_PORT |
email.port |
587 |
SMTP port |
RKN_EMAIL_USER |
email.user |
N/A | SMTP user |
RKN_EMAIL_PASSWORD |
email.password |
N/A | SMTP password |
| N/A | email.tls |
True |
Enable or disable TLS in SMTP |
RKN_CMSEEK_RESULTS |
tools.cmseek.directory |
/usr/share/cmseek |
Directory where CMSeeK results are found |
RKN_LOG4J_SCAN_DIR |
tools.log4j-scan.directory |
/opt/log4j-scan |
Directory where Log4j Scan code is stored |
RKN_SPRING4SHELL_SCAN_DIR |
tools.spring4shell-scan.directory |
/opt/spring4shell-scan |
Directory where Spring4Shell Scan code is stored |
RKN_GITTOOLS_DIR |
tools.gittools.directory |
/opt/GitTools |
Directory where GitTools code is stored |
Rekono frontend can be configured in .env files located in frontend root directory, for example, .env.production. The supported environment variables are:
-
VUE_APP_DESKTOP_BACKEND_URL: backend URL to make API requests. It is only used by Deskop applications in production environments. -
VUE_APP_ROOT_BACKEND_PATH: root path where backend is deployed. It isn't established by default.
Default credentials in Docker environment can be configured using environment variables:
-
RKN_EMAIL: User email address. If not set,rekono@rekono.comwill be used. -
RKN_USERNAME: Username. If not set,rekonowill be used. -
RKN_PASSWORD: User password. If not set,rekonowill be used.
Docker environment doesn't include an internal SMTP server, so it's needed to configure it manually to be able to receive email notifications or send user invitations. This configuration can be made using the backend email properties.
Self-signed certificate will be generated automatically to configure TLS communication with Rekono. However, it's possible to customize the certificate used for that purpose putting custom certificate.crt and privatekey.key files in nginx/tls directory.