aboutsummaryrefslogtreecommitdiff
path: root/doc/getting-started
diff options
context:
space:
mode:
authormetamuffin <metamuffin@disroot.org>2026-02-23 04:09:39 +0100
committermetamuffin <metamuffin@disroot.org>2026-02-23 04:09:39 +0100
commitbe7d35ccbb3449332700a0d9ccb1b055e041e401 (patch)
treef0475a748de7ccdcc29eb29a0a4e5cff4dfb96e3 /doc/getting-started
parent823c0c6b1c857da62e472a2feda167379691288f (diff)
downloadjellything-be7d35ccbb3449332700a0d9ccb1b055e041e401.tar
jellything-be7d35ccbb3449332700a0d9ccb1b055e041e401.tar.bz2
jellything-be7d35ccbb3449332700a0d9ccb1b055e041e401.tar.zst
update some book things
Diffstat (limited to 'doc/getting-started')
-rw-r--r--doc/getting-started/installation.md6
-rw-r--r--doc/getting-started/launch.md4
-rw-r--r--doc/getting-started/setup.md6
3 files changed, 10 insertions, 6 deletions
diff --git a/doc/getting-started/installation.md b/doc/getting-started/installation.md
index 5768a0a..9af212f 100644
--- a/doc/getting-started/installation.md
+++ b/doc/getting-started/installation.md
@@ -5,6 +5,10 @@
This is the recommended option. It will also install a systemd service and
system user for that service.
+```
+paru -S jellything-git
+```
+
```sh
git clone https://aur.archlinux.org/jellything-git.git
cd jellything-git
@@ -25,7 +29,7 @@ Requirements:
- ffmpeg (only if you use transcoding)
Jellything was only tested for `x86_64-unknown-linux-gnu` and
-`aarch64-unknown-linux-gnu` targetss. Others _probably_ work too.
+`aarch64-unknown-linux-gnu` platforms; others likely work too.
```sh
git clone --recursive https://codeberg.org/metamuffin/jellything.git
diff --git a/doc/getting-started/launch.md b/doc/getting-started/launch.md
index 6064348..eb918eb 100644
--- a/doc/getting-started/launch.md
+++ b/doc/getting-started/launch.md
@@ -1,4 +1,4 @@
-# Launch your Platform
+# Launch
> [!TIP]
> If you used the AUR package, this should be as simple as
@@ -21,5 +21,5 @@ stderr can be configured with the `LOG` variable and env_logger syntax.
## Initial import
-Next log in with the admin accound and visit `/admin/dashboard` to run an
+Next log in with the admin account and visit `/admin/dashboard` to run an
initial import.
diff --git a/doc/getting-started/setup.md b/doc/getting-started/setup.md
index d899384..0d5ffc6 100644
--- a/doc/getting-started/setup.md
+++ b/doc/getting-started/setup.md
@@ -1,9 +1,9 @@
# Setup
-## 1. Writing configurations
+## 1. Update config file
-First write your configuration files whereever you want. The AUR package uses
-`/etc/jellything.yaml`.
+First customize the configuration file. The AUR package uses
+`/etc/jellything.yaml`; if installed manually, the path doesn't matter.
```yaml
# This hostname must be identical to how other instances reach you.