Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eisengrind/docker-altv-server

The unofficial alt:V server Docker image.
https://github.com/eisengrind/docker-altv-server

altv altv-server docker docker-altv-server docker-image dockerfile dotnet dotnetcore dotnetcore3 eisengrind nodejs

Last synced: 2 months ago
JSON representation

The unofficial alt:V server Docker image.

Awesome Lists containing this project

README 

        





  




Unofficial alt:V server Docker image


Searching for the alt:V voice server image? Click here



The unofficial alt:V server Docker image.





  
Breaking Change with alt:V 9.x


  
Removed support for .NET versions older than .NET 6





## Usage



To get started just run the Docker image as follows:



```sh

docker run -it --rm eisengrind/altv-server:release

```



### Configuring the alt:V server



Since we can not provide a file to the alt:V without adding a volume, you can configure the alt:V server using container environment variables.



See `.docker/scripts/entrypoint.sh` for all available environment variables.



Before the server starts, the entrypoint script writes the alt:V server configuration using the input environment variables, so you don't have to provide a configuration file.



## Build



For the `$build` and `$branch` variables you have to enter the regarding alt:V versioning values.



**`$build`** represents the build number of the server source files. E.g. **`$build=1098`**



**`$branch`** represents the branch where the server build was released. E.g. **`$branch=release`**



## Using custom vehicle data



To use custom vehicle data, you can mount a volume to the directory `/opt/altv/data/`. By using the volume you can then overwrite the `vehmodels.bin` and `vehmods.bin` files.



You ofc also can just copy the vehicle data to a new `Dockerfile` that inherits from the base `eisengrind/altv-server` image.



## Usage with a custom Dockerfile



Most of the time if you are using containers, especially images, correctly, you will create a customized Docker image. For example by adding resources to a container which will represent a current version of your files.



You can use this images as a base for your future customizations:



```Dockerfile

FROM eisengrind/altv-server:release



RUN mkdir -p /opt/altv/resources/test-resource

```



This example, however, just creates an empty folder within the alt:V resources folder.



### Note on Docker caching



We provide two different kinds of tags for the alt:V Docker images: specific and non-specific image tags.



In general, this means that specific tags represent a unique alt:V build version whereas a non-specific tag such as `release...` or `dev...` represents the latest build number of the regarding branch.



Thus, once an image with a non-specific tag is pulled, this image will not automatically get updated by Docker unless you remove and pull the image again from Docker Hub.



This is why we provide specific tags. Those kind of tags do explicitly not lead to a caching problem, because specific tags are not meant to be, once they are published, changed.



**tl;dr Keep in mind that you should always specify a specific tag in a Dockerfile.**



### Note on Docker image security



Since this images inherits from the `debian:buster-slim` image, we schedule nightly builds every 24 hours to reduce security invulnerabilities.



We highly recommend to update the altv-server image as frequent as possible.



Keep in mind that, because of the frequent updates, we overwrite the image tags `release`, `dev`, `rc` aswell as their build versions.



To use a specific image, we recommend using their Sha-256 digest hash as an image selector.



## License



See the [LICENSE](https://github.com/eisengrind/docker-altv-server/blob/master/LICENSE)-file for further information.