From fd8229684c756ff01bb3760a88f53eacfa25e215 Mon Sep 17 00:00:00 2001 From: vabene1111 Date: Tue, 5 Jan 2021 23:41:15 +0100 Subject: [PATCH] improved docs and added unraid --- docs/install/kubernetes.md | 3 -- docs/install/other.md | 59 ++++++++++++++++++++++++++++++++++++++ docs/install/unraid.md | 27 +++++++++++++++++ mkdocs.yml | 2 ++ 4 files changed, 88 insertions(+), 3 deletions(-) create mode 100644 docs/install/other.md create mode 100644 docs/install/unraid.md diff --git a/docs/install/kubernetes.md b/docs/install/kubernetes.md index ce3620bc..4f29f97f 100644 --- a/docs/install/kubernetes.md +++ b/docs/install/kubernetes.md @@ -1,9 +1,6 @@ !!! info "Community Contributed" This guide was contributed by the community and is neither officially supported, nor updated or tested. - -# Kubernetes - This is a basic kubernetes setup. Please note that this does not necessarily follow Kubernetes best practices and should only used as a basis to build your own setup from! diff --git a/docs/install/other.md b/docs/install/other.md new file mode 100644 index 00000000..45b50a31 --- /dev/null +++ b/docs/install/other.md @@ -0,0 +1,59 @@ +!!! info "Community Contributed" + The examples in this section were contributed by members of the community. + This page especially contains some setups that might help you if you really want to go down a certain path but none + of the examples are supported (as i simply am not able to give you support for them). + + +## Apache + Traefik + Sub-Path + +This guide was contributes by [incaseoftrouble](https://github.com/incaseoftrouble) in [Issue #266](https://github.com/vabene1111/recipes/issues/266) + +My setup is docker-compose / traefik / apache / recipes. Swapping out apache for nginx should be straightforward. + +Relevant parts: + +docker-compose: +```yaml + apache: + # omitting other config + volumes: + - ./recipes/static:/var/www/recipes/static:ro + - ./recipes/media:/var/www/recipes/media:ro + labels: + traefik.enable: true + traefik.http.routers.apache-recipes.rule: Host(``) && PathPrefix(`/`) + traefik.http.routers.apache-recipes.entrypoints: http + traefik.http.routers.apache-recipes.service: apache + traefik.http.services.apache.loadbalancer.server.port: 80 + traefik.http.services.apache.loadbalancer.server.scheme: http +... + + recipes: + volumes: + - ./recipes/static:/opt/recipes/staticfiles:rw + - ./recipes/media:/opt/recipes/mediafiles:rw + environment: + # all the other env + - SCRIPT_NAME=/ + - STATIC_URL=//static/ + - MEDIA_URL=//media/ + labels: + traefik.enable: true + traefik.http.routers.recipes.rule: Host(``) && PathPrefix(`/`) + traefik.http.routers.recipes.entrypoints: http + traefik.http.services.recipes.loadbalancer.server.port: 8080 + traefik.http.services.recipes.loadbalancer.server.scheme: http +``` + +apache: +``` + Alias //static/ /var/www/recipes/static/ + Alias //media/ /var/www/recipes/media/ + + Require all granted + +``` + +I used two paths `` and `` for simplicity. In my case I have ` = recipes` and ` = serve/recipes`. One could also change the matching rules of traefik to have everything under one path. + +I left out the TLS config in this example for simplicty. \ No newline at end of file diff --git a/docs/install/unraid.md b/docs/install/unraid.md new file mode 100644 index 00000000..daf3de17 --- /dev/null +++ b/docs/install/unraid.md @@ -0,0 +1,27 @@ +!!! info "Community Contributed" + This guide was contributed by the community and is neither officially supported, nor updated or tested. + +[Unraid](https://unraid.net/) is an operating system that allows you to easily install and setup applications. + +Thanks to [CorneliousJD](https://github.com/CorneliousJD) this application can easily be installed using unraid. +Please view [Issue #184](https://github.com/vabene1111/recipes/issues/184) for further details. +There is [also a discussion thread](https://forums.unraid.net/topic/98179-support-recipes-corneliousjd-repo/) on the +unraid forum where he gives additional information. + +## Installation + +Recipes for unRAID is avialble via Community Applications. +You will first need to install Community Applications (CA) by following the directions here: +https://forums.unraid.net/topic/38582-plug-in-community-applications/ + +After that, you can go to the "Apps" tab in unRAID and search for Recipes and locate the Recipes container and install it. +![image](https://user-images.githubusercontent.com/724777/97094837-bc616580-1626-11eb-9ec1-79ff034fe8d4.png) + +The default settings should by fine for most users, just be sure to enter a secret key that is randomly generated. +Then chooose apply. + +![image](https://user-images.githubusercontent.com/724777/97094856-f3377b80-1626-11eb-98d5-e4b871a420f0.png) + +After the container installs, click on the Recipes icon and click the WebUI button to launch the web user interface. +Set the container to auto-start if you wish. +![image](https://user-images.githubusercontent.com/724777/97094892-4c9faa80-1627-11eb-9eae-d32d0f35b36f.png) diff --git a/mkdocs.yml b/mkdocs.yml index 52750a65..0bf24305 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -23,9 +23,11 @@ nav: - Home: 'index.md' - Installation: - Docker: install/docker.md + - Unraid: install/unraid.md - Synology: install/synology.md - Kubernetes: install/kubernetes.md - Manual: install/manual.md + - Other setups: install/other.md - System: - Updating: system/updating.md - Backup: system/backup.md \ No newline at end of file