Skip to content

Commit 443f5e4

Browse files
committed
docs: valheim docs and update links
1 parent 49f92f9 commit 443f5e4

File tree

1 file changed

+45
-4
lines changed

1 file changed

+45
-4
lines changed

README.md

Lines changed: 45 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,10 @@ https://github.com/user-attachments/assets/e2e63d59-3a4e-4aaa-8513-30243aafa6c4
5656
**Supported**
5757

5858
- Minecraft (via [itzg/docker-minecraft-server](https://github.com/itzg/docker-minecraft-server))
59-
- Terraria (via [ryshe/terraria](https://hub.docker.com/r/ryshe/terraria))
60-
- Factorio (via [factoriotools/factorio](https://hub.docker.com/r/factoriotools/factorio))
61-
- Satisfactory (via [wolveix/satisfactory-server](https://hub.docker.com/r/wolveix/satisfactory-server))
59+
- Terraria (via [ryshe/terraria](https://github.com/ryansheehan/terraria))
60+
- Factorio (via [factoriotools/factorio](https://github.com/factoriotools/factorio-docker))
61+
- Satisfactory (via [wolveix/satisfactory-server](https://github.com/wolveix/satisfactory-server))
62+
- Valheim (via [mbround18/valheim-docker](https://github.com/mbround18/valheim-docker))
6263

6364
**LinuxGSM**
6465

@@ -477,7 +478,34 @@ module "linuxgsm" {
477478

478479
<details>
479480

480-
<summary>Multiple servers</summary>
481+
<summary>Valheim server</summary>
482+
483+
```tf
484+
module "valheim" {
485+
id = "GSEDValheimExample"
486+
game = "valheim"
487+
hostname = "valheim-example.duckdns.org"
488+
489+
compose_game_environment = {
490+
"NAME" : "My GSED Valheim Server",
491+
"PASSWORD" : "friendsonly"
492+
"WEBHOOK_URL" : "https://discord.com/api/webhooks/.../..." # optional
493+
}
494+
495+
# DDNS
496+
duckdns_token = var.duckdns_token
497+
498+
# Region (change these to desired region)
499+
base_region = module.region_us-east-2.base_region
500+
providers = { aws = aws.us-east-2 }
501+
az = "us-east-2a"
502+
503+
# ------------ Common values (just copy and paste) -------------
504+
source = "./server"
505+
iam_role_dlm_lifecycle_arn = module.global.iam_role_dlm_lifecycle_arn
506+
# --------------------------------------------------------------
507+
}
508+
```
481509

482510
</details>
483511

@@ -736,6 +764,19 @@ In there you should at least set up a server password (different from admin pass
736764

737765
</details>
738766

767+
<details>
768+
<summary>Valheim</summary>
769+
770+
### Valheim post-setup
771+
772+
By default, the server is created with a password of `valheim` and should be visible in the server list depending on your region. (default server name is the server Terraform module id)
773+
774+
You may change the server password, among [other things](https://github.com/mbround18/valheim-docker?tab=readme-ov-file#environment-variables) such as server name via the `compose_game_environment` server module Terraform variable. See "Valheim server" in [Examples](#examples)
775+
776+
You must run `terraform apply` again to apply the changes.
777+
778+
</details>
779+
739780
<details>
740781
<summary>LinuxGSM</summary>
741782

0 commit comments

Comments
 (0)