Environment variables

Yummy has multiple configuration over environtment variable. Those configurations can be passed via environtment or via config file. The config file must be located near the executable.

Profile	File name
Production	prod.env
Development	dev.env
Test	test.env

Parameters

`SERVER_NAME`

The system generates a random name at the startup. The name will start with YUMMY and continue with 7 alphanumeric characters. This name will be used to communicate between Yummy instances and shorter names can improve performance. Example names: YUMMY-wvO8T0u, YUMMY-NTXBzdo, YUMMY-oSArCvq.
Default: Server name randomly generated.

`BIND_IP`

Instance's binding ip address.
Default: 0.0.0.0

`BIND_PORT`

Instance's binding port address.
Default: 9090

`TLS_CERT_PATH`

TLS certificates cert file path.
Default:

`TLS_KEY_PATH`

TLS certificates key file path.
Default:

`RUST_LOG`

Rust Programming Language's and Actix Framework's logging configuration.
Rust logging information
Default: debug,backend,actix_web=debug

`HEARTBEAT_INTERVAL`

Heartbeat message sent interval. This parameter is in seconds.
Default: 10

`CACHE_DURATION

Idle time of cache entry. The timer will be refreshed on every access the entry. This parameter is in seconds.
Default: 300

`HEARTBEAT_TIMEOUT`

Maximum wait time after receiving the last heartbeat message. The connection termination procedure will be started if the system cannot receive a heartbeat message in time. This parameter is in seconds.
Default: 20

`CONNECTION_RESTORE_WAIT_TIMEOUT`

If the client disconnected from the instance, the system wait some amound of time to informatim other users and update clients states. This time starts at after user disconnect from the instance or hit to HEARTBEAT_TIMEOUT. This parameter is in seconds.
Default: 10

`TOKEN_LIFETIME`

JWT lifetime. That parameter used for session and connection restoration. This parameter is in milliseconds.
Default: 86400

`API_KEY_NAME`

Websocket's HTTP GET parameter name.
Default: x-yummy-api

`INTEGRATION_KEY`

Websocket's integration key to communicate.
Default: YummyYummy

`SALT_KEY`

Secret key for JWT.
Default: YUMMY-SALT

`MAX_USER_META`

Maximum allowed meta informations per users.
Default: 10

`DEFAULT_MAX_ROOM_META`

Maximum allowed meta informations per room.
Default: 10

`ROOM_PASSWORD_CHARSET`

Automatic generated room password's charset.
Default: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789

`ROOM_PASSWORD_LENGTH`

Automatic generated room password's length.
Default: 4

`DATABASE_PATH`

Sqlite database path.
Default: yummy.db

`REDIS_URL`

Redis connection information.
Default: redis://127.0.0.1/

`REDIS_PREFIX`

Prefix for all Redis keys.
Default: