mornedhels/icarus-server repository overview

⁠ICARUS-Dedicated-Server

Docker image for the game ICARUS. The image is based on the steamcmd⁠ image and uses supervisor to handle startup, automatic updates and cleanup.

⁠Environment Variables

⚠️: Work in Progress

⁠Additional Information

• During the update process, the container temporarily requires more disk space (up to 2x the game size).

⁠Hooks

The scripts will wait for the hook to resolve/return before continuing.

⚠️: Work in Progress

⁠Ports

⁠Volumes

Note: By default the volumes are created with the UID and GID 4711 (that user should not exist). To change this, set the environment variables PUID and PGID.

⁠Recommended System Requirements

• CPU: min 2 CPU (preferred high single core performance)
• RAM: > 8 GB (16 GB recommended)
• Disk: ~20 GB
• Docker Host*: Linux, macOS

*Windows is not supported (see #46⁠)

⁠Usage

⁠Docker Compose

version: "3"
services:
  icarus:
    image: mornedhels/icarus-server:latest
    container_name: icarus
    hostname: icarus
    restart: unless-stopped
    stop_grace_period: 90s
    ports:
      - "17777:17777/udp"
      - "27015:27015/udp"
    volumes:
      - ./data:/home/icarus/drive_c/icarus
      - ./game:/opt/icarus
    environment:
      - SERVER_NAME=ICARUS Server
      - SERVER_PASSWORD=secret
      - SERVER_ADMIN_PASSWORD=evenmoresecret
      - SERVER_PORT=17777
      - SERVER_QUERYPORT=27015
      - PUID=4711
      - PGID=4711

Note: The volumes are created next to the docker-compose.yml file. If you want to create the volumes, in the default location (eg. /var/lib/docker) you can use the following compose file:

version: "3"
services:
  icarus:
    image: mornedhels/icarus-server:latest
    container_name: icarus
    hostname: icarus
    restart: unless-stopped
    stop_grace_period: 90s
    ports:
      - "17777:17777/udp"
      - "27015:27015/udp"
    volumes:
      - data:/home/icarus/drive_c/icarus
      - game:/opt/icarus
    environment:
      - SERVER_NAME=ICARUS Server
      - SERVER_PASSWORD=secret
      - SERVER_ADMIN_PASSWORD=evenmoresecret
      - SERVER_PORT=17777
      - SERVER_QUERYPORT=27015
      - PUID=4711
      - PGID=4711

volumes:
  data:
  game:

⁠Commands

• Force Update:

  docker compose exec icarus supervisorctl start icarus-force-update
  

  Copy
• Load Prospect (⚠️: Work in Progress):

  docker compose exec icarus ./icarus-commands loadProspect <ProspectName>
  

  Copy

⁠Known Issues

• OOM: Server logs Freeing x bytes from backup pool to handle out of memory and Fatal error: [File: Unknown] [Line: 197] \nRan out of memory allocating 0 bytes with alignment 0\n but system has enough memory.
  • Solution: Increase maximum number of memory map areas (vm.max_map_count) on docker host. Tested with 262144
    temporary:

      sysctl -w vm.max_map_count=262144
    

    Copy
    permanent:

      echo "vm.max_map_count=262144" >> /etc/sysctl.conf && sysctl -p
    

    Copy