From fec0fa63b096b6cdc78b7a16ef298376290802ae Mon Sep 17 00:00:00 2001 From: Protocolbot Date: Tue, 7 Jul 2026 21:51:55 -0600 Subject: [PATCH] docs: add whitelabeling instructions to README Covers: site name/tagline (config.yaml), About page editing, Terms of Service editing, footer customization, CSS theme variables, and navigation links. --- README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) diff --git a/README.md b/README.md index a809bac..3062850 100644 --- a/README.md +++ b/README.md @@ -167,6 +167,64 @@ curl -b cookies.txt -X DELETE http://localhost:8000/api/protocols/round-robin-ch | `/api/import` | POST | Import YAML | admin | | `/api/seed` | POST | Load seed protocols | admin | +## Whitelabeling + +Protocol Droid is designed to be fully whitelabel-able. Here's how to customize it for your deployment: + +### Site name and tagline + +Edit `config.yaml` in the project root: + +```yaml +site_name: "Your Site Name" +site_tagline: "Your tagline here" +registration_enabled: true +require_approval: false +``` + +The site name appears in the browser title bar and the header breadcrumb. The tagline appears on the library page. + +### About page + +The About page is plain HTML in `frontend/index.html`, inside the `` section (look for `
`). To customize it: + +1. Edit `frontend/index.html` +2. Find the `` comment +3. Modify the text, links, and sections as needed +4. Upload the file to your server (or `git pull` if editing in the repo) + +No build step is needed — the HTML is served directly. The "Seed protocols" section at the bottom (`id="seedSection"`) is automatically shown only to admin users, so you can leave it or remove it. + +### Terms of Service + +The Terms of Service page is also plain HTML in `frontend/index.html`, inside the `` section. Edit it to match your policies. + +### Footer + +The footer is at the bottom of `frontend/index.html`, just before the closing `