Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
afc
command
Command afc serves the AFC Aldermaston website and its JSON API.
|
Command afc serves the AFC Aldermaston website and its JSON API. |
|
checkfiles
command
Command checkfiles compares the database's file references with the file store and prints the differences: files nothing points to, and rows pointing at files that aren't there.
|
Command checkfiles compares the database's file references with the file store and prints the differences: files nothing points to, and rows pointing at files that aren't there. |
|
migrates3
command
|
|
|
offline
command
|
|
|
resetlegacypasswords
command
Command resetlegacypasswords removes the old site's unsalted SHA-512 password digests and emails each affected user a link to set a new password.
|
Command resetlegacypasswords removes the old site's unsalted SHA-512 password digests and emails each affected user a link to set a new password. |
|
internal
|
|
|
account
Package account lets a logged-in user manage their own profile photo.
|
Package account lets a logged-in user manage their own profile photo. |
|
app
Package app wires the stores, services and API handlers into one Echo server, and serves the web client.
|
Package app wires the stores, services and API handlers into one Echo server, and serves the web client. |
|
auth
Package auth owns login state: the encrypted session cookie, the route guards, password reset tokens and the login and password endpoints.
|
Package auth owns login state: the encrypted session cookie, the route guards, password reset tokens and the login and password endpoints. |
|
auth/authtest
Package authtest builds sessions and cookies for handler tests.
|
Package authtest builds sessions and cookies for handler tests. |
|
clienttelemetry
Package clienttelemetry ingests best-effort telemetry events reported by the React client (API call outcomes, unhandled errors) and re-emits them as OpenTelemetry spans so they show up alongside server-side traces.
|
Package clienttelemetry ingests best-effort telemetry events reported by the React client (API call outcomes, unhandled errors) and re-emits them as OpenTelemetry spans so they show up alongside server-side traces. |
|
docs
Package docs Code generated by swaggo/swag.
|
Package docs Code generated by swaggo/swag. |
|
emails
Package emails renders and sends the site's transactional emails.
|
Package emails renders and sends the site's transactional emails. |
|
filecheck
Package filecheck compares the database's file references with the file store, records the differences, and deletes files nothing has referenced for 30 days.
|
Package filecheck compares the database's file references with the file store, records the differences, and deletes files nothing has referenced for 30 days. |
|
files
Package files redirects to stored files by resource kind and ID, applying per-kind access rules (player photos respect the safeguarding rule).
|
Package files redirects to stored files by resource kind and ID, applying per-kind access rules (player photos respect the safeguarding rule). |
|
infrastructure/mtls
Package mtls serves the app over TLS and only accepts requests from proxies that present a client certificate issued by the internal CA.
|
Package mtls serves the app over TLS and only accepts requests from proxies that present a client certificate issued by the internal CA. |
|
infrastructure/mtls/mtlstest
Package mtlstest makes throwaway CAs and certificates for mTLS tests.
|
Package mtlstest makes throwaway CAs and certificates for mTLS tests. |
|
infrastructure/telemetry
Package telemetry wires up OpenTelemetry tracing and logging for the app.
|
Package telemetry wires up OpenTelemetry tracing and logging for the app. |
|
sanitise
Package sanitise cleans rich-text HTML submitted from the editors.
|
Package sanitise cleans rich-text HTML submitted from the editors. |
|
site
Package site serves read-only views that combine several domains: shared layout data, the home page, the contact page and the team page.
|
Package site serves read-only views that combine several domains: shared layout data, the home page, the contact page and the team page. |
|
svcerr
Package svcerr defines the typed errors services return, so the JSON API can map them to responses consistently.
|
Package svcerr defines the typed errors services return, so the JSON API can map them to responses consistently. |
|
testdb
Package testdb gives DB-backed tests a throwaway Postgres schema loaded with a synthetic fixture.
|
Package testdb gives DB-backed tests a throwaway Postgres schema loaded with a synthetic fixture. |
|
upload
Package upload validates and stores user-uploaded files in object storage.
|
Package upload validates and stores user-uploaded files in object storage. |
|
upload/uploadtest
Package uploadtest provides an in-memory upload.Storage for tests.
|
Package uploadtest provides an in-memory upload.Storage for tests. |
|
utils/squirrel
Package squirrel provides a fluent SQL generator.
|
Package squirrel provides a fluent SQL generator. |
|
visitors
Package visitors counts unique daily visitors and persists the running total in the settings table, shared across instances.
|
Package visitors counts unique daily visitors and persists the running total in the settings table, shared across instances. |
|
web
Package web holds the HTTP plumbing shared by every API handler: the JSON error envelope, request helpers, CSRF and the /api/v1 group.
|
Package web holds the HTTP plumbing shared by every API handler: the JSON error envelope, request helpers, CSRF and the /api/v1 group. |
|
web/apitest
Package apitest drives the API in handler tests the way a same-origin browser would.
|
Package apitest drives the API in handler tests the way a same-origin browser would. |
Click to show internal directories.
Click to hide internal directories.