diff --git a/mkdocs/docs/installation/docker-for-beginners.md b/mkdocs/docs/installation/docker-for-beginners.md index a8ccc8b..efb4d1a 100644 --- a/mkdocs/docs/installation/docker-for-beginners.md +++ b/mkdocs/docs/installation/docker-for-beginners.md @@ -1,3 +1,7 @@ +--- +description: Docker and docker compose for beginners. +--- + A collection of generic knowledge about Docker targeted at beginners. These concepts do not _only_ apply to this project but this project is used as an example. ## Compose File diff --git a/mkdocs/docs/installation/env-vars.md b/mkdocs/docs/installation/env-vars.md index 1b9d297..2a0ea3d 100644 --- a/mkdocs/docs/installation/env-vars.md +++ b/mkdocs/docs/installation/env-vars.md @@ -1,3 +1,7 @@ +--- +description: Documentation for each available environment variable. +--- + # Environment Variables This is a comprehensive list of environment variables for the **Tube Archivist** container accessible to users. Unless stated otherwise, these environment variables apply to all documented installation instructions. diff --git a/mkdocs/docs/installation/podman.md b/mkdocs/docs/installation/podman.md index 429625e..cb6be9e 100644 --- a/mkdocs/docs/installation/podman.md +++ b/mkdocs/docs/installation/podman.md @@ -1,6 +1,9 @@ !!! abstract "Installation Instructions - Community Guides" These are beginner's guides/installation instructions for additional platforms generously provided by users of these platforms. When in doubt, verify the details with the [project README](https://github.com/tubearchivist/tubearchivist#installing). If you see any issues here while using these instructions, please contribute. +!!! warning "Outdated" + Please review these instructions and update it to the changes introduced in [v0.5.0](https://github.com/tubearchivist/tubearchivist/releases/tag/v0.5.0). + Podman handles container hostname resolution slightly differently than Docker, so you need to make a few changes to the `docker-compose.yml` to get up and running. ### Installation Changes from Compose Instructions diff --git a/mkdocs/docs/installation/proxmox-lxc.md b/mkdocs/docs/installation/proxmox-lxc.md index 322a540..440e4cb 100644 --- a/mkdocs/docs/installation/proxmox-lxc.md +++ b/mkdocs/docs/installation/proxmox-lxc.md @@ -1,6 +1,9 @@ !!! abstract "Installation Instructions - Community Guides" These are beginner's guides/installation instructions for additional platforms generously provided by users of these platforms. When in doubt, verify the details with the [project README](https://github.com/tubearchivist/tubearchivist#installing). If you see any issues here while using these instructions, please contribute. +!!! warning "Outdated" + Please review these instructions and update it to the changes introduced in [v0.5.0](https://github.com/tubearchivist/tubearchivist/releases/tag/v0.5.0). + # Setting up Tube Archivist with ProxMox LXC This guide assumed you know how to setup an LXC, CLI, and use "advanced" setup using tteck's easy helper scripts. This is out of scope for this project, if you need help with it reach out to me (Niicholai) in the discord and I will walk you through it. diff --git a/mkdocs/docs/installation/synology.md b/mkdocs/docs/installation/synology.md index ed9d3d2..784b446 100644 --- a/mkdocs/docs/installation/synology.md +++ b/mkdocs/docs/installation/synology.md @@ -7,6 +7,9 @@ - Workaround is to pin the Elasticsearch image to an older version, not requiring these modules: `docker.elastic.co/elasticsearch/elasticsearch:8.14.3`. - That is likely going to break in the future, as this project develops, new functionality might depend on new ES versions. +!!! warning "Outdated" + Please review these instructions and update it to the changes introduced in [v0.5.0](https://github.com/tubearchivist/tubearchivist/releases/tag/v0.5.0). + There are several different methods to install **Tube Archivist** on Synology platforms. This will focus on the available `docker` package manager implementation for Synology 7.1 and prior. !!! note diff --git a/mkdocs/docs/installation/unraid.md b/mkdocs/docs/installation/unraid.md index fbdcaa9..9e00dec 100644 --- a/mkdocs/docs/installation/unraid.md +++ b/mkdocs/docs/installation/unraid.md @@ -1,6 +1,9 @@ !!! abstract "Installation Instructions - Community Guides" These are beginner's guides/installation instructions for additional platforms generously provided by users of these platforms. When in doubt, verify the details with the [project README](https://github.com/tubearchivist/tubearchivist#installing). If you see any issues here while using these instructions, please contribute. +!!! warning "Outdated" + Please review these instructions and update it to the changes introduced in [v0.5.0](https://github.com/tubearchivist/tubearchivist/releases/tag/v0.5.0). + **Tube Archivist**, and all if it's dependencies, are located in the [community applications](https://unraid.net/community/apps?q=tubearchivist) store. The three containers you will need are as follows: - **TubeArchivist-RedisJSON**: Redis functions as a cache and temporary link between the application and the file system. Redis is used to store and display messages and configuration variables.