⚠️ The latest release is unstable — use preview builds instead
Skip to content

Configuration Overview

JunimoServer uses two configuration mechanisms:

FilePurposeWhen Applied
server-settings.jsonGame and server settings (farm name, cabins, players)On server startup
.env fileDocker infrastructure, credentials, networkingOn container start

Quick Reference

Common tasks:

Configuration Files

server-settings.json

Game settings like farm name, farm type, cabin strategy, and player limits. Created automatically on first startup inside the Docker settings volume.

To edit:

sh
# View current settings
docker compose exec server cat /data/settings/server-settings.json

# Copy out for editing
docker compose cp server:/data/settings/server-settings.json ./server-settings.json
# ... edit the file ...
docker compose cp ./server-settings.json server:/data/settings/server-settings.json

See Server Settings for full reference.

.env File

Docker and infrastructure settings like Steam credentials, VNC password, and port mappings. Create this file in the same directory as docker-compose.yml.

Example minimal .env:

sh
STEAM_USERNAME=your_steam_username
STEAM_PASSWORD=your_steam_password
VNC_PASSWORD=your_secure_password

See Environment Variables for full reference.

Released under the MIT License.