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/paths.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 doc/paths.md (limited to 'doc/paths.md') diff --git a/doc/paths.md b/doc/paths.md new file mode 100644 index 0000000..4bbd2ef --- /dev/null +++ b/doc/paths.md @@ -0,0 +1,26 @@ +# Paths + +- **media_path**: All your media (videos, movies, etc.) lives here. Jellything + will only require read-only access to this directory. +- **asset_path**: Static assets for the page. This includes fallback images, + fonts and the front page. Used read-only. + - `error.avif`: Used when images cant be displayed because of an error. This + image is not required to be AVIF despite the name extension. + - `fallback-.avif`: Fallback image when there is no asset available. + AVIF also not required. `` is a _node kind_ or "Person". + - `front.htm`: Contents of the front page. The typical jellything page + scaffold is placed around it. + - `logo.svg`: Logo of the platform to replace the text in the top left of + every page. + - `fonts/material-icons.woff2` Material Icons Font. Get this from online. +- **database_path**: The database stores all imported nodes, user accound and + such. Write access required. +- **library_path**: This directory structure contains instructions for importing + your media. +- **temp_path**: Where to place short-lived files. Write access required. Can be + in volatile memory (e.g. /tmp). +- **cache_path**: In here jellything will place dozens of transcoded imagery, + saved api responses and media metadata. This folder will likely be the + biggest. Write access required. +- **secrets_path**: Path to the `secrets` YAML file. Read access required. + Should ideally not be readable by anybody else than jellything. -- cgit v1.2.3-70-g09d2