diff --git a/documentation/.vitepress/config.mts b/documentation/.vitepress/config.mts index 4f1264c..f119b27 100644 --- a/documentation/.vitepress/config.mts +++ b/documentation/.vitepress/config.mts @@ -69,6 +69,7 @@ export default defineConfig({ text: "Kubernetes and Kustomize ๐ŸŒ", link: "/docs/install/kustomize", }, + { text: "Unraid ๐Ÿงก", link: "/docs/install/unraid" }, { text: "With A Reverse Proxy", diff --git a/documentation/docs/install/getting_started.md b/documentation/docs/install/getting_started.md index d8dd5f8..aa5187c 100644 --- a/documentation/docs/install/getting_started.md +++ b/documentation/docs/install/getting_started.md @@ -6,6 +6,7 @@ AdventureLog can be installed in a variety of ways. The following are the most c - [Proxmox LXC](proxmox_lxc.md) ๐Ÿง - [Synology NAS](synology_nas.md) โ˜๏ธ - [Kubernetes and Kustomize](kustomize.md) ๐ŸŒ +- [Unraid](unraid.md) ๐Ÿงก ### Other Options diff --git a/documentation/docs/install/unraid.md b/documentation/docs/install/unraid.md new file mode 100644 index 0000000..98adcfb --- /dev/null +++ b/documentation/docs/install/unraid.md @@ -0,0 +1,22 @@ +# Installation with Unraid + +AdventureLog is available in the Unraid Community Applications store. You can install it by searching for "AdventureLog" in the Community Applications store. + +Communuity Applications Page: [AdventureLog on CA Store](https://unraid.net/community/apps?q=Adventurelog) + +## Installation Configuration + +## Backend + +- Cache is only for when you have your appdata share on a cache drive +- For this example we call the container `server` so the the frntend can connect to it at `http://server:8000` although this can be named anything you like as long as the frontend is configured to connect to the correct address + +![/static/img/unraid-config-1.png](/static/img/unraid-config-1.png) + +## Frontend + +![/static/img/unraid-config-3.png](/static/img/unraid-config-3.png) + +## Database + +![/static/img/unraid-config-2.png](/static/img/unraid-config-2.png) diff --git a/documentation/docs/troubleshooting/nginx_failed.md b/documentation/docs/troubleshooting/nginx_failed.md index b133f54..72e6a94 100644 --- a/documentation/docs/troubleshooting/nginx_failed.md +++ b/documentation/docs/troubleshooting/nginx_failed.md @@ -1,5 +1,9 @@ # Troubleshooting: `Starting nginx: nginx failed!` in the Backend Container +::: tip +As of 1-10-2024, this should be resolved in the latest version of AdventureLog. If you are still experiencing this issue, please reach out to the AdventureLog community on Discord or GitHub for further assistance. +::: + The AdventureLog backend container uses a built-in Nginx container with a built-in nginx config that relies on the name `server` to be the service name of the backend container. If the Nginx service fails to start in the backend container, the whole backend service will keep restarting and fail to start. **The primary reason for this error is changing the backend service name `server` to something different** diff --git a/documentation/static/img/unraid-config-1.png b/documentation/static/img/unraid-config-1.png new file mode 100644 index 0000000..bf4f50b Binary files /dev/null and b/documentation/static/img/unraid-config-1.png differ diff --git a/documentation/static/img/unraid-config-2.png b/documentation/static/img/unraid-config-2.png new file mode 100644 index 0000000..073b5a8 Binary files /dev/null and b/documentation/static/img/unraid-config-2.png differ diff --git a/documentation/static/img/unraid-config-3.png b/documentation/static/img/unraid-config-3.png new file mode 100644 index 0000000..dd483a9 Binary files /dev/null and b/documentation/static/img/unraid-config-3.png differ