Skip to content

Latest commit

 

History

History
60 lines (42 loc) · 2.52 KB

README.md

File metadata and controls

60 lines (42 loc) · 2.52 KB

Rimworld Together Unraid App Template

This Unraid app template allows you to easily install and run the Rimworld Together game server on your Unraid server using Docker. The container is hosted on GitHub Container Registry (GHCR).

GUI Install

1. Navigate to the Docker tab of your Unraid server.

2. At the bottom of the Docker tab select "Add Container".

3. Configure the Docker Container

Recommended settings:

  • Template: Leave blank
  • Name: Rimworld-Together
  • Overview: Leave blank
  • Additional Requirements: leave blank
  • Repository: ghcr.io/mrgreaterthan/rimworld-together:latest
    Container tag may be changed from latest to a specific version of Rimworld Together if needed.
  • Network Type: bridge
  • Console shell command: bash
  • Privileged: false

The following settings are added by using the "Add another Path, Port, Variable, Label or Device" button. Review and adjust the following settings as needed:

Port:

  • Name: game-port
  • Container Port: 25555
  • Default Value: 25555
  • Connection Type: TCP
  • Description: used for the game server

Volume Mappings:

Make all volumes read/write

  • Data: Path to store saved data and configs.
    • Container Path: /opt/rimworld-together/Data
    • Default Host Path: /mnt/user/appdata/rimworld-together.

4. Start the Container

Once you've configured the settings:

  1. Click Apply to install the container.
  2. The container will start automatically after installation.
  3. You can manage the container (start, stop, restart) from the Docker tab in the Unraid interface.

5. Access the Game Server

  • Connect to the game server using your Unraid server's IP address and the specified game port (default: 25555).
  • Example: <Unraid-IP>:25555.

6. Manage Game Data

All game data, such as backups, saves, and logs, will be stored in the paths you specified during the volume mapping configuration. By default, these paths are located in /mnt/user/appdata/rimworld-together/ on your Unraid server.

You can back up, restore, and manage these files directly from the Unraid web interface or via SMB/NFS shares.

Support