https://github.com/silentmecha/valheim
Valheim server on linux inside of Docker
https://github.com/silentmecha/valheim
docker docker-compose linux steam valheim-server
Last synced: 3 months ago
JSON representation
Valheim server on linux inside of Docker
- Host: GitHub
- URL: https://github.com/silentmecha/valheim
- Owner: silentmecha
- License: mit
- Created: 2021-02-20T12:47:38.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-09-17T17:41:44.000Z (almost 4 years ago)
- Last Synced: 2025-01-20T19:27:17.424Z (5 months ago)
- Topics: docker, docker-compose, linux, steam, valheim-server
- Language: Dockerfile
- Homepage: https://hub.docker.com/r/silentmecha/valheim
- Size: 9.77 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# silentmecha/valheim
This repository contains the files needed for the image silentmecha/valheim:latest
**NB This README still needs to be updated and corrected. This image is not yet complete as the game is still very early access**
## Usage
This stack uses an image from [atmoz](https://github.com/atmoz). To see more on the image used visit thier github [https://github.com/atmoz/sftp](https://github.com/atmoz/sftp).
For more info on environment variabes and what they do see [Environment Variables](#environment-variables)
### Simplest Method
The simplest usage for this is using the `docker-compose` method.
```console
git clone https://github.com/silentmecha/valheim.git valheim-server
cd valheim-server
cp .env.example .env
nano .env
docker-compose up -d
```
### Without building the image locally
```console
git clone https://github.com/silentmecha/valheim.git valheim-server
cd valheim-server
cp .env.example .env
nano .env
docker-compose pull
docker-compose up -d
```
### Updating
Updating is still currently in devolpment so once that is sorted this README will be updated. The idea is to allow an image to be updated without needing to either download the full image or rebuilding the image
### Environment Variables
| Variable Name | Default Value | Description |
|-----------------|----------------|---------------------------------------------------------------------------------------------------------------------|
| SERVER_NAME | Valheim Docker | Name of your server as seen in server browser (accepts spaces) |
| PORT | 2456 | Port used to connect to the server |
| QUERYPORT | 2457 | Port used to query the server **This needs to be $PORT plus 1 as this currently is not setable by the game server** |
| WORLDPORT | 2458 | Port used to send world data **This needs to be $PORT plus 2 as this currently is not setable by the game server** |
| WORLD | Dedicated | Name of the save file |
| SERVER_PASSWORD | secret | Password to enter your server |
| ADDITIONAL_ARGS | | Currently not used |
| SFT_USER | foo | Username for SFTP access to edit save data |
| SFT_PASS | pass | Password for SFTP access to edit save data |
| SFT_PORT | 2222 | Port for SFTP access (should not be 22 ) |
For more info on the usage of SFTP see [here](https://github.com/atmoz/sftp). If you do not want to use a plane text password see [encrypted-password](https://github.com/atmoz/sftp#encrypted-password)
### Ports
Currently the following ports are used.
| Port | Type | Default |
|-----------|------|---------|
| PORT | TCP | 2456 |
| PORT | UDP | 2456 |
| QUERYPORT | TDP | 2457 |
| QUERYPORT | UDP | 2457 |
| WORLDPORT | TDP | 2458 |
| WORLDPORT | UDP | 2458 |
| SFT_PORT | TCP | 2222 |
All these ports need to be forwarded through your router except for `SFT_PORT` unless you wish to remotely edit the save data.
## Notes
Currently this is based off of Ubuntu 18.04 as there are known issues with steamcmd and Ubuntu 20.04. Once Ubuntu 20.04 is stable I will update the images
## License
[MIT license](LICENSE)