altmp/altv-voice-server repository overview

⁠Quick Reference

• Maintained by:
  altMP team⁠
• Where to get help:
  GitHub repository⁠, alt:V Discord server⁠

⁠What is alt:V?

alt:V is a free alternative multiplayer client for GTA:V.

⁠How to use this image

⁠See GitHub readme⁠ for up-to-date information.

⁠See altmp/altv-server⁠ for game server Docker image.

⁠See example docker-compose.json⁠ for reference on how to deploy game server with voice.

⁠Usage

To start a minimal voice server run:

docker run --rm -it -p 7799:7799/udp altmp/altv-voice-server:release

⁠Configuration

The alt:V voice server is located at the path /altv inside the Docker container.

⁠Server settings

There are two ways to specify server configurations:

⁠Configuration via environment variables

This image allows you to set all existing server settings by specifying environment variables. All variables follow the syntax ALTV_SETTING_NAME, for a complete list of options look at the voice server setup script⁠.

In case of array values (arr('...')) specify a comma separated string.
In case of boolean values (bool('...')) specify true, yes, y or 1 for true, or false, no, n, or 0 for false.
In case of JSON values (jsonObj('...')) specify a valid JSON object

Example:

docker run --rm -it \
    -p 7799:7799/udp \
    -e ALTV_LOOPBACK=true \
    altmp/altv-voice-server:release

⁠Configuration via volumes

You can provide your own config file to configure your server. To do this, mount the file to /altv/voice.toml and specify the environment variable ALTV_USE_ENV_CONFIG=false.

Example:

docker run --rm -it \
    -p 7799:7799/udp \
    -v ./voice.toml:/altv/voice.toml \
    -e ALTV_USE_ENV_CONFIG=false \
    altmp/altv-voice-server:release