aboutsummaryrefslogtreecommitdiff
path: root/doc/getting-started/launch.md
diff options
context:
space:
mode:
authormetamuffin <metamuffin@disroot.org>2024-01-25 18:08:18 +0100
committermetamuffin <metamuffin@disroot.org>2024-01-25 18:08:18 +0100
commitcd6b484d24b638f08221ff1388564d8369d37126 (patch)
treeb820445c91fb811e64cffcc9aaaa35eeac588cbd /doc/getting-started/launch.md
parent9d08704069f09f185eac0b80653cc39c1335c852 (diff)
downloadjellything-cd6b484d24b638f08221ff1388564d8369d37126.tar
jellything-cd6b484d24b638f08221ff1388564d8369d37126.tar.bz2
jellything-cd6b484d24b638f08221ff1388564d8369d37126.tar.zst
add some mdbook documentation
Diffstat (limited to 'doc/getting-started/launch.md')
-rw-r--r--doc/getting-started/launch.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/getting-started/launch.md b/doc/getting-started/launch.md
new file mode 100644
index 0000000..d1d502f
--- /dev/null
+++ b/doc/getting-started/launch.md
@@ -0,0 +1,19 @@
+# Launch your Platform
+
+> [!TIP]
+> If you used the AUR package, this should be as simple as
+> `systemctl start jellything`.
+
+For other installations, run the `jellything` binary with the configuration
+file's path as its first argument or set it in `JELLYTHING_CONFIG`. Jellything
+will start and serve your library at
+[https://127.0.0.1:8080/](https://127.0.0.1:8080/)
+
+```sh
+jellything /etc/jellything.yaml
+JELLYTHING_CONFIG=/etc/jellything.yaml jellything
+```
+
+It is also advised to use jellything with a reverse proxy. Configure the network
+interface with the environment variables `BIND_ADDR` and `PORT`. Stderr logging
+can be configured with `LOG`.