diff --git a/.markdownlint.json b/.markdownlint.json
new file mode 100644
index 00000000..4aead545
--- /dev/null
+++ b/.markdownlint.json
@@ -0,0 +1,5 @@
+{
+ "default": true,
+ "MD033": false,
+ "MD013": false
+}
\ No newline at end of file
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 0937b9ff..9e133978 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -5,17 +5,16 @@
This package includes a make file for easy development.
You can get use the make file by installing cargo make via `cargo install cargo-make`
-
### Commands
-| Command | What it does |
-|---------------------|--------------|
-| makers format | Formats the `http-server` and `odin` |
-| makers clippy | Builds and runs clippy on `http-server` and `odin` |
-| makers build | Builds the two projects |
-| makers start:dev | Formats, Clippy, docker-compose build, and docker-compose up |
-| makers docker:build | Runs docker-compose build for the file `docker-compose.dev.yml` |
-| makers docker:up | Runs docker-compose up for `docker-compose.dev.yml` |
+| Command | What it does |
+| ------------------- | ------------------------------------------------------------------------------ |
+| makers format | Formats the `http-server` and `odin` |
+| makers clippy | Builds and runs clippy on `http-server` and `odin` |
+| makers build | Builds the two projects |
+| makers start:dev | Formats, Clippy, docker-compose build, and docker-compose up |
+| makers docker:build | Runs docker-compose build for the file `docker-compose.dev.yml` |
+| makers docker:up | Runs docker-compose up for `docker-compose.dev.yml` |
| makers access | Runs `docker-compose -f docker-compose.dev.yml exec --user steam valheim bash` |
-| makers access:admin | Runs `docker-compose -f docker-compose.dev.yml exec valheim bash` |
-| makers release | Builds a release binary for `odin` and `http-server` |
+| makers access:admin | Runs `docker-compose -f docker-compose.dev.yml exec valheim bash` |
+| makers release | Builds a release binary for `odin` and `http-server` |
diff --git a/Cargo.lock b/Cargo.lock
index 255f0ffa..71bb1c2d 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -242,6 +242,12 @@ version = "0.3.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "fea41bba32d969b513997752735605054bc0dfa92b4c56bf1189f2e174be7a10"
+[[package]]
+name = "either"
+version = "1.6.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e78d4f1cc4ae33bbfc157ed5d5a5ef3bc29227303d595861deb238fcec4e9457"
+
[[package]]
name = "encoding_rs"
version = "0.8.28"
@@ -299,9 +305,9 @@ checksum = "2022715d62ab30faffd124d40b76f4134a550a87792276512b18d63272333394"
[[package]]
name = "futures"
-version = "0.3.13"
+version = "0.3.14"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7f55667319111d593ba876406af7c409c0ebb44dc4be6132a783ccf163ea14c1"
+checksum = "a9d5813545e459ad3ca1bff9915e9ad7f1a47dc6a91b627ce321d5863b7dd253"
dependencies = [
"futures-channel",
"futures-core",
@@ -313,9 +319,9 @@ dependencies = [
[[package]]
name = "futures-channel"
-version = "0.3.13"
+version = "0.3.14"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8c2dd2df839b57db9ab69c2c9d8f3e8c81984781937fe2807dc6dcf3b2ad2939"
+checksum = "ce79c6a52a299137a6013061e0cf0e688fce5d7f1bc60125f520912fdb29ec25"
dependencies = [
"futures-core",
"futures-sink",
@@ -323,21 +329,21 @@ dependencies = [
[[package]]
name = "futures-core"
-version = "0.3.13"
+version = "0.3.14"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "15496a72fabf0e62bdc3df11a59a3787429221dd0710ba8ef163d6f7a9112c94"
+checksum = "098cd1c6dda6ca01650f1a37a794245eb73181d0d4d4e955e2f3c37db7af1815"
[[package]]
name = "futures-io"
-version = "0.3.13"
+version = "0.3.14"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d71c2c65c57704c32f5241c1223167c2c3294fd34ac020c807ddbe6db287ba59"
+checksum = "365a1a1fb30ea1c03a830fdb2158f5236833ac81fa0ad12fe35b29cddc35cb04"
[[package]]
name = "futures-macro"
-version = "0.3.13"
+version = "0.3.14"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ea405816a5139fb39af82c2beb921d52143f556038378d6db21183a5c37fbfb7"
+checksum = "668c6733a182cd7deb4f1de7ba3bf2120823835b3bcfbeacf7d2c4a773c1bb8b"
dependencies = [
"proc-macro-hack",
"proc-macro2",
@@ -347,21 +353,21 @@ dependencies = [
[[package]]
name = "futures-sink"
-version = "0.3.13"
+version = "0.3.14"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "85754d98985841b7d4f5e8e6fbfa4a4ac847916893ec511a2917ccd8525b8bb3"
+checksum = "5c5629433c555de3d82861a7a4e3794a4c40040390907cfbfd7143a92a426c23"
[[package]]
name = "futures-task"
-version = "0.3.13"
+version = "0.3.14"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "fa189ef211c15ee602667a6fcfe1c1fd9e07d42250d2156382820fba33c9df80"
+checksum = "ba7aa51095076f3ba6d9a1f702f74bd05ec65f555d70d2033d55ba8d69f581bc"
[[package]]
name = "futures-util"
-version = "0.3.13"
+version = "0.3.14"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1812c7ab8aedf8d6f2701a43e1243acdbcc2b36ab26e2ad421eb99ac963d96d1"
+checksum = "3c144ad54d60f23927f0a6b6d816e4271278b64f005ad65e4e35291d2de9c025"
dependencies = [
"futures-core",
"futures-io",
@@ -416,9 +422,9 @@ checksum = "9b919933a397b79c37e33b77bb2aa3dc8eb6e165ad809e58ff75bc7db2e34574"
[[package]]
name = "h2"
-version = "0.3.1"
+version = "0.3.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d832b01df74254fe364568d6ddc294443f61cbec82816b60904303af87efae78"
+checksum = "fc018e188373e2777d0ef2467ebff62a08e66c3f5857b23c8fbec3018210dc00"
dependencies = [
"bytes",
"fnv",
@@ -484,9 +490,9 @@ dependencies = [
[[package]]
name = "http"
-version = "0.2.3"
+version = "0.2.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7245cd7449cc792608c3c8a9eaf69bd4eabbabf802713748fd739c98b82f0747"
+checksum = "527e8c9ac747e28542699a951517aa9a6945af506cd1f2e1b53a576c17b6cc11"
dependencies = [
"bytes",
"fnv",
@@ -495,19 +501,20 @@ dependencies = [
[[package]]
name = "http-body"
-version = "0.4.0"
+version = "0.4.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2861bd27ee074e5ee891e8b539837a9430012e249d7f0ca2d795650f579c1994"
+checksum = "5dfb77c123b4e2f72a2069aeae0b4b4949cc7e966df277813fc16347e7549737"
dependencies = [
"bytes",
"http",
+ "pin-project-lite",
]
[[package]]
name = "httparse"
-version = "1.3.5"
+version = "1.3.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "615caabe2c3160b313d52ccc905335f4ed5f10881dd63dc5699d47e90be85691"
+checksum = "bc35c995b9d93ec174cf9a27d425c7892722101e14993cd227fdb51d70cf9589"
[[package]]
name = "httpdate"
@@ -517,9 +524,9 @@ checksum = "494b4d60369511e7dea41cf646832512a94e542f68bb9c49e54518e0f468eb47"
[[package]]
name = "hyper"
-version = "0.14.4"
+version = "0.14.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e8e946c2b1349055e0b72ae281b238baf1a3ea7307c7e9f9d64673bdd9c26ac7"
+checksum = "8bf09f61b52cfcf4c00de50df88ae423d6c02354e385a86341133b5338630ad1"
dependencies = [
"bytes",
"futures-channel",
@@ -613,9 +620,9 @@ checksum = "dd25036021b0de88a0aff6b850051563c6516d0bf53f8638938edbb9de732736"
[[package]]
name = "js-sys"
-version = "0.3.49"
+version = "0.3.50"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "dc15e39392125075f60c95ba416f5381ff6c3a948ff02ab12464715adf56c821"
+checksum = "2d99f9e3e84b8f67f846ef5b4cbbc3b1c29f6c759fcbce6f01aa0e73d932a24c"
dependencies = [
"wasm-bindgen",
]
@@ -628,9 +635,9 @@ checksum = "e2abad23fbc42b3700f2f279844dc832adb2b2eb069b2df918f455c4e18cc646"
[[package]]
name = "libc"
-version = "0.2.89"
+version = "0.2.93"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "538c092e5586f4cdd7dd8078c4a79220e3e168880218124dcbce860f0ea938c6"
+checksum = "9385f66bf6105b241aa65a61cb923ef20efc665cb9f9bb50ac2f0c4b7f378d41"
[[package]]
name = "linked-hash-map"
@@ -640,9 +647,9 @@ checksum = "7fb9b38af92608140b86b693604b9ffcc5824240a484d1ecd4795bacb2fe88f3"
[[package]]
name = "lock_api"
-version = "0.4.2"
+version = "0.4.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "dd96ffd135b2fd7b973ac026d28085defbe8983df057ced3eb4f2130b0831312"
+checksum = "5a3c91c24eae6777794bb1997ad98bbb87daf92890acab859f7eaa4320333176"
dependencies = [
"scopeguard",
]
@@ -701,9 +708,9 @@ dependencies = [
[[package]]
name = "mio"
-version = "0.7.10"
+version = "0.7.11"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2182a122f3b7f3f5329cb1972cee089ba2459a0a80a56935e6e674f096f8d839"
+checksum = "cf80d3e903b34e0bd7282b218398aec54e082c840d9baf8339e0080a0c542956"
dependencies = [
"libc",
"log",
@@ -714,11 +721,10 @@ dependencies = [
[[package]]
name = "miow"
-version = "0.3.6"
+version = "0.3.7"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5a33c1b55807fbed163481b5ba66db4b2fa6cde694a5027be10fb724206c5897"
+checksum = "b9f1c5b025cda876f66ef43a113f91ebc9f4ccef34843000e0adf6ebbab84e21"
dependencies = [
- "socket2",
"winapi",
]
@@ -867,18 +873,18 @@ checksum = "d4fd5641d01c8f18a23da7b6fe29298ff4b55afcccdf78973b24cf3175fee32e"
[[package]]
name = "pin-project"
-version = "1.0.5"
+version = "1.0.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "96fa8ebb90271c4477f144354485b8068bd8f6b78b428b01ba892ca26caf0b63"
+checksum = "bc174859768806e91ae575187ada95c91a29e96a98dc5d2cd9a1fed039501ba6"
dependencies = [
"pin-project-internal",
]
[[package]]
name = "pin-project-internal"
-version = "1.0.5"
+version = "1.0.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "758669ae3558c6f74bd2a18b41f7ac0b5a195aea6639d6a9b5e5d1ad5ba24c0b"
+checksum = "a490329918e856ed1b083f244e3bfe2d8c4f336407e4ea9e1a9f479ff09049e5"
dependencies = [
"proc-macro2",
"quote",
@@ -947,9 +953,9 @@ checksum = "bc881b2c22681370c6a780e47af9840ef841837bc98118431d4e1868bd0c1086"
[[package]]
name = "proc-macro2"
-version = "1.0.24"
+version = "1.0.26"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1e0704ee1a7e00d7bb417d0770ea303c1bccbabf0ef1667dae92b5967f5f8a71"
+checksum = "a152013215dca273577e18d2bf00fa862b89b24169fb78c4c95aeb07992c9cec"
dependencies = [
"unicode-xid",
]
@@ -1158,9 +1164,9 @@ checksum = "d29ab0c6d3fc0ee92fe66e2d99f700eab17a8d57d1c1d3b748380fb20baa78cd"
[[package]]
name = "sct"
-version = "0.6.0"
+version = "0.6.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e3042af939fca8c3453b7af0f1c66e533a15a86169e39de2657310ade8f98d3c"
+checksum = "b362b83898e0e69f38515b82ee15aa80636befe47c3b6d3d89a911e78fc228ce"
dependencies = [
"ring",
"untrusted",
@@ -1168,18 +1174,18 @@ dependencies = [
[[package]]
name = "serde"
-version = "1.0.124"
+version = "1.0.125"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "bd761ff957cb2a45fbb9ab3da6512de9de55872866160b23c25f1a841e99d29f"
+checksum = "558dc50e1a5a5fa7112ca2ce4effcb321b0300c0d4ccf0776a9f60cd89031171"
dependencies = [
"serde_derive",
]
[[package]]
name = "serde_derive"
-version = "1.0.124"
+version = "1.0.125"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1800f7693e94e186f5e25a28291ae1570da908aff7d97a095dec1e56ff99069b"
+checksum = "b093b7a2bb58203b5da3056c05b4ec1fed827dcfdb37347a8841695263b3d06d"
dependencies = [
"proc-macro2",
"quote",
@@ -1267,11 +1273,10 @@ checksum = "fe0f37c9e8f3c5a4a66ad655a93c74daac4ad00c441533bf5c6e7990bb42604e"
[[package]]
name = "socket2"
-version = "0.3.19"
+version = "0.4.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "122e570113d28d773067fab24266b66753f6ea915758651696b6e35e49f88d6e"
+checksum = "9e3dfc207c526015c632472a77be09cf1b6e46866581aecae5cc38fb4235dea2"
dependencies = [
- "cfg-if 1.0.0",
"libc",
"winapi",
]
@@ -1290,9 +1295,9 @@ checksum = "73473c0e59e6d5812c5dfe2a064a6444949f089e20eec9a2e5506596494e4623"
[[package]]
name = "syn"
-version = "1.0.64"
+version = "1.0.69"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3fd9d1e9976102a03c542daa2eff1b43f9d72306342f3f8b3ed5fb8908195d6f"
+checksum = "48fe99c6bd8b1cc636890bcc071842de909d902c81ac7dab53ba33c421ab8ffb"
dependencies = [
"proc-macro2",
"quote",
@@ -1389,9 +1394,9 @@ dependencies = [
[[package]]
name = "tinyvec"
-version = "1.1.1"
+version = "1.2.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "317cca572a0e89c3ce0ca1f1bdc9369547fe318a683418e42ac8f59d14701023"
+checksum = "5b5220f05bb7de7f3f53c7c065e1199b3172696fe2db9f9c4d8ad9b4ee74c342"
dependencies = [
"tinyvec_macros",
]
@@ -1404,9 +1409,9 @@ checksum = "cda74da7e1a664f795bb1f8a87ec406fb89a02522cf6e50620d016add6dbbf5c"
[[package]]
name = "tokio"
-version = "1.3.0"
+version = "1.4.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8d56477f6ed99e10225f38f9f75f872f29b8b8bd8c0b946f63345bb144e9eeda"
+checksum = "134af885d758d645f0f0505c9a8b3f9bf8a348fd822e112ab5248138348f1722"
dependencies = [
"autocfg",
"bytes",
@@ -1446,9 +1451,9 @@ dependencies = [
[[package]]
name = "tokio-stream"
-version = "0.1.4"
+version = "0.1.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c535f53c0cfa1acace62995a8994fc9cc1f12d202420da96ff306ee24d576469"
+checksum = "e177a5d8c3bf36de9ebe6d58537d8879e964332f93fb3339e43f618c81361af0"
dependencies = [
"futures-core",
"pin-project-lite",
@@ -1470,9 +1475,9 @@ dependencies = [
[[package]]
name = "tokio-util"
-version = "0.6.4"
+version = "0.6.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ec31e5cc6b46e653cf57762f36f71d5e6386391d88a72fd6db4508f8f676fb29"
+checksum = "5143d049e85af7fbc36f5454d990e62c2df705b3589f123b71f441b6b59f443f"
dependencies = [
"bytes",
"futures-core",
@@ -1509,16 +1514,6 @@ dependencies = [
"lazy_static",
]
-[[package]]
-name = "tracing-futures"
-version = "0.2.5"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "97d095ae15e245a057c8e8451bab9b3ee1e1f68e9ba2b4fbc18d0ac5237835f2"
-dependencies = [
- "pin-project",
- "tracing",
-]
-
[[package]]
name = "try-lock"
version = "0.2.3"
@@ -1570,9 +1565,9 @@ dependencies = [
[[package]]
name = "unicode-bidi"
-version = "0.3.4"
+version = "0.3.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "49f2bd0c6468a8230e1db229cff8029217cf623c767ea5d60bfbd42729ea54d5"
+checksum = "eeb8be209bb1c96b7c177c7420d26e04eccacb0eeae6b980e35fcb74678107e0"
dependencies = [
"matches",
]
@@ -1652,9 +1647,9 @@ dependencies = [
[[package]]
name = "warp"
-version = "0.3.0"
+version = "0.3.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3dafd0aac2818a94a34df0df1100a7356c493d8ede4393875fd0b5c51bb6bc80"
+checksum = "332d47745e9a0c38636dbd454729b147d16bd1ed08ae67b3ab281c4506771054"
dependencies = [
"bytes",
"futures",
@@ -1677,7 +1672,6 @@ dependencies = [
"tokio-util",
"tower-service",
"tracing",
- "tracing-futures",
]
[[package]]
@@ -1694,9 +1688,9 @@ checksum = "fd6fbd9a79829dd1ad0cc20627bf1ed606756a7f77edff7b66b7064f9cb327c6"
[[package]]
name = "wasm-bindgen"
-version = "0.2.72"
+version = "0.2.73"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8fe8f61dba8e5d645a4d8132dc7a0a66861ed5e1045d2c0ed940fab33bac0fbe"
+checksum = "83240549659d187488f91f33c0f8547cbfef0b2088bc470c116d1d260ef623d9"
dependencies = [
"cfg-if 1.0.0",
"serde",
@@ -1706,9 +1700,9 @@ dependencies = [
[[package]]
name = "wasm-bindgen-backend"
-version = "0.2.72"
+version = "0.2.73"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "046ceba58ff062da072c7cb4ba5b22a37f00a302483f7e2a6cdc18fedbdc1fd3"
+checksum = "ae70622411ca953215ca6d06d3ebeb1e915f0f6613e3b495122878d7ebec7dae"
dependencies = [
"bumpalo",
"lazy_static",
@@ -1721,9 +1715,9 @@ dependencies = [
[[package]]
name = "wasm-bindgen-futures"
-version = "0.4.22"
+version = "0.4.23"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "73157efb9af26fb564bb59a009afd1c7c334a44db171d280690d0c3faaec3468"
+checksum = "81b8b767af23de6ac18bf2168b690bed2902743ddf0fb39252e36f9e2bfc63ea"
dependencies = [
"cfg-if 1.0.0",
"js-sys",
@@ -1733,9 +1727,9 @@ dependencies = [
[[package]]
name = "wasm-bindgen-macro"
-version = "0.2.72"
+version = "0.2.73"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0ef9aa01d36cda046f797c57959ff5f3c615c9cc63997a8d545831ec7976819b"
+checksum = "3e734d91443f177bfdb41969de821e15c516931c3c3db3d318fa1b68975d0f6f"
dependencies = [
"quote",
"wasm-bindgen-macro-support",
@@ -1743,9 +1737,9 @@ dependencies = [
[[package]]
name = "wasm-bindgen-macro-support"
-version = "0.2.72"
+version = "0.2.73"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "96eb45c1b2ee33545a813a92dbb53856418bf7eb54ab34f7f7ff1448a5b3735d"
+checksum = "d53739ff08c8a68b0fdbcd54c372b8ab800b1449ab3c9d706503bc7dd1621b2c"
dependencies = [
"proc-macro2",
"quote",
@@ -1756,15 +1750,15 @@ dependencies = [
[[package]]
name = "wasm-bindgen-shared"
-version = "0.2.72"
+version = "0.2.73"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b7148f4696fb4960a346eaa60bbfb42a1ac4ebba21f750f75fc1375b098d5ffa"
+checksum = "d9a543ae66aa233d14bb765ed9af4a33e81b8b58d1584cf1b47ff8cd0b9e4489"
[[package]]
name = "web-sys"
-version = "0.3.49"
+version = "0.3.50"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "59fe19d70f5dacc03f6e46777213facae5ac3801575d56ca6cbd4c93dcd12310"
+checksum = "a905d57e488fec8861446d3393670fb50d27a262344013181c2cdf9fff5481be"
dependencies = [
"js-sys",
"wasm-bindgen",
@@ -1782,21 +1776,21 @@ dependencies = [
[[package]]
name = "webpki-roots"
-version = "0.21.0"
+version = "0.21.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "82015b7e0b8bad8185994674a13a93306bea76cf5a16c5a181382fd3a5ec2376"
+checksum = "aabe153544e473b775453675851ecc86863d2a81d786d741f6b76778f2a48940"
dependencies = [
"webpki",
]
[[package]]
name = "which"
-version = "4.0.2"
+version = "4.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "87c14ef7e1b8b8ecfc75d5eca37949410046e66f15d185c01d70824f1f8111ef"
+checksum = "b55551e42cbdf2ce2bedd2203d0cc08dba002c27510f86dab6d0ce304cba3dfe"
dependencies = [
+ "either",
"libc",
- "thiserror",
]
[[package]]
diff --git a/Dockerfile b/Dockerfile
index 052cd596..993a5a2e 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -71,7 +71,7 @@ RUN usermod -u ${PUID} steam \
HEALTHCHECK --interval=1m --timeout=3s \
- CMD pidof valheim_server.x86_64 || exit 1
+ CMD pidof valheim_server.x86_64 || exit 1
ENTRYPOINT ["/bin/bash","/entrypoint.sh"]
CMD ["/bin/bash", "/home/steam/scripts/start_valheim.sh"]
diff --git a/README.md b/README.md
index 5507612f..962ec9ad 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
# [Valheim]
+
@@ -13,12 +14,10 @@
-
-
## Docker
> [If you are looking for a guide on how to get started click here](https://github.com/mbround18/valheim-docker/discussions/28)
->
+>
> Mod Support! It is supported to launch the server with BepInEx but!!!!! as a disclaimer! You take responsibility for debugging why your server won't start.
> Modding is not supported by the Valheim developers officially yet; Which means you WILL run into errors. This repo has been tested with running ValheimPlus as a test mod and does not have any issues.
> See [Getting started with mods]
@@ -37,33 +36,64 @@
### Environment Variables
-> See further on down for advanced environment variables.
-
-| Variable | Default | Required | Description |
-|--------------------------|------------------------|----------|-------------|
-| TZ | `America/Los_Angeles` | FALSE | Sets what timezone your container is running on. This is used for timestamps and cron jobs. [Click Here for which timezones are valid.](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) |
-| PUID | `1000` | FALSE | Sets the User Id of the steam user. |
-| PGID | `1000` | FALSE | Sets the Group Id of the steam user. |
-| ADDRESS | `Your Public IP` | FALSE | This setting is used in conjunction with `odin status` and setting this will stop `odin` from trying to fetch your public IP |
-| PORT | `2456` | TRUE | Sets the port your server will listen on. Take note it will also listen on +2 (ex: 2456, 2457, 2458) |
-| NAME | `Valheim Docker` | TRUE | The name of your server! Make it fun and unique! |
-| WORLD | `Dedicated` | TRUE | This is used to generate the name of your world. |
-| PUBLIC | `1` | FALSE | Sets whether or not your server is public on the server list. |
-| PASSWORD | ` ` | TRUE | Set this to something unique! |
-| TYPE | `Vanilla` | FALSE | This can be set to `ValheimPlus`, `BepInEx`, `BepInExFull` or `Vanilla` |
-| MODS | ` ` | FALSE | This is an array of mods separated by comma and a new line. [Click Here for Examples](./docs/getting_started_with_mods.md) Supported files are `zip`, `dll`, and `cfg`. |
-| AUTO_UPDATE | `0` | FALSE | Set to `1` if you want your container to auto update! This means at the times indicated by `AUTO_UPDATE_SCHEDULE` it will check for server updates. If there is an update then the server will be shut down, updated, and brought back online if the server was running before. |
-| AUTO_UPDATE_SCHEDULE | `0 1 * * *` | FALSE | This works in conjunction with `AUTO_UPDATE` and sets the schedule to which it will run an auto update. [If you need help figuring out a cron schedule click here]
-| AUTO_UPDATE_PAUSE_WITH_PLAYERS | `0` | FALSE | Does not process an update for the server if there are players online. |
-| AUTO_BACKUP | `0` | FALSE | Set to `1` to enable auto backups. Backups are stored under `/home/steam/backups` which means you will have to add a volume mount for this directory. |
-| AUTO_BACKUP_SCHEDULE | `*/15 * * * *` | FALSE | Change to set how frequently you would like the server to backup. [If you need help figuring out a cron schedule click here].
-| AUTO_BACKUP_REMOVE_OLD | `1` | FALSE | Set to `0` to keep all backups or manually manage them. |
-| AUTO_BACKUP_DAYS_TO_LIVE | `3` | FALSE | This is the number of days you would like to keep backups for. While backups are compressed and generally small it is best to change this number as needed. |
-| AUTO_BACKUP_ON_UPDATE | `0` | FALSE | Create a backup on right before updating and starting your server. |
-| AUTO_BACKUP_ON_SHUTDOWN | `0` | FALSE | Create a backup on shutdown. |
-| AUTO_BACKUP_PAUSE_WITH_NO_PLAYERS | `0` | FALSE | Will skip creating a backup if there are no players. `PUBLIC` must be set to `1` for this to work! |
-| WEBHOOK_URL | ` ` | FALSE | Supply this to get information regarding your server's status in a webhook or Discord notification! [Click here to learn how to get a webhook url for Discord](https://help.dashe.io/en/articles/2521940-how-to-create-a-discord-webhook-url) |
-| UPDATE_ON_STARTUP | `1` | FALSE | Tries to update the server the container is started. |
+> See further on down for advanced environment variables.
+
+| Variable | Default | Required | Description |
+| -------- | ----------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| PORT | `2456` | TRUE | Sets the port your server will listen on. Take note it will also listen on +2 (ex: 2456, 2457, 2458) |
+| NAME | `Valheim Docker` | TRUE | The name of your server! Make it fun and unique! |
+| WORLD | `Dedicated` | TRUE | This is used to generate the name of your world. |
+| PUBLIC | `1` | FALSE | Sets whether or not your server is public on the server list. |
+| PASSWORD | `` | TRUE | Set this to something unique! |
+| TYPE | `Vanilla` | FALSE | This can be set to `ValheimPlus`, `BepInEx`, `BepInExFull` or `Vanilla` |
+| MODS | `` | FALSE | This is an array of mods separated by comma and a new line. [Click Here for Examples](./docs/getting_started_with_mods.md) Supported files are `zip`, `dll`, and `cfg`. |
+
+| WEBHOOK_URL | `` | FALSE | Supply this to get information regarding your server's status in a webhook or Discord notification! [Click here to learn how to get a webhook url for Discord](https://help.dashe.io/en/articles/2521940-how-to-create-a-discord-webhook-url) |
+| UPDATE_ON_STARTUP | `1` | FALSE | Tries to update the server the container is started. |
+
+#### Container Env Variables
+
+| Variable | Default | Required | Description |
+| -------- | --------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| TZ | `America/Los_Angeles` | FALSE | Sets what timezone your container is running on. This is used for timestamps and cron jobs. [Click Here for which timezones are valid.](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) |
+| PUID | `1000` | FALSE | Sets the User Id of the steam user. |
+| PGID | `1000` | FALSE | Sets the Group Id of the steam user. |
+
+#### Auto Update
+
+| Variable | Default | Required | Description |
+| ------------------------------ | ----------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| AUTO_UPDATE | `0` | FALSE | Set to `1` if you want your container to auto update! This means at the times indicated by `AUTO_UPDATE_SCHEDULE` it will check for server updates. If there is an update then the server will be shut down, updated, and brought back online if the server was running before. |
+| AUTO_UPDATE_SCHEDULE | `0 1 * * *` | FALSE | This works in conjunction with `AUTO_UPDATE` and sets the schedule to which it will run an auto update. [If you need help figuring out a cron schedule click here] |
+| AUTO_UPDATE_PAUSE_WITH_PLAYERS | `0` | FALSE | Does not process an update for the server if there are players online. |
+
+Auto update job, queries steam and compares it against your internal steam files for differential in version numbers.
+
+#### Auto Backup
+
+| Variable | Default | Required | Description |
+| --------------------------------- | -------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| AUTO_BACKUP | `0` | FALSE | Set to `1` to enable auto backups. Backups are stored under `/home/steam/backups` which means you will have to add a volume mount for this directory. |
+| AUTO_BACKUP_SCHEDULE | `*/15 * * * *` | FALSE | Change to set how frequently you would like the server to backup. [If you need help figuring out a cron schedule click here]. |
+| AUTO_BACKUP_REMOVE_OLD | `1` | FALSE | Set to `0` to keep all backups or manually manage them. |
+| AUTO_BACKUP_DAYS_TO_LIVE | `3` | FALSE | This is the number of days you would like to keep backups for. While backups are compressed and generally small it is best to change this number as needed. |
+| AUTO_BACKUP_ON_UPDATE | `0` | FALSE | Create a backup on right before updating and starting your server. |
+| AUTO_BACKUP_ON_SHUTDOWN | `0` | FALSE | Create a backup on shutdown. |
+| AUTO_BACKUP_PAUSE_WITH_NO_PLAYERS | `0` | FALSE | Will skip creating a backup if there are no players. `PUBLIC` must be set to `1` for this to work! |
+
+Auto backup job produces an output of a `*.tar.gz` file which should average around 30mb for a world that has an average of 4 players consistently building on. You should be aware that if you place the server folder in your saves folder your backups could become astronomical in size. This is a common problem that others have observed, to avoid this please follow the guide for how volume mounts should be made in the `docker-compose.yml`.
+
+#### Http Server
+
+| Variable | Default | Required | Description |
+| --------- | --------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| ADDRESS | `Your Public IP` | FALSE | This setting is used in conjunction with `odin status` and setting this will stop `odin` from trying to fetch your public IP |
+| HTTP_PORT | `anything above 1024` | FALSE | Setting this will spin up a little http server that provides two endpoints for you to call. |
+
+- `/metrics` provides a prometheous style metrics output.
+- `/status` provides a more traditional status page.
+
+> Note on `ADDRESS` this can be set to `127.0.0.1:` or `:` but does not have to be set. If it is set, it will prevent odin from reaching out to aws ip service from asking for your public IP address. Keep in mind, your query port is +1 of what you set in the `PORT` env variable for your valheim server.
### Docker Compose
@@ -88,8 +118,8 @@ services:
TZ: "America/Chicago"
PUBLIC: 1
volumes:
- - ./valheim/saves:/home/steam/.config/unity3d/IronGate/Valheim
- - ./valheim/server:/home/steam/valheim
+ - ./valheim/saves:/home/steam/.config/unity3d/IronGate/Valheim
+ - ./valheim/server:/home/steam/valheim
```
#### Everything but the kitchen sink
@@ -134,19 +164,23 @@ This repo has a CLI tool called [Odin] in it! It is used for managing the server
### [BepInEx Support](./docs/bepinex.md)
-This repo automatically launches with the proper environment variables for BepInEx.
+This repo automatically launches with the proper environment variables for BepInEx.
However, you have to install it manually in the container due to the fact that the modding community around Valheim is still in its infancy.
[Click Here to view documentation on BepInEx Support](./docs/bepinex.md)
-
### [Webhook Support](./docs/webhooks.md)
-This repo can automatically send notifications to discord via the WEBHOOK_URL variable.
+This repo can automatically send notifications to discord via the WEBHOOK_URL variable.
Only use the documentation link below if you want advanced settings!
[Click Here to view documentation on Webhook Support](./docs/webhooks.md)
+### [How to Transfer Files](./docs/tutorials/how-to-transfer-files.md)
+
+This is a tutorial of a recommended path to transfering files. This can be done to transfer world files between hosts, transfer BepInEx configs, or even to transfer backups.
+
+[Click Here to view the tutorial of how to transfer files.](./docs/tutorials/how-to-transfer-files.md)
## Sponsors
@@ -156,51 +190,49 @@ Only use the documentation link below if you want advanced settings!
-
## Release Notifications
-If you would like to have release notifications tied into your Discord server, click here:
+If you would like to have release notifications tied into your Discord server, click here:
-**Note**: The discord is PURELY for release notifications and any + all permissions involving sending chat messages has been disabled.
+**Note**: The discord is PURELY for release notifications and any + all permissions involving sending chat messages has been disabled.
[Any support for this repository must take place on the Discussions.](https://github.com/mbround18/valheim-docker/discussions)
-
-## Versions:
+## Versions
- latest (Stable):
- [#100] Added backup feature to run based on cronjob.
- [#148] Added Mod support
- [#158] Added webhook configuration and documentation updates
- [#236] Now [publish to github registry as well](https://github.com/users/mbround18/packages/container/package/valheim)
- - [#276] Advanced mod support with auto installer
+ - [#276] Advanced mod support with auto installer
- 1.2.0 (Stable):
- Readme update to include the versions section and environment variables section.
- [#18] Changed to `root` as the default user to allow updated steams User+Group IDs.
- [#18] Fixed issue with the timezone not persisting.
- To exec into the container you now have to include the `-u|--user` argument to access steam directly. Example `docker-compose exec --user steam valheim bash`
- - There is now a `dry-run` command argument on `odin` to preview what the command would do.
+ - There is now a `dry-run` command argument on `odin` to preview what the command would do.
- You can run with `-d|--debug` to get verbose logging of what `odin` is doing.
- [#11] Added check for length of password and fail on odin install or odin stop failures.
- [#24] Added public variable to dockerfile and odin
- [#35] Fix for the server to now utilizing SIGINT `YOU WILL HAVE TO MANUALLY STOP YOUR SERVER;` use `pidof valheim_server.x86_64` to get the pid and then `kill -2 $pid` but replace pid with the pid from `pidof`
- [#53] Formatted scripts to be more useful and added timezone scheduling.
- [#77] Fix auto update not acknowledging variables and added odin to system bin.
- - [#89] Daemonized the server process by using rust specific bindings rather than dropping down to shell.
-- 1.1.1 (Stable):
- - Includes PR [#10] to fix the double world argument.
-- 1.1.0 (Stable):
+ - [#89] Daemonized the server process by using rust specific bindings rather than dropping down to shell.
+- 1.1.1 (Stable):
+ - Includes PR [#10] to fix the double world argument.
+- 1.1.0 (Stable):
- Includes a fix for [#3] and [#8].
- Improves the script interface and separation of concerns, files now have a respective code file that supports interactions for cleaner development experience.
- Docker image is cleaned up to provide a better usage experience. There is now an `AUTO_UPDATE` feature.
- Has a bug where the script has two entries for the world argument.
- 1.0.0 (Stable):
- - It works! It will start your server and stop when you shut down.
+ - It works! It will start your server and stop when you shut down.
- This supports passing in environment variables or arguments to `odin`
- - Has a bug in which it does not read passed in variables appropriately to Odin. Env variables are not impacted see [#3].
+ - Has a bug in which it does not read passed in variables appropriately to Odin. Env variables are not impacted see [#3].
[//]: <> (Github Issues below...........)
[#276]: https://github.com/mbround18/valheim-docker/pull/276
@@ -217,13 +249,12 @@ If you would like to have release notifications tied into your Discord server, c
[#11]: https://github.com/mbround18/valheim-docker/issues/11
[#10]: https://github.com/mbround18/valheim-docker/pull/10
[#8]: https://github.com/mbround18/valheim-docker/issues/8
-[#3]: https://github.com/mbround18/valheim-docker/issues/3
-
+[#3]: https://github.com/mbround18/valheim-docker/issues/3
[//]: <> (Links below...................)
[Odin]: ./docs/odin.md
[Valheim]: https://www.valheimgame.com/
-[Getting started with mods]: ./docs/getting_started_with_mods.md
-[If you need help figuring out a cron schedule click here]: https://crontab.guru/#0_1_*_*_*
+[Getting started with mods]: ./docs/getting*started_with_mods.md
+[If you need help figuring out a cron schedule click here]: https://crontab.guru/#0_1*\_\_\_\_\*
[//]: <> (Image Base Url: https://github.com/mbround18/valheim-docker/blob/main/docs/assets/name.png?raw=true)
diff --git a/docker-compose.yml b/docker-compose.yml
index c55d09eb..c229dc2c 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -6,7 +6,7 @@ services:
context: .
dockerfile: ./Dockerfile.odin
volumes:
- - odin-output:/data/odin/target/release
+ - odin-output:/data/odin/target/release
valheim:
depends_on:
- odin
@@ -26,10 +26,10 @@ services:
- "2457:2457/udp"
- "2458:2458/udp"
volumes:
- - ./tmp/saves:/home/steam/.config/unity3d/IronGate/Valheim
- - ./tmp/server:/home/steam/valheim
- - ./tmp/backups:/home/steam/backups
- - odin-output:/home/steam/.odin
+ - ./tmp/saves:/home/steam/.config/unity3d/IronGate/Valheim
+ - ./tmp/server:/home/steam/valheim
+ - ./tmp/backups:/home/steam/backups
+ - odin-output:/home/steam/.odin
volumes:
odin-output:
diff --git a/docs/assets/transfer-file-demo/install-croc.png b/docs/assets/transfer-file-demo/install-croc.png
new file mode 100644
index 00000000..b25656d4
Binary files /dev/null and b/docs/assets/transfer-file-demo/install-croc.png differ
diff --git a/docs/assets/transfer-file-demo/send-croc-success.png b/docs/assets/transfer-file-demo/send-croc-success.png
new file mode 100644
index 00000000..282c2c5c
Binary files /dev/null and b/docs/assets/transfer-file-demo/send-croc-success.png differ
diff --git a/docs/assets/transfer-file-demo/send-croc.png b/docs/assets/transfer-file-demo/send-croc.png
new file mode 100644
index 00000000..b80b2f70
Binary files /dev/null and b/docs/assets/transfer-file-demo/send-croc.png differ
diff --git a/docs/bepinex.md b/docs/bepinex.md
index b4029534..4cb7d3ef 100644
--- a/docs/bepinex.md
+++ b/docs/bepinex.md
@@ -8,55 +8,53 @@
1. Access the container as the steam user.
- ```shell
- docker-compose exec --user steam valheim bash
- ```
+ ```sh
+ docker-compose exec --user steam valheim bash
+ ```
2. Create a new folder
- ```shell
- mkdir -p ~/tmp
- ```
+ ```sh
+ mkdir -p ~/tmp
+ ```
3. Download BepInEx
- ```shell
- wget -O /home/steam/tmp/bepinex.zip https://github.com/valheimPlus/ValheimPlus/releases/download/0.9.7/UnixServer.zip
- ```
+ ```sh
+ wget -O /home/steam/tmp/bepinex.zip https://github.com/valheimPlus/ValheimPlus/releases/download/0.9.7/UnixServer.zip
+ ```
4. Extract the BepInEx zip file
- ```shell
- unzip -o /home/steam/tmp/bepinex.zip -d /home/steam/valheim
-
- ```
+ ```shell
+ unzip -o /home/steam/tmp/bepinex.zip -d /home/steam/valheim
+ ```
5. Cleanup files
- ```shell
- cd /home/steam/valheim && rm -rf /home/steam/tmp
- ```
+ ```shell
+ cd /home/steam/valheim && rm -rf /home/steam/tmp
+ ```
6. Restart your server.
-> You should see a huge disclaimer in your console about running with bepinex.
+> You should see a huge disclaimer in your console about running with bepinex.
## BepInEx/Modded Variables
> These are set automatically by [Odin] for a basic BepInEx installation;
> you DO NOT need to set these and only mess with them if you Know what you are doing.
-| Variable | Default | Required | Description |
-|-------------------------------|----------------------------------------------------------|----------|-------------|
-| LD_PRELOAD | `libdoorstop_x64.so` | TRUE | Sets which library to preload on Valheim start. |
-| LD_LIBRARY_PATH | `./linux64:/home/steam/valheim/doorstop_libs` | TRUE | Sets which library paths it should look in for preload libs. |
-| DOORSTOP_ENABLE | `TRUE` | TRUE | Enables Doorstop or not. |
-| DOORSTOP_LIB | `libdoorstop_x64.so` | TRUE | Which doorstop lib to load |
-| DOORSTOP_LIBS | `/home/steam/valheim/doorstop_libs` | TRUE | Where to look for doorstop libs. |
-| DOORSTOP_INVOKE_DLL_PATH | `/home/steam/valheim/BepInEx/core/BepInEx.Preloader.dll` | TRUE | BepInEx preload dll to load. |
-| DOORSTOP_CORLIB_OVERRIDE_PATH | `/home/steam/valheim/unstripped_corlib` | TRUE | Sets where the decompiled libraries containing base mono files are located at |
+| Variable | Default | Required | Description |
+| ----------------------------- | -------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------ |
+| LD_PRELOAD | `libdoorstop_x64.so` | TRUE | Sets which library to preload on Valheim start. |
+| LD_LIBRARY_PATH | `./linux64:/home/steam/valheim/doorstop_libs` | TRUE | Sets which library paths it should look in for preload libs. |
+| DOORSTOP_ENABLE | `TRUE` | TRUE | Enables Doorstop or not. |
+| DOORSTOP_LIB | `libdoorstop_x64.so` | TRUE | Which doorstop lib to load |
+| DOORSTOP_LIBS | `/home/steam/valheim/doorstop_libs` | TRUE | Where to look for doorstop libs. |
+| DOORSTOP_INVOKE_DLL_PATH | `/home/steam/valheim/BepInEx/core/BepInEx.Preloader.dll` | TRUE | BepInEx preload dll to load. |
+| DOORSTOP_CORLIB_OVERRIDE_PATH | `/home/steam/valheim/unstripped_corlib` | TRUE | Sets where the decompiled libraries containing base mono files are located at |
| DYLD_LIBRARY_PATH | `"/home/steam/valheim/doorstop_libs"` | TRUE | Sets the library paths. NOTE: This variable is weird and MUST have quotes around it! |
-| DYLD_INSERT_LIBRARIES | `/home/steam/valheim/doorstop_libs/libdoorstop_x64.so` | TRUE | Sets which library to load. |
+| DYLD_INSERT_LIBRARIES | `/home/steam/valheim/doorstop_libs/libdoorstop_x64.so` | TRUE | Sets which library to load. |
-
-[Odin]: ./odin.md
+[odin]: ./odin.md
diff --git a/docs/getting_started_with_mods.md b/docs/getting_started_with_mods.md
index 62a829d5..ee19516a 100644
--- a/docs/getting_started_with_mods.md
+++ b/docs/getting_started_with_mods.md
@@ -1,50 +1,50 @@
# Getting started with Mods
-> For this example we will be going over installing ValheimPlus. There is a lot of mysteries when it comes to modding but this should help you get started.
+> For this example we will be going over installing ValheimPlus. There is a lot of mysteries when it comes to modding but this should help you get started.
## Steps
1. Set the variable `TYPE` to be ONne of the following:
- | Type | What it installs |
- |-------------|------------------|
- | Vanilla | Default value and the most common installation type. This will run Valheim normally. |
- | BepInEx | This will install [BepInEx from this package](https://valheim.thunderstore.io/package/denikson/BepInExPack_Valheim/) and is purely just BepInEx with minimally needed components. |
- | BepInExFull | This will install [BepInEx Full from this package](https://valheim.thunderstore.io/package/1F31A/BepInEx_Valheim_Full/) and contains a modern set of components with some extras for expanded mod compatibility. |
- | ValheimPlus | This will install [Valheim Plus from this repository](https://github.com/valheimPlus/ValheimPlus) and included BepInEx as a basic version with the most common set of components |
+ | Type | What it installs |
+ | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+ | Vanilla | Default value and the most common installation type. This will run Valheim normally. |
+ | BepInEx | This will install [BepInEx from this package](https://valheim.thunderstore.io/package/denikson/BepInExPack_Valheim/) and is purely just BepInEx with minimally needed components. |
+ | BepInExFull | This will install [BepInEx Full from this package](https://valheim.thunderstore.io/package/1F31A/BepInEx_Valheim_Full/) and contains a modern set of components with some extras for expanded mod compatibility. |
+ | ValheimPlus | This will install [Valheim Plus from this repository](https://github.com/valheimPlus/ValheimPlus) and included BepInEx as a basic version with the most common set of components |
2. If you wish do not with to use additional mods, you can skip this step. Otherwise, in order to install additional mods you can use the `MODS` variable.
-
- Example of MODS, this example is slimmed down to go over the `TYPE` and `MODS` variable.
-
- ```yaml
- version: "3"
- services:
- valheim:
- image: mbround18/valheim:latest
- environment:
- # The Type variable is used to set which type of server you would like to run.
- - TYPE=ValheimPlus
- # The Mods variable is a comma and newline separated string.
- # It MUST be a link with a command and a new line at the end to be valid.
- - "MODS=
- https://cdn.thunderstore.io/live/repository/packages/abearcodes-SimpleRecycling-0.0.10.zip,
- https://cdn.thunderstore.io/live/repository/packages/abearcodes-CraftingWithContainers-1.0.9.zip
- "
- ```
+
+ Example of MODS, this example is slimmed down to go over the `TYPE` and `MODS` variable.
+
+ ```yaml
+ version: "3"
+ services:
+ valheim:
+ image: mbround18/valheim:latest
+ environment:
+ # The Type variable is used to set which type of server you would like to run.
+ - TYPE=ValheimPlus
+ # The Mods variable is a comma and newline separated string.
+ # It MUST be a link with a command and a new line at the end to be valid.
+ - "MODS=
+ https://cdn.thunderstore.io/live/repository/packages/abearcodes-SimpleRecycling-0.0.10.zip,
+ https://cdn.thunderstore.io/live/repository/packages/abearcodes-CraftingWithContainers-1.0.9.zip
+ "
+ ```
3. Now that you have your compose setup, run `docker-compose up`
> Odin automatically detects if you are running with BepInEx and adds the environment variables appropriately.
->
+>
> DISCLAIMER! Modding your server can cause a lot of errors.
> Please do NOT post an issue on the valheim-docker repo based on mod issues.
> By installing mods, you agree that you will do a root cause analysis to why your server is failing before you make a post.
> Modding is currently unsupported by the Valheim developers and limited support by the valheim-docker repo.
> If you have issues please contact the MOD developer FIRST based on the output logs.
-## Valheim Updated Help!!!!
+## Valheim Updated Help
-Mod development is slow, and the more mods you have the more complicated it will be to keep everything up to date.
+Mod development is slow, and the more mods you have the more complicated it will be to keep everything up to date.
It is a suggestion that you turn off the AUTO_UPDATE variable when you are using mods and refrain from updating your local client until all your mods have been updated.
-Some mods break on new updates of Valheim while others do not. Be on the look out for mod issues if you update your server.
+Some mods break on new updates of Valheim while others do not. Be on the look out for mod issues if you update your server.
diff --git a/docs/odin.md b/docs/odin.md
index 160e71ef..35fbf06b 100644
--- a/docs/odin.md
+++ b/docs/odin.md
@@ -2,16 +2,16 @@
Odin is a CLI tool utilized for installing, starting, and stopping [Valheim] servers
-#### Odin Specific Environment Variables
+## Odin Specific Environment Variables
> These are set automatically by Odin;
> you DO NOT need to set these and only mess with them if you Know what you are doing.
-| Variable | Default | Required | Description |
-|--------------------------|------------------------|----------|-------------|
-| DEBUG_MODE | `0` | FALSE | Set to `1` if you want a noisy output and to see what Odin is doing.
-| ODIN_CONFIG_FILE | `config.json` | FALSE | This file stores start parameters to restart the instance, change if you run multiple container instances on the same host |
-| ODIN_WORKING_DIR | `$PWD` | FALSE | Sets the directory you wish to run `odin` commands in and can be used to set where valheim is managed from. |
+| Variable | Default | Required | Description |
+| ---------------- | ------------- | -------- | -------------------------------------------------------------------------------------------------------------------------- |
+| DEBUG_MODE | `0` | FALSE | Set to `1` if you want a noisy output and to see what Odin is doing. |
+| ODIN_CONFIG_FILE | `config.json` | FALSE | This file stores start parameters to restart the instance, change if you run multiple container instances on the same host |
+| ODIN_WORKING_DIR | `$PWD` | FALSE | Sets the directory you wish to run `odin` commands in and can be used to set where valheim is managed from. |
## Gotchas
@@ -32,7 +32,7 @@ cargo install --git https://github.com/mbround18/valheim-docker.git --branch mai
-#### Install Valheim
+### Install Valheim
```sh
odin install
@@ -56,7 +56,6 @@ odin stop
-
### Status
#### Local Server
diff --git a/docs/releases/status_update.md b/docs/releases/status_update.md
index 9b84af66..72f7a88c 100644
--- a/docs/releases/status_update.md
+++ b/docs/releases/status_update.md
@@ -1,5 +1,4 @@
-# ❤️Status Update ❤️
-
+# ❤️Status Update ❤️
## 🆕 odin status
@@ -9,7 +8,9 @@
- Has the ability to output with JSON, see below.
### Json flag
+
Without `--json`
+
```shell
[ODIN][INFO] - Name: Creative Update
[ODIN][INFO] - Players: 0/10
@@ -20,33 +21,34 @@ Without `--json`
With `--json`
(with ValheimPlus for example)
+
```json
{
- "name":"Fancy Name",
- "version":"0.147.3@0.9.5.5",
- "players":0,
- "max_players":10,
- "map":"Fancy Name",
- "online":true,
- "bepinex":{
- "enabled":true,
- "mods":[
+ "name": "Fancy Name",
+ "version": "0.147.3@0.9.5.5",
+ "players": 0,
+ "max_players": 10,
+ "map": "Fancy Name",
+ "online": true,
+ "bepinex": {
+ "enabled": true,
+ "mods": [
{
- "name":"ValheimPlus.dll",
- "location":"/home/steam/valheim/BepInEx/plugins/ValheimPlus.dll"
+ "name": "ValheimPlus.dll",
+ "location": "/home/steam/valheim/BepInEx/plugins/ValheimPlus.dll"
}
]
},
- "jobs":[
+ "jobs": [
{
- "name":"AUTO_UPDATE",
- "enabled":false,
- "schedule":"*/5 * * * *"
+ "name": "AUTO_UPDATE",
+ "enabled": false,
+ "schedule": "*/5 * * * *"
},
{
- "name":"AUTO_BACKUP",
- "enabled":true,
- "schedule":"*/5 * * * *"
+ "name": "AUTO_BACKUP",
+ "enabled": true,
+ "schedule": "*/5 * * * *"
}
]
}
@@ -59,40 +61,39 @@ Setting the `HTTP_PORT` variable to any number will spin up a small http server
You can access it via `http://127.0.0.1:HTTP_PORT/status`.
You are responsible for putting your status endpoint behind SSL or authentication if you desire.
-
### When server is found
```json
{
- "name":"Creative Update",
- "version":"0.147.3@0.9.5.5",
- "players":0,
- "max_players":10,
- "map":"Creative Update",
- "online":true,
- "bepinex":{
- "enabled":true,
- "mods":[
+ "name": "Creative Update",
+ "version": "0.147.3@0.9.5.5",
+ "players": 0,
+ "max_players": 10,
+ "map": "Creative Update",
+ "online": true,
+ "bepinex": {
+ "enabled": true,
+ "mods": [
{
- "name":"BetterUI.dll",
- "location":"/home/steam/valheim/BepInEx/plugins/BetterUI/plugins/BetterUI/BetterUI.dll"
+ "name": "BetterUI.dll",
+ "location": "/home/steam/valheim/BepInEx/plugins/BetterUI/plugins/BetterUI/BetterUI.dll"
},
{
- "name":"ValheimPlus.dll",
- "location":"/home/steam/valheim/BepInEx/plugins/ValheimPlus.dll"
+ "name": "ValheimPlus.dll",
+ "location": "/home/steam/valheim/BepInEx/plugins/ValheimPlus.dll"
}
]
},
- "jobs":[
+ "jobs": [
{
- "name":"AUTO_UPDATE",
- "enabled":false,
- "schedule":"*/5 * * * *"
+ "name": "AUTO_UPDATE",
+ "enabled": false,
+ "schedule": "*/5 * * * *"
},
{
- "name":"AUTO_BACKUP",
- "enabled":true,
- "schedule":"*/5 * * * *"
+ "name": "AUTO_BACKUP",
+ "enabled": true,
+ "schedule": "*/5 * * * *"
}
]
}
@@ -106,20 +107,16 @@ You are responsible for putting your status endpoint behind SSL or authenticatio
```json
{
- "name":"Unknown",
- "version":"Unknown",
- "players":0,
- "max_players":0,
- "map":"Unknown",
- "online":false,
- "bepinex":{
- "enabled":false,
- "mods":[
-
- ]
+ "name": "Unknown",
+ "version": "Unknown",
+ "players": 0,
+ "max_players": 0,
+ "map": "Unknown",
+ "online": false,
+ "bepinex": {
+ "enabled": false,
+ "mods": []
},
- "jobs":[
-
- ]
+ "jobs": []
}
```
diff --git a/docs/tutorials/how-to-transfer-files.md b/docs/tutorials/how-to-transfer-files.md
new file mode 100644
index 00000000..340b84f9
--- /dev/null
+++ b/docs/tutorials/how-to-transfer-files.md
@@ -0,0 +1,50 @@
+# How To Transfer Files
+
+> For this tutorial, we will be using [schollz/croc] which is a cli tool for sending files. This is for temporary access to transfer files and if you want to do this frequently, then consider running a [file browser](https://hub.docker.com/r/hurlenko/filebrowser) sidecar container.
+
+## Setup
+
+1. Access the container via the root user.
+
+```sh
+# This can be accomplished via many methods but for this tutorial we will be using docker-compose.
+docker-compose exec valheim bash
+
+# 1. Replace valheim with the name of your container.
+# 2. This tutorial cannot account fo all the wide variety of names or methods on which the container is created.
+# 3. You just need to access the container via the root user to install croc.
+```
+
+1. Run `curl https://getcroc.schollz.com | bash` inside the `mbround18/valheim` container.
+2. Run `curl https://getcroc.schollz.com | bash` inside the destination machine. (If the destination machine is not a linux|unix based system with access to bash, please look at [schollz/croc] repo for installation instructions.)
+
+
+
+## Instructions
+
+> For this example, we will be transfering world files from one instance of `mbround18/valheim` to another `mbround18/valheim`. If you have a slightly different use case, such as transfering backups or something else, then this guide will be helpful but not match 1 to 1.
+
+1. Access the `mbround18/valheim` container A and container B as the steam user.
+
+ ```sh
+ # This can be accomplished via many methods but for this tutorial we will be using docker-compose.
+ docker-compose exec --user steam valheim bash
+
+ # Replace valheim with the name of your container.
+ # This tutorial cannot account fo all the wide variety of names or methods on which the container is created.
+ # You just need to access the container via the steam user when sending the files.
+ ```
+
+2. Stop the valheim server on both machines, `odin stop`
+3. Cd into your saves dir with `cd /home/steam/.config/unity3d/IronGate/Valheim` on both container A and container B.
+4. With croc already installed, run `croc send ./*` on container A.
+
+ 
+
+5. Once it spits out the transfer key, copy the transfer key to container B and hit the enter key.
+
+ 
+
+6. You can now safely shutdown container A and restart container B.
+
+[schollz/croc]: https://github.com/schollz/croc
diff --git a/docs/webhooks.md b/docs/webhooks.md
index 54b3bc47..e5b4d8c2 100644
--- a/docs/webhooks.md
+++ b/docs/webhooks.md
@@ -2,22 +2,19 @@
## Environment Variables
-| Variable | Default | Required | Description |
-|-------------------------------------|------------------------------------|----------|-------------|
-| WEBHOOK_URL | ` ` | FALSE | Supply this to get information regarding your server's status in a webhook or Discord notification! [Click here to learn how to get a webhook url for Discord](https://help.dashe.io/en/articles/2521940-how-to-create-a-discord-webhook-url) |
-
-
+| Variable | Default | Required | Description |
+| --------------------------------- | ---------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| WEBHOOK_URL | `` | FALSE | Supply this to get information regarding your server's status in a webhook or Discord notification! [Click here to learn how to get a webhook url for Discord](https://help.dashe.io/en/articles/2521940-how-to-create-a-discord-webhook-url) |
+| WEBHOOK_BROADCAST_MESSAGE | CHANGE_ME | TRUE | You set this. See `odin notify --help` |
+| WEBHOOK_UPDATING_MESSAGE | `Server Status: Updating` | FALSE | Set the Updating message of your server |
+| WEBHOOK_UPDATE_SUCCESSFUL_MESSAGE | `Server Status: Update Successful` | FALSE | Set the Update Successful message of your server |
+| WEBHOOK_UPDATE_FAILED_MESSAGE | `Server Status: Update Failed` | FALSE | Set the Update Failed message of your server |
+| WEBHOOK_STARTING_MESSAGE | `Server Status: Starting` | FALSE | Set the Starting message of your server |
+| WEBHOOK_START_SUCCESSFUL_MESSAGE | `Server Status: Start Successful` | FALSE | Set the Start Successful message of your server |
+| WEBHOOK_START_FAILED_MESSAGE | `Server Status: Start Failed` | FALSE | Set the Start Failed message of your server |
+| WEBHOOK_STOPPING_MESSAGE | `Server Status: Stopping` | FALSE | Set the Stopping message of your server |
+| WEBHOOK_STOP_SUCCESSFUL_MESSAGE | `Server Status: Stop Successful` | FALSE | Set the Stop Successful message of your server |
+| WEBHOOK_STOP_FAILED_MESSAGE | `Server Status: Stop Failed` | FALSE | Set the Stop Failed message of your server |
## POST Body Example
@@ -32,33 +29,31 @@
}
```
-| Key | Description |
-|-----------------|-------------|
-| `event_type.name` | Name of the event |
-| `event_type.status` | Status of the event |
-| `event_message` | A description of the event. |
-| `timestamp` | ISO8601 timestamp |
+| Key | Description |
+| ------------------- | --------------------------- |
+| `event_type.name` | Name of the event |
+| `event_type.status` | Status of the event |
+| `event_message` | A description of the event. |
+| `timestamp` | ISO8601 timestamp |
## Considerations
-- The expected HTTP codes returned from the webhook should be either 204 or 201 to be considered successful.
- - 204 is the default return http code for a webhook as it signifies the request has been processed.
- - 201 was included in case you want to stream into an endpoint for creating a resource.
- - Example 1, logging actions on the server.
- - Example 2, using json-server to debug webhooks.
-
+- The expected HTTP codes returned from the webhook should be either 204 or 201 to be considered successful.
+ - 204 is the default return http code for a webhook as it signifies the request has been processed.
+ - 201 was included in case you want to stream into an endpoint for creating a resource.
+ - Example 1, logging actions on the server.
+ - Example 2, using json-server to debug webhooks.
+
## Developing/Debugging Webhooks
1. Start json-server
-
- ```shell
- docker run --rm -p 3000:3000 vimagick/json-server -H 0.0.0.0 -p 3000 -w db.json
- ```
-
-2. Run notify against the webhook
-
- ```shell
- cargo run -- notify "Derp Testing another notification" --webhook "http://127.0.0.1:3000/posts"
- ```
+ ```shell
+ docker run --rm -p 3000:3000 vimagick/json-server -H 0.0.0.0 -p 3000 -w db.json
+ ```
+
+2. Run notify against the webhook
+ ```shell
+ cargo run -- notify "Derp Testing another notification" --webhook "http://127.0.0.1:3000/posts"
+ ```