wmantly
5139fbb79a
Prepares the docs for the public release announcement: removes obsolete/dead material, fixes drift between the API reference and the actual routes, and standardizes on the default GitHub Pages URL. - Remove Vagrant entirely: delete Vagrantfile, docs/dev_setup.md, and stale vagrant references in .gitignore/.dockerignore; rewrite openresty/README.md to describe the actual (currently unused) directory and point to ops/nginx_conf/ for the real OpenResty config. - Delete docs/Update 4.11.md (personal scratch changelog) and drop both its and dev_setup.md's references from docs/README.md's Legacy Documentation section. - Remove checkmark emoji from docs/contributing.md's PR Requirements list. - Bring the auth model docs up to date with the code: document GET /api/auth/oidc/start + /callback, the /api/permission and /api/group RBAC routers, the /api/dns/dynamic/* sub-API, and /api/api-token (self -service PATs) in both nodejs/api.md and docs/api.md; add the missing "Clear Host Cache" section; drop the invite-token/SSH-key endpoints that no longer exist in nodejs/routes/user.js; note admin-only routes. Mention OIDC/LDAP/RBAC as core features in README.md. - Keep nodejs/api.md and docs/api.md fully in sync (same body, differing only in Jekyll front matter / relative links) instead of letting them drift. - Fix Node.js version references (20.x -> 22.x) in README.md and docs/installation.md to match ops/install.sh and the Dockerfile. - Note that the manual nginx-conf/systemd install steps in README.md and docs/installation.md won't auto-track repo changes the way install.sh's symlink approach does, and recommend install.sh. - Update the stale test/unit file lists in docs/contributing.md and nodejs/test/README.md to match the actual directory contents. - Add npm run test:integration to README.md's Running Tests section. - Add nodejs/conf/, nodejs/controller/, and nodejs/migrations/ to the project structure diagrams in README.md, docs/architecture.md, and docs/contributing.md. - Standardize "CloudFlare" -> "Cloudflare" everywhere to match the actual API value in nodejs/models/dns_provider.js. - Add the missing app_auth__adminGroups row to DEPLOYMENT.md's app_* table. - Delete docs/CNAME (custom domain) so GitHub Pages serves from the default https://theta42.github.io/proxy/, matching docs/README.md. Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
40 lines
931 B
Markdown
40 lines
931 B
Markdown
# Documentation
|
|
|
|
This directory contains the GitHub Pages documentation site for the Proxy project.
|
|
|
|
**Live site:** https://theta42.github.io/proxy/
|
|
|
|
## Pages
|
|
|
|
- `index.md` - Home page with project overview
|
|
- `installation.md` - Installation and setup guide
|
|
- `api.md` - Complete API reference
|
|
- `architecture.md` - System architecture and design
|
|
- `contributing.md` - Development and contribution guide
|
|
|
|
## Local Preview
|
|
|
|
To preview the site locally:
|
|
|
|
```bash
|
|
# Install Jekyll (one-time setup)
|
|
gem install jekyll bundler
|
|
|
|
# Run local server
|
|
cd docs
|
|
jekyll serve
|
|
|
|
# View at http://localhost:4000/proxy/
|
|
```
|
|
|
|
## Theme
|
|
|
|
The site uses the Cayman theme (`jekyll-theme-cayman`). Configuration is in `_config.yml`.
|
|
|
|
## Updating Documentation
|
|
|
|
1. Edit markdown files in this directory
|
|
2. Commit and push to master branch
|
|
3. GitHub Pages automatically rebuilds (may take 1-2 minutes)
|
|
4. Changes visible at https://theta42.github.io/proxy/
|