-
Notifications
You must be signed in to change notification settings - Fork 0
About Glim. Environment variables
Miguel Cabrerizo edited this page Nov 13, 2022
·
7 revisions
Glim can use the following environment variables. The same variables can be set using command flags or using a configuration file.
| Variable | Required | Description | Default value if not set |
|---|---|---|---|
| GLIM_API_ADDR | No | Listen address for our REST API server | - |
| GLIM_API_PORT | No | Port for our REST API server | 1323 |
| GLIM_API_SECRET | Yes | A secret string to be used with JWT tokens | - |
| GLIM_API_ACCESS_TOKEN_EXPIRY_TIME | No | Number of seconds for access token expiration | 3600 seconds |
| GLIM_API_REFRESH_TOKEN_EXPIRY_TIME | No | Number of seconds for refresh token expiration | 3 days |
| GLIM_API_MAX_DAYS_RELOGIN | No | Number of days that we can use refresh tokens without log in again | 7 days |
| GLIM_SQLITE_DB | No | SQLite database file name that stores our users and groups | $HOME/.glim/glim.db |
| GLIM_LDAP_DOMAIN | No | Our ldap domain | example.org |
| GLIM_LDAP_ADDR | No | Listen address for our LDAP server | - |
| GLIM_LDAP_PORT | No | Port for our LDAP server | 1636 |
| GLIM_LDAP_SIZE_LIMIT | No | Max number of entries that should be returned from a search | 500 |
| GLIM_LDAP_NO_TLS | No | Don't use TLS with LDAP server | false |
| GLIM_SERVER | No | Glim Rest API address for Glim commands | https://127.0.0.1:1323 |
| GLIM_POSTGRES_HOST | No | PostgreSQL server address | - |
| GLIM_POSTGRES_PORT | No | PostgreSQL server listening port | 5432 |
| GLIM_POSTGRES_USER | No | PostgreSQL user for database connection | postgres |
| GLIM_POSTGRES_PASSWORD | No | PostgreSQL password for database connection | - |
| GLIM_POSTGRES_DB | No | PostgreSQL database name for database connection | glim |
| GLIM_POSTGRES_ROOT_CA | No | Path of the file containing PostgreSQL CA pem file | - |
| GLIM_POSTGRES_CLIENT_CERT | No | Path of the file containing PostgreSQL client certificate pem file | - |
| GLIM_POSTGRES_CLIENT_KEY | No | Path of the file containing PostgreSQL client key file | - |
| GLIM_REDIS_HOST | No | Redis server address | - |
| GLIM_REDIS_PORT | No | Redis server listening port | 6379 |
| GLIM_REDIS_PASSWORD | No | Redis password if set | - |
| GLIM_REDIS_DB_INDEX | No | Redis DB Index if set | 0 |
| GLIM_BADGERDB_STORE | No | Directory path for BadgerDB Key Value store | $HOME/.glim/kv |
| GLIM_INITIAL_ADMIN_PASSWD | No | Initial password for the admin account | - |
| GLIM_INITIAL_SEARCH_PASSWD | No | Initial password for the search account | - |
| GLIM_INITIAL_USERS | No | Users that will be added to Glim when server starts | - |
| GLIM_INITIAL_USERS_PASSWORD | No | Password for initial users | glim |
| GLIM_LOG_SQL | No | Enable SQL queries logging | false |
| GLIM_GUACAMOLE | No | Enable Apache Guacamole support | false |
| GLIM_TLSCACERT | No | TLS CA certificate path | $HOME/.glim/ca.pem |
| GLIM_TLSCERT | No | TLS server certificate path | $HOME/.glim/server.pem |
| GLIM_TLSKEY | No | TLS server private key path | $HOME/.glim/server.key |
| GLIM_AUTOCERT_CA | No | Name for our fake CA for auto-generated certificates | Acme Co Fake CA |
| GLIM_AUTOCERT_ORG | No | Organization name for Glim's auto-generated certificates | Glim Fake Organization, Inc |
| GLIM_AUTOCERT_HOSTS | No | Comma-separated list of hosts and IP addresses for auto-generated certs | 127.0.0.1, localhost |
| GLIM_AUTOCERT_PATH | No | Path where auto-generated certs and keys files will be created | $HOME/.glim |
| GLIM_AUTOCERT_YEARS | No | Number of years that we want Glim's auto-generated to be valid | 1 |
The Glim Project - 2022