Documentation
¶
Overview ¶
Package shared is the parent of the packages that the frontend and the backend have in common. It holds no code itself; see boundary_test.go for the rules.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package apiclient is how the frontend process talks to the backend process.
|
Package apiclient is how the frontend process talks to the backend process. |
|
Package bodyapi is the contract between the main backend and the body service, the part that holds a user's scale readings and DEXA scans and computes their estimates.
|
Package bodyapi is the contract between the main backend and the body service, the part that holds a user's scale readings and DEXA scans and computes their estimates. |
|
Package edge holds the HTTP edge code shared by the frontend and the backend process: working out who the visitor is behind a reverse proxy, the PROXY protocol, and request limiting.
|
Package edge holds the HTTP edge code shared by the frontend and the backend process: working out who the visitor is behind a reverse proxy, the PROXY protocol, and request limiting. |
|
Package inproc is an http.RoundTripper that runs a request against an http.Handler in the same process.
|
Package inproc is an http.RoundTripper that runs a request against an http.Handler in the same process. |
|
Package jobs tracks the background jobs of one half of the application.
|
Package jobs tracks the background jobs of one half of the application. |
|
Package mtls secures the link between the web (frontend) and api (backend) processes with mutual TLS: the backend only talks to a client that presents a certificate from the configured CA, and the frontend only talks to a backend that presents one.
|
Package mtls secures the link between the web (frontend) and api (backend) processes with mutual TLS: the backend only talks to a client that presents a certificate from the configured CA, and the frontend only talks to a backend that presents one. |
|
Package must turns an error that cannot happen into a panic, so that a caller does not carry a branch no test can reach.
|
Package must turns an error that cannot happen into a panic, so that a caller does not carry a branch no test can reach. |
|
Package netguard keeps the backend's own outgoing connections (to an administrator's sign-in providers and mail server) away from addresses that a typo or a hostile setting must not be able to reach: the cloud metadata services and the other addresses on a link, and, unless an administrator allows it, the private networks the server sits in.
|
Package netguard keeps the backend's own outgoing connections (to an administrator's sign-in providers and mail server) away from addresses that a typo or a hostile setting must not be able to reach: the cloud metadata services and the other addresses on a link, and, unless an administrator allows it, the private networks the server sits in. |
|
Package timezones lists the common IANA time zones and validates a name.
|
Package timezones lists the common IANA time zones and validates a name. |
|
Package tlsutil checks PEM certificates; the frontend serves them and the backend stores them.
|
Package tlsutil checks PEM certificates; the frontend serves them and the backend stores them. |
|
Package workerapi is the contract between the backend and the workers: processes that talk to outside services (Withings, Strength Level, ...) for the backend and have no database.
|
Package workerapi is the contract between the backend and the workers: processes that talk to outside services (Withings, Strength Level, ...) for the backend and have no database. |
Click to show internal directories.
Click to hide internal directories.