summaryrefslogtreecommitdiff
path: root/docs/getting_started/installation
diff options
context:
space:
mode:
authorLibravatar tobi <31960611+tsmethurst@users.noreply.github.com>2024-10-13 21:51:31 +0200
committerLibravatar GitHub <noreply@github.com>2024-10-13 19:51:31 +0000
commit096767bb3b59b31106bd8fddd27e17cc234caf5a (patch)
treeb5e3d6a0fc7072d782a3a3dafb213a8ee811b668 /docs/getting_started/installation
parent[docs] fix httpsig repo typo (#3426) (diff)
downloadgotosocial-096767bb3b59b31106bd8fddd27e17cc234caf5a.tar.xz
[chore/docs] Add `/gotosocial/.cache` to Docker container, document `GTS_WAZERO_COMPILATION_CACHE` (#3425)
* [chore/docs] Add `/gotosocial/.cache` to Docker container, document `GTS_WAZERO_COMPILATION_CACHE` * update wazero artifact size guesstimate
Diffstat (limited to 'docs/getting_started/installation')
-rw-r--r--docs/getting_started/installation/container.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/getting_started/installation/container.md b/docs/getting_started/installation/container.md
index ff98c4105..58b5a810a 100644
--- a/docs/getting_started/installation/container.md
+++ b/docs/getting_started/installation/container.md
@@ -91,6 +91,32 @@ If you want to use [LetsEncrypt](../../configuration/tls.md) for TLS certificate
For help translating variable names from the config.yaml file to environment variables, refer to the [configuration section](../../configuration/index.md#environment-variables).
+### Wazero Compilation Cache (optional)
+
+On startup, GoToSocial compiles embedded WebAssembly `ffmpeg` and `ffprobe` binaries into [Wazero](https://wazero.io/)-compatible modules, which are used for media processing without requiring any external dependencies.
+
+To speed up startup time of GoToSocial, you can cache the compiled modules between restarts so that GoToSocial doesn't have to compile them on every startup from scratch.
+
+If you'd like to do this in your Docker container, first create a `.cache` directory in your working folder to store the modules:
+
+```bash
+mkdir -p ~/gotosocial/.cache
+```
+
+Then, uncomment the second volume in the docker-compose.yaml file by removing the leading `#` symbol, so that instead of
+
+```yaml
+#- ~/gotosocial/.cache:/gotosocial/.cache
+```
+
+it reads
+
+```yaml
+- ~/gotosocial/.cache:/gotosocial/.cache
+```
+
+This will instruct Docker to mount the `~/gotosocial/.cache` directory at `/gotosocial/.cache` inside the Docker container.
+
## Start GoToSocial
With those small changes out of the way, you can now start GoToSocial with the following command: