Skip to content
This repository has been archived by the owner on Dec 11, 2023. It is now read-only.

Latest commit

 

History

History
117 lines (71 loc) · 3.58 KB

README.md

File metadata and controls

117 lines (71 loc) · 3.58 KB

Avorion Server using Docker

Avorion Docker

Description

You want to host your own dedicated Avorion Server? Best in a docker container? Then you've come to the right place!

This small side project of mine provides a Dockerfile that will always install and update to the latest steamcmd and Avorion server files. The entire server runs inside a docker container and allows you to easily play with your friends or host a public server. The server can easily be updated and managed by using make.

Setting up the Server

Follow the steps to get startet!

Step 1: Clone the repository!

Clone this repository and its content using

git clone https://github.com/cbrgm/avorion-docker

Step 2: Create an up-to-date image of avorion-server

In the directory type the following make command to build an image with the latest server files for your docker container

make build

This will automatically create two additional folders world and backup. The world folder will be mounted inside the container and will persist all server data. You can easily create a backup of them by simply copying the folders content. The backup folder will be used for backup data saves.

Step 3: Run your server

Start your server, so it will generate all server files into world folder. Important: Add your steam id or the steam id of your server administrator before running the container!

make run ADMIN=<Steam_id>

Step 4: Adjust settings and join server!

Stop the container first (make stop). In your world folder adjust the server.ini and change to values. An explanation of each parameter can be found on the web. Start your container after changing your server.ini and start playing!

You can now connect to your server using yourserver-ip/domain at the Avorion Multiplayer menu. Congratulations! :-)

Administrating / Backup

Starting the server

To start the server use:

make start

Stopping the server

To stop the server use:

make stop

Restarting the server

To restart the server use:

make restart

Get the logs of the servers console

To get the logs of the server use:

make logs

Create Backup of your galaxy data!

This will copy the folder world to the backup directory with format "year-month-date-backup".

make backup

Updating the server

Once a new version of Avorion is released you can easily upgrade your server with the latest server files. Do the following

  • Perform a backup of your world data (make backup)
  • Stop, remove and delete your docker container and image
    • docker stop avorion-docker
    • docker rm avorion-docker
    • docker rmi avorion-server
  • Repeat the installation steps explaned above
  • Copy your backup from backup back into world folder
  • Done!

Feature Request and Contributing

You have suggestions for improvements or features you miss? You are welcome to express all your wishes here. Just create a new Issue and it will be taken care of quickly!

Motivation

This script was originally developed by Christian Bargmann. I wanted to play Avorion together with some friends, this is about how I ended up :-)