mirror of
https://github.com/TandoorRecipes/recipes.git
synced 2025-12-24 02:39:20 -05:00
60 lines
2.7 KiB
Markdown
60 lines
2.7 KiB
Markdown
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.
|
|
|
|
!!! 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.
|
|
External recipes are basically files that are displayed within the interface. The benefit is that you can quickly
|
|
import all your old recipes and convert them one by one.
|
|
|
|
To use external recipes you will first need to configure a storage source. After that a synced path can be created.
|
|
Lastly you will need to sync with the external path and import recipes you desire.
|
|
|
|
## Storage
|
|
|
|
!!! success
|
|
Currently only Nextcloud and Dropbox are supported. There are plans to add more provider
|
|
|
|
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`.
|
|
There click the plus button.
|
|
|
|
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. |
|
|
|
|
### 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)|
|
|
|
|
### Nextcloud
|
|
|
|
!!! 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`) |
|
|
| 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
|
|
To add a new path from your Storage backend to the sync list, go to `Storage Data >> Configure Sync` 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`) and save it.
|
|
|
|
## Syncing Data
|
|
To sync the recipes app with the storage backends press `Sync now` under `Storage Data >> Configure Sync`.
|
|
|
|
## 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.
|