Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • PostgreSQL: Check the official documentation at https://github.com/docker-library/docs/blob/master/postgres/README.md#environment-variables .

  • SSH Server: Check the official documentation at https://github.com/linuxserver/docker-openssh-server?tab=readme-ov-file#parameters .

  • Web services:

    • DB_HOST=localhost Used to set the IP or hostname of the database.

    • DB_NAME=opengate Used to set the database name.

    • DB_USER=opengate Used to set the database user.

    • DB_PASSWORD_FILE=/run/secrets/db_password Used to set the “secret” path, which contains the database connection password.

    • SIP_REGISTRAR_IP=127.0.0.1 Used to set the IP address used to configure the SIP Registrar.

    • MASTER_ASTERISK_IP=127.0.0.1 Used to set the IP address of the interface connected to the data network of the Master node. This must match the DATA_BINDADDR value of the master Asterisk.

    • RECORDING_MOUNT_POINT Used to set the mount point of Presence Recording . This information is required to generate the configuration that Asterisk uses to record to store both the recordings path of this module and the recordings path of user extensions.

    • LOG_TO_DEFAULT=True Used to set the traces to be logged in the standard location. If set to “False”, traces will be logged in a file.

    • SSH_USERNAME=opengate Used to set the username of the SSH connections.

    • SSH_PORT=2222 Used to set the port for SSH connections.

    • SSH_KEY_FILE=/run/secrets/ssh_key Used to set the “secret” path, which contains the SSH private key.

    • SSH_KEY_PUB_FILE=/run/secrets/ssh_key.pub Used to set the “secret” path, which contains the SSH public key.

    • RESTORE_MODE=False Allows you to enable the restore mode to load a previous backup copy when the value is set to “True”.

    • UNIMRCP_SERVER_IP=127.0.0.1 Used to set the IP address of the UniMRCP server.

    • SIP_ALIASES=sample1.domain.com,sample2.doman.com Used to set the list of domains (comma separated) if extensions use a domain to connect to the SIP Registrar.

  • Asterisk:

    • DATA_BINDADDR="0.0.0.0" Used to set the IP address of the data network.

    • SIP_BINDADDR="0.0.0.0" Used to set the IP address of the SIP server.

    • LOG_TO_DEFAULT=True Used to set that traces to be logged in the standard location. If set to “False”, traces will be logged in a file.

    • RUN_CONVERTER=False Used to set whether or not the audio format converter is to run. This is only set to “True” in the Master node.

    • SIP_TLS_PEM_FILE=/run/secrets/tls_pem Used to set the “secret” path, which contains the TLS certificate for SIP.

    • ASTERISK_ARGS="-fpvvvg" Used to set the parameters that are used to launch the Asterisk exec file.

    • CHECK_FILE="/etc/asterisk/presence-scripts/create_conf_files.sh" Used to set the file that is to be checked before you start Asterisk. This check is to make sure that the Unified Administration has successfully loaded the configuration prior to the Asterisk startup.

  • FreeSWITCH:

    • FS_EXTIP=127.0.0.1 Used to set the external IP address of FreeSWITCH (public IP).

    • FS_PRIVIP=127.0.0.1 Used to set the IP address of the network interface connected to the private network. This network is used to connect to the nodes and to the rest of the OpenGate system.

    • FS_DMZIP=$FS_PRIVIP Used to set the IP address of the network interface connected to the DMZ network. If there is no separation between the private / DMZ networks, then the network is the same and there is no need to be specified.

    • FS_UA_ACL=$FS_PRIVIP/24 Used to set an ACL (Access Control List) of IPs from which Presence OpenGate web services can connect to FreeSWITCH (to make change in the configuration). By default, let’s assume this is the private network in a subnetwork /24. If the Master node falls outside this range, you have to update this variable to match the network address of OpenGate web services.

    • FS_WSSPORT=7443 Used to set the WSS Port (WebSocket Secure) used to establish the WebRTC connections.

    • FS_RTPSTARTPORT=22000 and FS_RTPENDPORT=24600 Used to set the range of ports used for RTP.

    • FS_CODEC=PCMA Used to set the codecto establish the WebRTC connection. The values are the following: PCMA, PCMU, OPUS.

    • FS_TLS_PEM_FILE=/run/secrets/tls_pem Used to set the “secret” path, which contains the TLS certificate for WSS and SRTP.

    • FS_REVERSEPROXY_ACL=255.255.255.255/32 Used to specify an ACL where a reverse proxy is running (example: 10.100.1.99/32 to match a reverse proxy with IP 10.100.1.99).

...