How to add mods?

[KAURkulaator]

What is the correct, up to date, way to add mods?

The provided compose configuration in the README file:

    environment:
      PORT: 2456
      NAME: "Created With Valheim Docker"
      WORLD: "Dedicated"
      PASSWORD: "Banana Phone"
      TZ: "America/Chicago"
      PUBLIC: 1

But how do you add mods this way?


The provided instructions on getting started with mods instructs me to use dash, equals sign and then a pipe for mods:

    environment:
      # The TYPE variable sets the server type.
      - TYPE=BepInEx
      # The MODS variable is a newline-separated list of mods.
      - |
        MODS=OdinPlus-OdinHorse-1.4.12
        ValheimModding-Jotunn-2.23.2
        zolantris-ValheimRAFT-2.5.3
        turbero-KillMeForMyPower-1.1.2

But to use this, i have to change all environment variables to use dash and equals sign, or am i wrong?
At least it did not work for me when trying to add mods with the instructed method.


Then, in a video link provided in issue #1154, there i see it this way:

    environment:
      - TYPE=BepInEx
      - MODS="
          OdinPlus-OdinHorse-1.4.12
          ValheimModding-Jotunn-2.23.2
          zolantris-ValheimRAFT-2.5.3
          turbero-KillMeForMyPower-1.1.2
          "

The last one is the method i use and everything works.

[Phillip-Ian]

Currently, my server uses the first method you show. All of my environment variables use a - and an equals sign anyway. If it is any help, here's my stack / compose file:

version: "3"
services:
valheim:
image: mbround18/valheim:latest
container_name: Valheim
restart: unless-stopped
stop_signal: SIGINT
ports:
- "2456:2456/udp"
- "2457:2457/udp"
- "2458:2458/udp"
environment:
- PORT=2456
- NAME=""
- WORLD=""
- PASSWORD=""
- TZ="America/New_York"
- PUBLIC=1
- AUTO_UPDATE=1
- AUTO_UPDATE_SCHEDULE="0 4 * * "
- AUTO_BACKUP=1
- AUTO_BACKUP_SCHEDULE="/15 * * * *"
- AUTO_BACKUP_REMOVE_OLD=1
- AUTO_BACKUP_DAYS_TO_LIVE=3
- AUTO_BACKUP_ON_UPDATE=1
- AUTO_BACKUP_ON_SHUTDOWN=1
- AUTO_BACKUP_PAUSE_WITH_NO_PLAYERS=1
- WEBHOOK_URL=""
- WEBHOOK_INCLUDE_PUBLIC_IP=0
- UPDATE_ON_STARTUP=1
- USE_PUBLIC_BETA=0
- BETA_BRANCH=public-test
- BETA_BRANCH_PASSWORD=yesimadebackups
- TYPE=BepInEx
- |
MODS=Advize-PlantEverything-1.20.0
rendl0449-CraftFromContainers-3.5.8
Azumatt-AzuClock-1.0.5
shudnal-ConfigurationManager-1.1.9
BasilPanda-NoStamCosts-0.1.2
SpikeHimself-XPortal-1.2.23
Smoothbrain-Sailing-1.1.7
Advize-PlantEasily-2.0.3
TastyChickenLegs-RecyclePlus-1.3.0
ValheimModding-JsonDotNET-13.0.4
ValheimModding-YamlDotNet-16.3.1
ValheimModding-Jotunn-2.26.1
Azumatt-AzuExtendedPlayerInventory-1.4.12
ComfyMods-Gizmo-1.15.0
volumes:
- valheim-saves:/home/steam/.config/unity3d/IronGate/Valheim
- valheim-server:/home/steam/valheim
- valheim-backups:/home/steam/backups
volumes:
valheim-saves:
external: true
valheim-server:
external: true
valheim-backups:
external: true

[KAURkulaator]

Yes, this is the way that i use it as well.

With my question, i meant to direct attention to the outdated example compose file (or at least i think its outdated).
Plus when someone has the same question about adding mods, like i did, because of the different instructions in the readme and getting_started_with_mods, then they can find this.

To some it might seem like super basic knowledge, but its not, especially to a beginner or someone just wanting to set up docker(or docker desktop) with zero knowledge.

[mbround18]

Ill update the examples