mirrors/recipes
1
0
Fork 0
mirror of https://github.com/TandoorRecipes/recipes.git synced 2026-01-01 04:10:06 -05:00
Code Issues Packages Projects Releases Wiki Activity

update external_recipes.md with docker info

Browse Source 
added info on docker external recipes, as i've just followed this process myself. unsure if I needed to add the externalfiles folder to the nginx_recipes volume, but I have anyway in my personal one, and that worked.
This commit is contained in:
nough
2022-08-27 22:12:33 +01:00
committed by GitHub
parent c020bea41e
commit 7ec5646338
1 changed files with 16 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/features/external_recipes.md
View File

@@ -18,7 +18,7 @@ Lastly you will need to sync with the external path and import recipes you desir
There are better ways to do this but they are currently not implemented There are better ways to do this but they are currently not implemented
A `Storage Backend` is a remote storage location where files are **read** from. A `Storage Backend` is a remote storage location where files are **read** from.
To add a new backend click on `Storage Data` and then on `Storage Backends`. To add a new backend click on 'username' > `External Recipes` > `Manage External Storage` > the `+` next to Storage Backend List.
There click the plus button. There click the plus button.
The basic configuration is the same for all providers. The basic configuration is the same for all providers.
@@ -37,15 +37,23 @@ The basic configuration is the same for all providers.
!!! info !!! info
There is currently no way to upload files through the webinterface. This is a feature that might be added later. There is currently no way to upload files through the webinterface. This is a feature that might be added later.
The local provider does not need any configuration. The local provider does not need any configuration (username, password, token or URL).
For the monitor you will need to define a valid path on your host system. For the monitor you will need to define a valid path on your host system. (Path)
The Path depends on your setup and can be both relative and absolute. The Path depends on your setup and can be both relative and absolute.
If you use docker the default directory is `/opt/recipes/`.
!!! warning "Volume" !!! warning "Volume"
By default no data other than the mediafiles and the database is persisted. If you use the local provider By default no data other than the mediafiles and the database is persisted. If you use the local provider
make sure to mount the path you choose to monitor to your host system in order to keep it persistent. make sure to mount the path you choose to monitor to your host system in order to keep it persistent.
#### Docker
If you use docker the default directory is `/opt/recipes/`.
add
```
- ./externalfiles:/opt/recipes/externalfiles
```
to your docker-compose.yml file under the web_recipes > volumes section. This will create a folder in your docker directory named `externalfiles` under which you can store external pdfs (you could of course store them anywhere, just change `./externalfiles` to your preferred location).
save and restart your docker container.
### Dropbox ### Dropbox
| Field | Value | | Field | Value |
@@ -66,13 +74,13 @@ If you use docker the default directory is `/opt/recipes/`.
| Url | Nextcloud Server URL (e.g. `https://cloud.mydomain.com`) | | Url | Nextcloud Server URL (e.g. `https://cloud.mydomain.com`) |
| Path | (optional) webdav path (e.g. `/remote.php/dav/files/vabene1111`). If no path is supplied `/remote.php/dav/files/` plus your username will be used. | | Path | (optional) webdav path (e.g. `/remote.php/dav/files/vabene1111`). If no path is supplied `/remote.php/dav/files/` plus your username will be used. |
## Adding Synced Paths ## Adding External Recipes
To add a new path from your Storage backend to the sync list, go to `Storage Data >> Configure Sync` and To add a new path from your Storage backend to the sync list, go to `username >> External Recipes` and
select the storage backend you want to use. select the storage backend you want to use.
Then enter the path you want to monitor starting at the storage root (e.g. `/Folder/RecipesFolder`) and save it. Then enter the path you want to monitor starting at the storage root (e.g. `/Folder/RecipesFolder`, or `/opt/recipes/externalfiles' in the docker example above) and save it.
## Syncing Data ## Syncing Data
To sync the recipes app with the storage backends press `Sync now` under `Storage Data >> Configure Sync`. To sync the recipes app with the storage backends press `Sync now` under `username >> External Recipes`
## Discovered Recipes ## Discovered Recipes
All files found by the sync can be found under `Manage Data >> Discovered recipes`. All files found by the sync can be found under `Manage Data >> Discovered recipes`.