From cd6b484d24b638f08221ff1388564d8369d37126 Mon Sep 17 00:00:00 2001 From: metamuffin Date: Thu, 25 Jan 2024 18:08:18 +0100 Subject: add some mdbook documentation --- doc/getting-started/launch.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 doc/getting-started/launch.md (limited to 'doc/getting-started/launch.md') 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`. -- cgit v1.2.3-70-g09d2