improved docs and added unraid
This commit is contained in:
parent
320d94a223
commit
fd8229684c
@ -1,9 +1,6 @@
|
|||||||
!!! info "Community Contributed"
|
!!! info "Community Contributed"
|
||||||
This guide was contributed by the community and is neither officially supported, nor updated or tested.
|
This guide was contributed by the community and is neither officially supported, nor updated or tested.
|
||||||
|
|
||||||
|
|
||||||
# Kubernetes
|
|
||||||
|
|
||||||
This is a basic kubernetes setup.
|
This is a basic kubernetes setup.
|
||||||
Please note that this does not necessarily follow Kubernetes best practices and should only used as a
|
Please note that this does not necessarily follow Kubernetes best practices and should only used as a
|
||||||
basis to build your own setup from!
|
basis to build your own setup from!
|
||||||
|
59
docs/install/other.md
Normal file
59
docs/install/other.md
Normal file
@ -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(`<host>`) && PathPrefix(`/<www path>`)
|
||||||
|
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=/<sub path>
|
||||||
|
- STATIC_URL=/<www path>/static/
|
||||||
|
- MEDIA_URL=/<www path>/media/
|
||||||
|
labels:
|
||||||
|
traefik.enable: true
|
||||||
|
traefik.http.routers.recipes.rule: Host(`<host>`) && PathPrefix(`/<sub path>`)
|
||||||
|
traefik.http.routers.recipes.entrypoints: http
|
||||||
|
traefik.http.services.recipes.loadbalancer.server.port: 8080
|
||||||
|
traefik.http.services.recipes.loadbalancer.server.scheme: http
|
||||||
|
```
|
||||||
|
|
||||||
|
apache:
|
||||||
|
```
|
||||||
|
Alias /<www path>/static/ /var/www/recipes/static/
|
||||||
|
Alias /<www path>/media/ /var/www/recipes/media/
|
||||||
|
<Directory "/var/www/recipes/">
|
||||||
|
Require all granted
|
||||||
|
</Directory>
|
||||||
|
```
|
||||||
|
|
||||||
|
I used two paths `<sub path>` and `<www path>` for simplicity. In my case I have `<sub path> = recipes` and `<www path> = 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.
|
27
docs/install/unraid.md
Normal file
27
docs/install/unraid.md
Normal file
@ -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.
|
||||||
|

|
||||||
|
|
||||||
|
The default settings should by fine for most users, just be sure to enter a secret key that is randomly generated.
|
||||||
|
Then chooose apply.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
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.
|
||||||
|

|
@ -23,9 +23,11 @@ nav:
|
|||||||
- Home: 'index.md'
|
- Home: 'index.md'
|
||||||
- Installation:
|
- Installation:
|
||||||
- Docker: install/docker.md
|
- Docker: install/docker.md
|
||||||
|
- Unraid: install/unraid.md
|
||||||
- Synology: install/synology.md
|
- Synology: install/synology.md
|
||||||
- Kubernetes: install/kubernetes.md
|
- Kubernetes: install/kubernetes.md
|
||||||
- Manual: install/manual.md
|
- Manual: install/manual.md
|
||||||
|
- Other setups: install/other.md
|
||||||
- System:
|
- System:
|
||||||
- Updating: system/updating.md
|
- Updating: system/updating.md
|
||||||
- Backup: system/backup.md
|
- Backup: system/backup.md
|
Loading…
Reference in New Issue
Block a user