environment-variables.md

💿 Configuring the server

Environment variables

You may declare soketi server configuration options using environment variables directly on the CLI when invoking the soketi server:

DEBUG=1 soketi start

Alternatively, you can use key-value attributes from your server environment, or an .env file placed at the location from where the soketi server command is being run. When using environment variables outside the CLI, prepend SOKETI_ to their key name to avoid collisions with other variable names:

# Within your .env file
SOKETI_DEBUG=1

soketi start

Many soketi features can be controlled using environment variables, and each of these variables are discussed in the relevant sections of this documentation.

{% hint style="success" %} To get started creating your own app credentials, visit the Array Driver app manager. {% endhint %}

File configuration

Starting with soketi 0.24, you can define a JSON-formatted file which can contain dot-formatted values for your configuration:

{
    "debug": true,
    "port": 6002,
    "appManager.array.apps": [
        {
            "id": "some-id",
            "key": "some-key",
            "secret": "some-secret",
            "webhooks": [
                {
                    "url": "https://...",
                    "event_types": ["channel_occupied"]
                }
            ]
        }
    ]
}

soketi start --config=/path/to/config.json

The full list of available options can be found in the Options interface.