Deployed newserv on Portainer stack.

[desincarnage]

For anyone who'd like to deploy this server at home, here's how I did using Portainer as a Docker Standalone container manager, hosted on a Ubuntu Server 24.04 VM.

Prerequesites

• A different server from your DNS
  • newserv depends on using port 53/UDP to function.
• Ubuntu's stub resolver disabled
  • 'systemd-resolved' listens on port 53/UDP by default, which conflicts with newserv. You can follow this guide to disable it.
• Docker installed
• Portainer (or portainer agent) deployed

Deployment of newserv

• First, the newserv docker image must be built. The Docker section of the readme does a good job explaining how this is done.
• The image then needs to be made available to Portainer. A registry is required to do so.
  • Select the docker host's environment in Portainer
  • In Templates > Application, search for Registry
    • Give it a name and select Bridge network. Deploy.
  • Then in Images, click Import
    • Select the newly built newserv image, your new registry, a name and a tag(ex: newserv:latest)
• With the image available in Portainer's registry, you can build a stack referencing it.
  • In Stacks, add a new stack
  • You can use the compose file below and paste it on the web editor.
• Once the container is up, (or before if you are using bind mounts (see Notes)), config.json must be edited to listen on the same address as the host.
  • Change localAddress to the address of the host.

Notes

1. Portainer agents use port 9001 to expose the docker socket to the main Portainer instance. This will conflict with the default newserv configuration. newserv will try to bind to port 9001 to use the gc-jp11 version of PSO. A workaround is to comment out the version in config.json if you don't plan on hosting players using this version of the game. Another option would be to change the port portainer-agent uses.
2. The compose file uses named volumes instead of bind mounts for portability.
   The volumes are located in /var/lib/docker/volumes and can only be accessed by root. You can use bind mounts instead by providing the full path of the folders/files on the host.
3. Separate volumes for players, teams and licences folders is probably redundant. The System volume is likely enough to persist the container's data.

Compose file

  newserv:
    image: newserv-reg:5000/newserv:latest
    container_name: pso-newserv
    network_mode: "host"
    ports:
      - "53:53/udp"
      - "5100:5100"
      - "5110:5110"
      - "5111:5111"
      - "5112:5112"
      - "9064:9064"
      - "9100:9100"
      - "9103:9103"
      - "9300:9300"
      - "11000:11000"
      - "12000:12000"
      - "12004:12004"
      - "12005:12005"
    restart: unless-stopped
    volumes:
      - newservSystem:/newserv/system

volumes:
  newservSystem:

This is probably not much to add over this project's documentation, but this is the result of the struggles I had deploying this container at home. I hope it is someday useful to others as well.