aboutsummaryrefslogtreecommitdiff
path: root/doc/getting-started
diff options
context:
space:
mode:
Diffstat (limited to 'doc/getting-started')
-rw-r--r--doc/getting-started/installation.md8
-rw-r--r--doc/getting-started/launch.md9
-rw-r--r--doc/getting-started/setup.md56
3 files changed, 27 insertions, 46 deletions
diff --git a/doc/getting-started/installation.md b/doc/getting-started/installation.md
index ee59ee7..5768a0a 100644
--- a/doc/getting-started/installation.md
+++ b/doc/getting-started/installation.md
@@ -2,8 +2,8 @@
## From the AUR
-This is the recommended option. It will also install a systemd service running
-in its own user.
+This is the recommended option. It will also install a systemd service and
+system user for that service.
```sh
git clone https://aur.archlinux.org/jellything-git.git
@@ -24,8 +24,8 @@ Requirements:
- 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.
+Jellything was only tested for `x86_64-unknown-linux-gnu` and
+`aarch64-unknown-linux-gnu` targetss. Others _probably_ 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 8cabcf6..6064348 100644
--- a/doc/getting-started/launch.md
+++ b/doc/getting-started/launch.md
@@ -11,10 +11,15 @@ will start and serve your library at
```sh
jellything /etc/jellything.yaml
+# Or
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`.
+interface with the environment variables `BIND_ADDR` and `PORT`. Logging to
+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
+initial import.
diff --git a/doc/getting-started/setup.md b/doc/getting-started/setup.md
index a189cf6..d899384 100644
--- a/doc/getting-started/setup.md
+++ b/doc/getting-started/setup.md
@@ -16,7 +16,6 @@ admin_username: admin
media_path: "/srv/media"
asset_path: "/var/lib/jellything/assets"
database_path: "/var/lib/jellything/db"
-library_path: "/var/lib/jellything/library"
temp_path: "/tmp/jellything"
cache_path: "/var/cache/jellything"
secrets_path: "/etc/jellysecrets.yaml" # points to the file below
@@ -33,25 +32,25 @@ session_key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx="
# Credentials for remote instances. Keep this empty if you are just starting.
federation:
- "example.org": { username: "examplefed", password: "xxxxxxx" }
+ "example.org": { username: "examplefed", password: "xxxxxxx" }
api:
- fanart_tv: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
- tmdb: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
- omdb: xxxxxxxx
- # This is the Trakt Application `client_id`
- trakt: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
- tvdb: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+ fanart_tv: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+ tmdb: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+ omdb: xxxxxxxx
+ # This is the Trakt Application `client_id`
+ trakt: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+ tvdb: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
```
## 2. Creating required directories
-Next create directories in place of `cache_path`, `temp_path`, `media_path`,
-`library_path` if jellything is not permitted to do so itself. Also obtain the
-default assets from git.
+Next create directories in place of `cache_path`, `temp_path`, `media_path`. if
+jellything is not permitted to do so itself. Also obtain the default assets from
+the jellything-assets repo.
```sh
-mkdir -p $cache_path $temp_path $media_path $library_path
+mkdir -p $cache_path $temp_path $media_path
git clone https://codeberg.org/metamuffin/jellything-assets.git $asset_path
```
@@ -61,37 +60,14 @@ In _library\_path_, create files like below. This file provides an entry point
to your library. Its exact meaning is described in
[The Import Guide](../import/README.md).
-```yaml
-# root.yaml
-id: library
-sources:
- - !override
- public:
- kind: !collection
- title: "My Library"
- children:
- - movies
-```
-
-```yaml
-# movies/directory.yaml
-id: movies
-sources:
- - !override
- public:
- kind: !collection
- title: "Movies"
- - !auto_children
-```
-
Next place your favorite movies in _media\_path_ and use the import helper to
quickly generate import instructions for it. This requires at least Trakt and
TMDB keys to work.
```sh
-# This should be run from media_path since the path in -m is relative to that no matter PWD.
-# Jellytool will show an interactive wizard to select the correct metadata.
-jellytool add -m big-buck-bunny.mkv
-jellytool add -m agent-327-operation-barbershop.mkv
-jellytool add -m spring.mkv
+# Jellytool will show an interactive wizard to select the correct metadata source.
+# The files will be renamed to include the Trakt id in the name.
+jellytool add big-buck-bunny.mkv
+jellytool add agent-327-operation-barbershop.mkv
+jellytool add spring.mkv
```