Hosting a Server
This section will describe how to setup a Veloren server.
Note: There are multiple ways to setup a Veloren server therefore this book explains the most common and easiest approaches.
Veloren is composed of the Veloren client (veloren-voxygen), the game server (veloren-server-cli), and the authentication server (auth-server).
When setup with authentication support (default), the game server is using the authentication server to log the player in.
Note: Without authentication the server will allow anyone to log in with any name including those with admin access!
Setup local game server
If you want to play with your friends and do not have a dedicated server follow these instructions.
Note: You will need access to the router and knowledge about port forwarding.
- Setup
- Port forward
14004
on your router.
- Port forward
- Launch game server
veloren-server-cli(.exe)
- check Airshipper section to find out where the files are
- or download Nightly from the website.
Note: The
assets
folder is required to be next to the game server.
- Give out your IP
- Optionally disable authentication by replacing
auth_server_address: Some(...)
withauth_server_address: None
Enjoy the game!
Setup dedicated game server
If you want to run a dedicated Veloren server 24/7 follow this.
Note: You will need access to the server, docker
, docker-compose
installed and we assume general command line and docker-compose knowledge.
- Setup
- Create folder
/opt/veloren-server
(feel free to name it differently). - Copy
docker-compose.yml
from the repository into the folder. - If needed open port
14004
(14005
for metrics) in your firewall.
- Create folder
- Start it
- Run
docker-compose up -d
as root. - View logs with
sudo docker logs veloren-game-server-master
.
- Run
You are done!
Note: This will automatically keep the game server updated to the latest nightly release.