mirrors/recipes
1
0
Fork 0
mirror of https://github.com/TandoorRecipes/recipes.git synced 2025-12-31 20:00:38 -05:00
Code Issues Packages Projects Releases Wiki Activity

update documentation

Browse Source
This commit is contained in:
smilerz
2024-04-24 12:23:35 -05:00
parent e4ff6ed732
commit b83f3a291b
9 changed files with 128 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
docs/features/external_recipes.md
View File

@@ -1,6 +1,7 @@
The original intend of this application was to provide a search interface to my large collection of PDF scans of recipes.
This feature is now called External recipes.
<!-- prettier-ignore -->
!!! info
Internal recipes are stored in a structured manner inside the database. They can be displayed using the standardized
interface and support features like shopping lists, scaling and steps.
@@ -12,76 +13,87 @@ Lastly you will need to sync with the external path and import recipes you desir
## Storage
<!-- prettier-ignore -->
!!! danger
In order for this application to retrieve data from external providers it needs to store authentication information.
Please use read only/separate accounts or app passwords wherever possible.
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.
To add a new backend click on `username >> External Recipes >> Manage External Storage >> the + next to Storage Backend List`.
To add a new backend click on `username >> External Recipes >> Manage External Storage >> the + next to Storage Backend List`.
There click the plus button.
The basic configuration is the same for all providers.
The basic configuration is the same for all providers.
| Field | Value |
|----------|-------|
| Name | Your identifier for this storage source, can be everything you want. |
| Method | The desired method. |
| Field | Value |
| ------ | -------------------------------------------------------------------- |
| Name | Your identifier for this storage source, can be everything you want. |
| Method | The desired method. |
<!-- prettier-ignore -->
!!! success
Only the providers listed below are currently implemented. If you need anything else feel free to open
an issue or pull request.
### Local
<!-- prettier-ignore -->
!!! info
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 (username, password, token or URL).
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.
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.
<!-- prettier-ignore -->
!!! warning "Volume"
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.
#### 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 could choose to store external pdfs (you could of course store them anywhere, just change `./externalfiles` to your preferred location).
save the docker-compose.yml and restart your docker container.
### Dropbox
| Field | Value |
|----------|-------|
| Username | Dropbox username |
| Token | Dropbox API Token. Can be found [here](https://dropbox.github.io/dropbox-api-v2-explorer/#auth_token/from_oauth1)|
| Field | Value |
| -------- | ----------------------------------------------------------------------------------------------------------------- |
| Username | Dropbox username |
| Token | Dropbox API Token. Can be found [here](https://dropbox.github.io/dropbox-api-v2-explorer/#auth_token/from_oauth1) |
### Nextcloud
<!-- prettier-ignore -->
!!! warning "Path"
It appears that the correct webdav path varies from installation to installation (for whatever reason).
In the Nextcloud webinterface click the `Settings` button in the bottom left corner, there your WebDav Url will be displayed.
| Field | Value |
|----------|-------|
| Username | Nextcloud username |
| Password | Nextcloud app password |
| Url | Nextcloud Server URL (e.g. `https://cloud.mydomain.com`) |
| Field | Value |
| -------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| Username | Nextcloud username |
| Password | Nextcloud app password |
| 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. |
## Adding External Recipes
To add a new path from your Storage backend to the sync list, go to `username >> External Recipes` 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.
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
To sync the recipes app with the storage backends press `Sync now` under `username >> External 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`.
There you can either import all at once without modifying them or import one by one, adding tags while importing.