docs: add CalDAV calendar-sync walkthrough
All checks were successful
Mirror to GitHub / mirror (push) Successful in 3s
All checks were successful
Mirror to GitHub / mirror (push) Successful in 3s
The [calendar] config keys existed without explanation. Document enabling CalDAV sync end to end: finding the collection URL, creating an app password, the config block, and the best-effort sync behaviour. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
parent
b8993630e3
commit
03a390a1ff
1 changed files with 33 additions and 0 deletions
33
README.md
33
README.md
|
|
@ -190,8 +190,41 @@ enabled = true # set false to never call Ollama
|
|||
[reminders]
|
||||
default_morning = "08:00" # what "tomorrow morning" resolves to
|
||||
missed_grace_minutes = 60 # how long after boot to still fire a missed reminder
|
||||
|
||||
[calendar]
|
||||
enabled = false # turn on CalDAV sync (see below)
|
||||
url = "" # CalDAV calendar collection URL
|
||||
username = ""
|
||||
password = "" # app password / token recommended
|
||||
```
|
||||
|
||||
### Calendar sync (CalDAV)
|
||||
|
||||
When `[calendar].enabled = true`, reminders and dated notes are pushed to a
|
||||
CalDAV calendar as events (tracked by `caldav_uid` on each note), so they show
|
||||
up alongside the rest of your calendar.
|
||||
|
||||
1. Find your calendar's **collection URL**. It's the per-calendar CalDAV path,
|
||||
not the server root — e.g. Nextcloud:
|
||||
`https://host/remote.php/dav/calendars/<user>/<calendar-id>/`.
|
||||
2. Create an **app password** for breadpad (don't use your main password):
|
||||
Nextcloud → Settings → Security → *Devices & sessions* → "Create new app
|
||||
password". Most CalDAV servers have an equivalent.
|
||||
3. Fill in `breadpad.toml` (or BOS Settings → breadpad → Calendar):
|
||||
|
||||
```toml
|
||||
[calendar]
|
||||
enabled = true
|
||||
url = "https://host/remote.php/dav/calendars/me/breadpad/"
|
||||
username = "me"
|
||||
password = "xxxx-xxxx-xxxx-xxxx"
|
||||
```
|
||||
4. Restart breadpad. New dated/reminder notes sync up; the `caldav_uid` field
|
||||
links each note to its event so updates and deletes stay in step.
|
||||
|
||||
If the server is unreachable, breadpad logs a warning and keeps the note
|
||||
locally — sync is best-effort and never blocks capture.
|
||||
|
||||
---
|
||||
|
||||
## Usage
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue