From cd0761c9d1a6c65fdd795dff29c04ce4d8f2151e Mon Sep 17 00:00:00 2001 From: arnef Date: Fri, 21 Aug 2026 21:59:05 +0200 Subject: [PATCH] Remove TLS/Reverse proxy and Dependencies sections from README Both were low-value docs (TLS config is already in the Configuration reference table; Go/JS dependencies are visible in go.mod and web/package.json) that just added noise. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- README.md | 48 ------------------------------------------------ 1 file changed, 48 deletions(-) diff --git a/README.md b/README.md index 4d367c9..c6a0119 100644 --- a/README.md +++ b/README.md @@ -230,33 +230,6 @@ make web-assets # regenerate templ code + rebuild web/static/app.css and web/st --- -## TLS / Reverse proxy - -### Self-signed certificate (development) - -```bash -openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365 -nodes -``` - -Update `config.yaml`: - -```yaml -tls: - enabled: true - cert_file: cert.pem - key_file: key.pem -``` - -### Caddy reverse proxy (recommended for production) - -``` -dav.example.com { - reverse_proxy localhost:8080 -} -``` - ---- - ## Configuration reference ```yaml @@ -370,24 +343,3 @@ reviewed and tested where practical, but not every part of the codebase has been fully reviewed yet — use accordingly, especially before relying on this in security-sensitive environments. ---- - -## Dependencies - -| Package | Purpose | -|---------|---------| -| `github.com/emersion/go-webdav` | WebDAV/CalDAV/CardDAV protocol layer | -| `github.com/emersion/go-ical` | iCalendar parsing/serialisation | -| `github.com/emersion/go-vcard` | vCard parsing/serialisation | -| `golang.org/x/crypto` | bcrypt | -| `golang.org/x/net` | `golang.org/x/net/webdav` | -| `gopkg.in/yaml.v3` | YAML config parsing | -| `modernc.org/sqlite` | Pure-Go SQLite driver (shares, web UI sessions) | -| `github.com/a-h/templ` | Type-safe Go HTML templates (web UI) | - -Front-end (dev-only, not required at runtime — see [Web UI](#web-ui)): - -| Tool | Purpose | -|------|---------| -| Tailwind CSS v4 (`web/package.json`) | Utility-first CSS, compiled to `web/static/app.css` | -| [htmx](https://htmx.org/) (`web/static/htmx.min.js`, vendored) | Partial page updates without a JS framework |