diff options
| author | metamuffin <metamuffin@disroot.org> | 2025-04-23 10:23:48 +0200 |
|---|---|---|
| committer | metamuffin <metamuffin@disroot.org> | 2025-04-23 10:23:48 +0200 |
| commit | 808c7245e1f2c906eff53e699bbfba120fa5fb94 (patch) | |
| tree | e42d05b8e081d64d3ff8b2a74e737ac12067a175 | |
| parent | 9ca2e4e378b3189d2cfca27b1af9f3f53e0d6ddc (diff) | |
| download | jellything-808c7245e1f2c906eff53e699bbfba120fa5fb94.tar jellything-808c7245e1f2c906eff53e699bbfba120fa5fb94.tar.bz2 jellything-808c7245e1f2c906eff53e699bbfba120fa5fb94.tar.zst | |
other doc changes
| -rw-r--r-- | doc/migration.md | 4 | ||||
| -rw-r--r-- | doc/paths.md | 6 |
2 files changed, 7 insertions, 3 deletions
diff --git a/doc/migration.md b/doc/migration.md index 24728a2..000072a 100644 --- a/doc/migration.md +++ b/doc/migration.md @@ -1,5 +1,9 @@ # Migrating the Database +> [!CAUTION] +> The current architecture for saving to the database will be completely +> rewritten soon. + With some updates the database serialization for changes. This requires a migration process. You need to follow this procedure either with every update. diff --git a/doc/paths.md b/doc/paths.md index da6b763..356674c 100644 --- a/doc/paths.md +++ b/doc/paths.md @@ -1,7 +1,7 @@ # Paths - **media_path**: All your media (videos, movies, etc.) and import flags live - here. Jellything will only require read-only access to this directory. + here. Jellything will only require read 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 @@ -13,7 +13,7 @@ - `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 +- **database_path**: The database stores all imported nodes, user accounts and such. Write access required. - **temp_path**: Where to place short-lived files. Write access required. Can be in volatile memory (e.g. /tmp). @@ -21,4 +21,4 @@ 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. + Should ideally not be readable by anything else than jellything. |