40 lines
1.0 KiB
Markdown
40 lines
1.0 KiB
Markdown
# MMM-NextcloudCookbook
|
|
|
|
A MagicMirror module that displays recipes from a read-only Nextcloud public
|
|
share. It includes a phone-friendly control page for choosing a recipe and
|
|
entering or leaving recipe mode.
|
|
|
|
The Nextcloud share URL is read only by `node_helper.js` from
|
|
`SECRET_NEXTCLOUD_COOKBOOK_SHARE_URL`. An optional protected-share password can
|
|
be supplied as `SECRET_NEXTCLOUD_COOKBOOK_SHARE_PASSWORD`. Neither value is sent
|
|
to the MagicMirror browser or control page.
|
|
|
|
## MagicMirror configuration
|
|
|
|
```js
|
|
{
|
|
module: "MMM-NextcloudCookbook",
|
|
position: "fullscreen_above",
|
|
config: {
|
|
controlPath: "/MMM-NextcloudCookbook/control"
|
|
}
|
|
}
|
|
```
|
|
|
|
Open the controller at:
|
|
|
|
```text
|
|
http://mirror.example.test:8080/MMM-NextcloudCookbook/control
|
|
```
|
|
|
|
The share must contain Nextcloud Cookbook recipe folders with a `recipe.json`
|
|
file in each folder. The module uses Nextcloud's token-scoped public DAV API;
|
|
protected shares authenticate as Nextcloud's `anonymous` public-share user.
|
|
|
|
## Development
|
|
|
|
```bash
|
|
npm install
|
|
npm test
|
|
```
|