diff options
| author | metamuffin <metamuffin@disroot.org> | 2024-01-25 19:04:29 +0100 |
|---|---|---|
| committer | metamuffin <metamuffin@disroot.org> | 2024-01-25 19:04:29 +0100 |
| commit | 7ded0f89080275d9a59e5155e1459ad7bf28509b (patch) | |
| tree | 92cc7d92e8c1635fb2f5a4f4dab64d0ab9805a15 /doc/getting-started | |
| parent | cd6b484d24b638f08221ff1388564d8369d37126 (diff) | |
| download | jellything-7ded0f89080275d9a59e5155e1459ad7bf28509b.tar jellything-7ded0f89080275d9a59e5155e1459ad7bf28509b.tar.bz2 jellything-7ded0f89080275d9a59e5155e1459ad7bf28509b.tar.zst | |
more doc + api
Diffstat (limited to 'doc/getting-started')
| -rw-r--r-- | doc/getting-started/installation.md | 16 | ||||
| -rw-r--r-- | doc/getting-started/launch.md | 1 | ||||
| -rw-r--r-- | doc/getting-started/setup.md | 1 |
3 files changed, 17 insertions, 1 deletions
diff --git a/doc/getting-started/installation.md b/doc/getting-started/installation.md index 7496b16..ee59ee7 100644 --- a/doc/getting-started/installation.md +++ b/doc/getting-started/installation.md @@ -13,6 +13,20 @@ makepkg -si ## From source +Requirements: + +- rustup +- esbuild +- nasm +- meson +- ninja +- cmake +- dav1d +- ffmpeg (only if you use transcoding) + +Jellything was only tested on `x86_64-unknown-linux-gnu` and +`aarch64-unknown-linux-gnu`. Others _might_ work. + ```sh git clone --recursive https://codeberg.org/metamuffin/jellything.git cd jellything @@ -21,4 +35,4 @@ cargo build --release cp target/release/{jellything,jellytool} /usr/local/bin # User installation cp target/release/{jellything,jellytool} ~/.local/bin -```
\ No newline at end of file +``` diff --git a/doc/getting-started/launch.md b/doc/getting-started/launch.md index d1d502f..8cabcf6 100644 --- a/doc/getting-started/launch.md +++ b/doc/getting-started/launch.md @@ -17,3 +17,4 @@ 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`. + diff --git a/doc/getting-started/setup.md b/doc/getting-started/setup.md index 24182fc..a189cf6 100644 --- a/doc/getting-started/setup.md +++ b/doc/getting-started/setup.md @@ -10,6 +10,7 @@ First write your configuration files whereever you want. The AUR package uses hostname: example.org brand: "Jellything" slogan: "" +admin_username: admin # All of these paths can be customized. See "Paths" media_path: "/srv/media" |