Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a69ec23979 |
@@ -1,8 +1,8 @@
|
||||
# webhooker
|
||||
|
||||
webhooker is an MIT-licensed web service, written in [Go](https://golang.org) by
|
||||
[@sneak](https://sneak.berlin), that receives the HTTP requests other services
|
||||
send when something happens and forwards them to your own systems.
|
||||
webhooker is an MIT-licensed [Go](https://golang.org) web service by
|
||||
[@sneak](https://sneak.berlin) that receives the HTTP requests other services
|
||||
send and forwards them to your own systems.
|
||||
|
||||
Many services send an HTTP request to a URL you give them when something
|
||||
happens: a code push, a payment, a new ticket. webhooker receives those
|
||||
@@ -30,8 +30,8 @@ Five words name the moving parts.
|
||||
it. The UUID is a random 36-character identifier, and it is the only thing
|
||||
that authorises a sender.
|
||||
- A **target** is a place events are delivered to. There are four kinds: an HTTP
|
||||
URL, a Slack or Mattermost message-posting URL, an archive file, and the
|
||||
application log.
|
||||
URL, the message-posting URL of a chat service (Slack or Mattermost), an
|
||||
archive file, and the application log.
|
||||
- An **event** is one stored request: its method, query string, headers and
|
||||
body.
|
||||
- A **delivery** is one event paired with one target. It records every attempt.
|
||||
@@ -102,7 +102,7 @@ sooner after 24 hours without use, unless `SESSION_IDLE_TIMEOUT` says otherwise.
|
||||
|
||||
### Webhooks
|
||||
|
||||
**New Webhook** on the webhook list at `/hooks` asks for **Name**, an optional
|
||||
On the webhook list at `/hooks`, **New Webhook** asks for **Name**, an optional
|
||||
**Description** and **Retention (days)**. Events older than the retention period
|
||||
are deleted, along with their deliveries. The default is 30 days. `0` keeps
|
||||
events forever. The form also has an **HTTP target URL** field and an
|
||||
@@ -123,7 +123,7 @@ deactivated entrypoint answers `410 Gone`. A deleted or unknown one answers
|
||||
|
||||
### Targets
|
||||
|
||||
**Add** under **Targets** asks for the type first, then that type's settings.
|
||||
Under **Targets**, **Add** asks for the type first, then that type's settings.
|
||||
|
||||
- An `http` target posts each event to a URL, with optional **Headers** and a
|
||||
**Timeout**.
|
||||
@@ -174,19 +174,19 @@ Do not set `BIND_ADDRESS` to an empty value in a container. An empty value means
|
||||
unset, and unset falls back to `127.0.0.1`, so the container answers nothing on
|
||||
its published port.
|
||||
|
||||
The app runs as user `webhooker`. The image's start-up script,
|
||||
`deploy/docker-entrypoint.sh`, gives `DATA_DIR` and its contents to that user
|
||||
The app runs as user `webhooker`. The image's start-up script is
|
||||
`deploy/docker-entrypoint.sh`. It gives `DATA_DIR` and its contents to that user
|
||||
before the app starts. So a host directory can be mounted as it is. webhooker
|
||||
creates every SQLite file with mode `0600`.
|
||||
|
||||
### Running under upaas
|
||||
|
||||
[upaas](https://git.eeqj.de/sneak/upaas), a deployment tool, builds the image
|
||||
from this repository's `Dockerfile` and runs it. Add no port mapping, because
|
||||
upaas publishes every mapped port on all interfaces of the host. Put the app on
|
||||
your reverse proxy's Docker network instead, and mount one host directory at
|
||||
`/var/lib/webhooker`. The first-boot password goes to the container's log. Read
|
||||
it with `docker logs` and the name upaas gave the container.
|
||||
[upaas](https://git.eeqj.de/sneak/upaas) is a deployment tool. It builds the
|
||||
image from this repository's `Dockerfile` and runs it. Add no port mapping,
|
||||
because upaas publishes every mapped port on all interfaces of the host. Put the
|
||||
app on your reverse proxy's Docker network instead, and mount one host directory
|
||||
at `/var/lib/webhooker`. The first-boot password goes to the container's log.
|
||||
Read it with `docker logs` and the name upaas gave the container.
|
||||
|
||||
### Behind a reverse proxy
|
||||
|
||||
@@ -201,19 +201,22 @@ Four things must be right.
|
||||
1. **Keep the app port private.** Only the proxy may reach it: `127.0.0.1` on a
|
||||
bare host, or a port published to `127.0.0.1` for the image.
|
||||
2. **Send `X-Forwarded-Proto: https`.** This header tells webhooker the request
|
||||
arrived over TLS. It decides the `Secure` flag on cookies, and whether a form
|
||||
submission must carry a matching `Origin` or `Referer`. webhooker reads it
|
||||
from any connecting machine, so the proxy must overwrite whatever the client
|
||||
sent.
|
||||
arrived over TLS. It decides the `Secure` flag on cookies, the flag that
|
||||
makes a browser send them only over HTTPS. It also decides whether a form
|
||||
submission must carry a matching `Origin` or `Referer` header. A browser
|
||||
sends those two headers to say which site or page a request came from.
|
||||
webhooker reads `X-Forwarded-Proto` from any connecting machine, so the proxy
|
||||
must overwrite whatever the client sent.
|
||||
3. **Cover the proxy in `TRUSTED_PROXIES`.** Otherwise every client shares one
|
||||
rate-limit bucket, the count a limit keeps per client. A proxy on the host
|
||||
reaches the container from the Docker bridge address, such as `172.17.0.1`.
|
||||
The default list covers it. The list does not cover loopback, so on a bare
|
||||
host set `TRUSTED_PROXIES=127.0.0.1`.
|
||||
4. **Pass on the client's `Host` header with its port.** webhooker checks a
|
||||
form's `Origin` against the `Host` header it receives. A `Host` without the
|
||||
port makes every form submission fail with `403` on any port other than 443.
|
||||
In nginx that means `$http_host`, not `$host`.
|
||||
4. **Pass on the client's `Host` header with its port.** `Host` is the header
|
||||
that names the site the client asked for. webhooker checks a form's `Origin`
|
||||
against the `Host` header it receives. A `Host` without the port makes every
|
||||
form submission fail with `403` on any port other than `443`. For the nginx
|
||||
reverse proxy that means `$http_host`, not `$host`.
|
||||
|
||||
Protect the proxy's access log: its request paths hold the entrypoint UUIDs.
|
||||
|
||||
@@ -246,7 +249,10 @@ client first.
|
||||
HSTS is a response header that tells browsers to use HTTPS only for this
|
||||
hostname and every name under it, for `max-age` seconds. Every response carries
|
||||
it unless `HSTS_MAX_AGE` is `0`. A browser keeps the rule until `max-age` runs
|
||||
out, so serve webhooker on a hostname you will keep on HTTPS.
|
||||
out, so serve webhooker on a hostname you will keep on HTTPS. The header always
|
||||
carries `preload`. On a whole domain such as `example.com`, that lets the domain
|
||||
be added to the HTTPS-only list that browsers ship with. That listing is hard to
|
||||
undo.
|
||||
|
||||
## Recovering a lost admin password
|
||||
|
||||
@@ -282,11 +288,11 @@ All state lives in `DATA_DIR`. Back up the whole directory. It holds:
|
||||
- the files of each archive target;
|
||||
- the lock file, `webhooker.lock`, which is always empty.
|
||||
|
||||
Every database runs in WAL mode. WAL is SQLite's write-ahead log: finished
|
||||
Every database runs in WAL mode. WAL is SQLite's write-ahead log. Finished
|
||||
writes land in a `-wal` file beside the database before they reach the `.db`
|
||||
itself, and a `-shm` file beside it indexes that log. A copy of the `.db`
|
||||
without its `-wal` is missing data. A clean shutdown removes the `-wal` and
|
||||
`-shm` files; a crash leaves them, and they must be carried with the `.db`. Keep
|
||||
itself. A `-shm` file beside it indexes that log. A copy of the `.db` without
|
||||
its `-wal` is missing data. A clean shutdown removes the `-wal` and `-shm`
|
||||
files; a crash leaves them, and they must be carried with the `.db`. Keep
|
||||
`DATA_DIR` on a local disk: WAL mode is not reliable on network filesystems, and
|
||||
webhooker does not check for one.
|
||||
|
||||
@@ -302,7 +308,7 @@ done
|
||||
```
|
||||
|
||||
Each file is captured at its own instant. A webhook created during the backup
|
||||
can be in the copy of `webhooker.db` with no event database in the backup; a
|
||||
can be in the copy of `webhooker.db` with no event database in the backup. A
|
||||
restore then creates that event database empty.
|
||||
|
||||
To restore, stop the service and put back every file together, with any `-wal`
|
||||
@@ -320,11 +326,11 @@ plain text. Protect it accordingly.
|
||||
|
||||
### The entrypoint URL is the credential
|
||||
|
||||
Each entrypoint is a random version 4 UUID served at `/h/{uuid}`. Holding that
|
||||
URL is what authorises a sender. The receiver checks nothing else: no shared
|
||||
secret, no HMAC signature (a hash of the body made with a shared key), no token
|
||||
header. Signature headers a sender adds anyway are stored and forwarded as
|
||||
ordinary headers.
|
||||
Each entrypoint is a random UUID served at `/h/{uuid}`. Holding that URL is what
|
||||
authorises a sender. The receiver checks nothing else: no shared secret, no HMAC
|
||||
signature (a hash of the body made with a shared key), no token header. If a
|
||||
sender adds signature headers anyway, they are stored and forwarded as ordinary
|
||||
headers.
|
||||
|
||||
Keep the URL out of tickets, chat and screenshots. webhooker's own log never
|
||||
writes it. The reverse proxy's access log does hold it, in the request path.
|
||||
@@ -333,21 +339,26 @@ writes it. The reverse proxy's access log does hold it, in the request path.
|
||||
|
||||
- Passwords are hashed with Argon2id, a slow password hashing function.
|
||||
- Session cookies are signed, `HttpOnly` (hidden from page scripts) and
|
||||
`SameSite=Lax` (not sent with cross-site form posts). They carry `Secure` when
|
||||
the request carries `X-Forwarded-Proto: https`.
|
||||
`SameSite=Lax` (not sent with cross-site form posts). They carry `Secure`
|
||||
(sent only over HTTPS) when the request carries `X-Forwarded-Proto: https`.
|
||||
- Every form is protected against cross-site request forgery (CSRF). CSRF is
|
||||
when another site makes your browser submit a form here. Each form carries a
|
||||
token tied to a cookie, and a submission's `Origin` must name this host.
|
||||
- Form bodies are capped at 1 MB.
|
||||
- Every response carries these headers:
|
||||
- `Strict-Transport-Security`, unless `HSTS_MAX_AGE` is `0`;
|
||||
- `X-Content-Type-Options: nosniff`;
|
||||
- `X-Frame-Options: DENY`;
|
||||
- `Strict-Transport-Security`, the HSTS header, unless `HSTS_MAX_AGE` is
|
||||
`0`;
|
||||
- `X-Content-Type-Options: nosniff`, which stops the browser guessing a
|
||||
file's type;
|
||||
- `X-Frame-Options: DENY`, which stops other sites showing these pages in a
|
||||
frame;
|
||||
- a Content-Security-Policy (CSP), the header that tells the browser where
|
||||
scripts and styles may come from, set to
|
||||
`default-src 'self'; script-src 'self'; style-src 'self'`;
|
||||
- `Referrer-Policy: strict-origin-when-cross-origin`;
|
||||
- `Permissions-Policy: camera=(), microphone=(), geolocation=()`.
|
||||
- `Referrer-Policy: strict-origin-when-cross-origin`, which tells another
|
||||
site only which site a visitor came from, not which page;
|
||||
- `Permissions-Policy: camera=(), microphone=(), geolocation=()`, which
|
||||
denies the pages the camera, microphone and location.
|
||||
- `/metrics` sits behind HTTP basic authentication, a username and password sent
|
||||
with each request.
|
||||
|
||||
@@ -357,9 +368,9 @@ The password is checked first, and only a failed sign-in is counted. A correct
|
||||
password is never answered `429`. Failures are counted per client and submitted
|
||||
username. From the fifth failure within a minute, each failure is answered
|
||||
`429`. At most two password checks run at once; a request that gets no turn
|
||||
within 5 seconds is answered `503`. So those two checks, not the failure count,
|
||||
bound how fast passwords can be guessed. Choose a long random admin password, or
|
||||
rate-limit `POST /pages/login` at the reverse proxy.
|
||||
within 5 seconds is answered `503`. So guessing speed is bounded by the limit of
|
||||
two checks at a time, not by the failure count. Choose a long random admin
|
||||
password, or rate-limit `POST /pages/login` at the reverse proxy.
|
||||
|
||||
### Delivery destinations
|
||||
|
||||
@@ -367,8 +378,9 @@ A delivery target could be used to make webhooker send requests into the network
|
||||
it sits in and read the answers back. This is called server-side request forgery
|
||||
(SSRF). webhooker refuses it with the SSRF guard.
|
||||
|
||||
Every target URL must use `http` or `https` and resolve to a public address. The
|
||||
SSRF guard refuses these ranges:
|
||||
Every target URL must use `http` or `https`. By default its hostname must also
|
||||
point at a public address, one reachable from the internet. The SSRF guard
|
||||
refuses these ranges:
|
||||
|
||||
- loopback, `127.0.0.0/8` and `::1`;
|
||||
- the RFC 1918 private ranges, `10.0.0.0/8`, `172.16.0.0/12` and
|
||||
@@ -376,14 +388,16 @@ SSRF guard refuses these ranges:
|
||||
- link-local space, which is valid only on one network segment;
|
||||
- carrier-grade NAT space, which internet providers use inside their own
|
||||
networks;
|
||||
- multicast, the IPv6 unique local range, and the other reserved ranges.
|
||||
- multicast, the addresses that reach a group of hosts at once;
|
||||
- the IPv6 unique local range, `fc00::/7`, the private space of IPv6;
|
||||
- the other reserved ranges.
|
||||
|
||||
The SSRF guard runs when a target is saved and again when each delivery
|
||||
connects, so a hostname that changes its address later is still checked.
|
||||
connects. So a hostname that changes its address later is still checked.
|
||||
Redirects are followed up to ten hops, and each hop is checked. A hop to another
|
||||
host or port, or from `https` to `http`, drops every configured or forwarded
|
||||
header except `Content-Type`. So a redirect cannot pass a credential to another
|
||||
host.
|
||||
header except `Content-Type`, which names the body's format. So a redirect
|
||||
cannot pass a credential to another host.
|
||||
|
||||
Egress means the connections webhooker opens outward to deliver.
|
||||
[`ALLOWED_EGRESS_CIDRS`](#allowing-egress-to-your-own-network) lets deliveries
|
||||
@@ -401,8 +415,9 @@ The `admin` password is printed in the clear on the first boot and by
|
||||
query string, headers and body.
|
||||
|
||||
When `SENTRY_DSN` is set, error reports go to Sentry, an error reporting
|
||||
service. A report carries no query string, body or cookies. In place of the path
|
||||
it carries the route pattern, the route as registered, such as `/h/{uuid}`.
|
||||
service. A report carries no query string, body or cookies. It carries the route
|
||||
pattern in place of the path. A route pattern is the path with its variable part
|
||||
left as a name, such as `/h/{uuid}`.
|
||||
|
||||
## Design
|
||||
|
||||
@@ -411,9 +426,10 @@ sends them on in the background, and SQLite holds everything in between.
|
||||
|
||||
The receiver stores the event and one pending delivery per active target in one
|
||||
database write, then queues the deliveries. Background workers run them and
|
||||
record each attempt. At start and then every minute, a recovery routine queues
|
||||
again any delivery left `pending` or `retrying`, so a stop or a crash loses no
|
||||
delivery.
|
||||
record each attempt. At start, a recovery routine queues again every delivery
|
||||
left `pending` or `retrying`. It then runs every minute. Each run sends again a
|
||||
`retrying` delivery the engine is not working on, and a `pending` one that has
|
||||
sat untouched for 15 minutes. So a stop or a crash loses no delivery.
|
||||
|
||||
The main database holds configuration. Each webhook has its own event database,
|
||||
so writes for one webhook never wait on another webhook's database. The program
|
||||
@@ -423,10 +439,9 @@ the binary.
|
||||
|
||||
## Configuration reference
|
||||
|
||||
All configuration comes from environment variables. For development, variables
|
||||
can also go in a `.env` file in the working directory. A variable set in the
|
||||
real environment wins over the file. A `.env` file that cannot be parsed aborts
|
||||
startup.
|
||||
All configuration comes from environment variables. Variables can also go in a
|
||||
`.env` file in the working directory. A variable set in the real environment
|
||||
wins over the file. A `.env` file that cannot be parsed aborts startup.
|
||||
|
||||
A variable that is unset or empty takes its default. A variable that is set but
|
||||
cannot be parsed aborts startup with a message naming it. A Go duration is a
|
||||
@@ -440,10 +455,9 @@ is allowed. In `prod`, no CORS headers are sent.
|
||||
|
||||
### `PORT`
|
||||
|
||||
The TCP port the listener binds. Default `8080`. Docker marks the image's
|
||||
container healthy by a check every 30 seconds. The check requests port `8080`
|
||||
whatever `PORT` says, so a container started with another `PORT` reports
|
||||
unhealthy.
|
||||
The port the listener binds. Default `8080`. Docker marks the image's container
|
||||
healthy by a check every 30 seconds. The check requests port `8080` whatever
|
||||
`PORT` says, so a container started with another `PORT` reports unhealthy.
|
||||
|
||||
### `BIND_ADDRESS`
|
||||
|
||||
@@ -456,11 +470,11 @@ are refused. `0.0.0.0` listens on IPv4 only; `::` listens on IPv6 and IPv4.
|
||||
The directory for every SQLite database and the lock file. Default
|
||||
`/var/lib/webhooker`. It is created if it is missing.
|
||||
|
||||
Exactly one webhooker process may use a `DATA_DIR` at a time; two would both run
|
||||
the recovery routine and send every pending delivery twice. At startup the
|
||||
process locks `{DATA_DIR}/webhooker.lock` with `flock`, the kernel's file lock,
|
||||
and a second process pointed at the same directory exits with a message naming
|
||||
it.
|
||||
Exactly one webhooker process may use a `DATA_DIR` at a time. Two would both run
|
||||
the recovery routine and could send one delivery twice. At startup the process
|
||||
locks `{DATA_DIR}/webhooker.lock` with `flock`, the kernel's file lock. A second
|
||||
process pointed at the same directory exits with a message that names the
|
||||
directory and the lock file.
|
||||
|
||||
### `DEBUG`
|
||||
|
||||
@@ -515,11 +529,11 @@ private ranges. A set value replaces the default.
|
||||
|
||||
The list decides whose `X-Forwarded-For` header is believed. `X-Forwarded-For`
|
||||
is the header a proxy uses to pass on the address of the client it is serving.
|
||||
It is read only when the connecting machine is inside the list. `X-Real-IP` and
|
||||
`True-Client-IP` are never read. If any client can reach webhooker, or the proxy
|
||||
in front of it, from a private address, set the list to the proxy's address
|
||||
alone. Otherwise those clients can choose their own `X-Forwarded-For` and bypass
|
||||
every rate limit.
|
||||
It is read only when the connecting machine is inside the list. webhooker never
|
||||
reads `X-Real-IP` or `True-Client-IP`, two other headers with the same job. If
|
||||
any client can reach webhooker, or the proxy in front of it, from a private
|
||||
address, set the list to the proxy's address alone. Otherwise those clients can
|
||||
choose their own `X-Forwarded-For` and bypass every rate limit.
|
||||
|
||||
### Allowing egress to your own network
|
||||
|
||||
@@ -529,8 +543,8 @@ Default empty. Example: `10.0.0.0/8, 172.17.0.0/16`. When the list is set,
|
||||
startup logs it at `WARN`.
|
||||
|
||||
Anyone with the admin account can make webhooker send requests to every network
|
||||
you list, and read the responses in the event log. List the smallest blocks that
|
||||
cover your destinations, and never `0.0.0.0/0` or `::/0`.
|
||||
you list, and read the responses in **Full Event Log**. List the smallest blocks
|
||||
that cover your destinations, and never `0.0.0.0/0` or `::/0`.
|
||||
|
||||
These addresses stay blocked whatever you list. They are link-local space, the
|
||||
unspecified addresses and cloud metadata endpoints. The unspecified addresses
|
||||
@@ -555,19 +569,19 @@ default but is reopened by a list that covers it.
|
||||
|
||||
## Delivery reference
|
||||
|
||||
An `http` target posts the event body to its URL with the event's `Content-Type`
|
||||
and headers, then the target's configured **Headers**, which replace event
|
||||
headers of the same name. Every `http` and `slack` request carries
|
||||
`User-Agent: webhooker/{version}`. The **Headers** field refuses `User-Agent`. A
|
||||
`2xx` response is a success. The first 4 KiB of the response body is stored with
|
||||
the attempt. **Timeout** is at most 300 seconds, and blank means the 30 second
|
||||
default. **Pass the query string on to this target** appends the event's query
|
||||
string to the URL.
|
||||
An `http` target posts the event body to its URL. The request carries the
|
||||
event's `Content-Type` and headers. The target's configured **Headers** are
|
||||
added next and replace event headers of the same name. Every `http` and `slack`
|
||||
request carries `User-Agent: webhooker/{version}`. `User-Agent` is the header
|
||||
that names the sending program. The **Headers** field refuses `User-Agent`. A
|
||||
response with a status from 200 to 299 is a success. The first 4 KiB of the
|
||||
response body is stored with the attempt. **Timeout** is at most 300 seconds,
|
||||
and blank means the 30 second default. **Pass the query string on to this
|
||||
target** appends the event's query string to the URL.
|
||||
|
||||
A `slack` target posts a message that describes the event and shows its body in
|
||||
a code block, cut at 3500 bytes. An archive target, whose stored type is
|
||||
`database`, appends the event as a row to its own SQLite file. A `log` target
|
||||
writes the event as one `INFO` line.
|
||||
a code block, cut at 3500 bytes. An archive target appends the event as a row to
|
||||
its own SQLite file. A `log` target writes the event as one `INFO` line.
|
||||
|
||||
**Delivery attempts** is from 1 to 20. A failed attempt marks the delivery
|
||||
`retrying` and schedules the next attempt; the wait doubles each time, starting
|
||||
@@ -585,11 +599,12 @@ paused.
|
||||
An archive target writes to
|
||||
`archive-{webhook_name}-{target_name}-{target_uuid}.db` in `DATA_DIR`, the two
|
||||
names made safe for a file name. A rotation of `monthly`, `daily` or `hourly`
|
||||
starts a new file for each period, in UTC, with the period before `.db`, such as
|
||||
`-2026-10-01.db`. Rows older than the expiry are deleted on each write and by
|
||||
the archive sweep. Renaming the webhook or the target renames the files.
|
||||
**Download** on the webhook page returns the target's whole archive as one
|
||||
gzipped JSON file.
|
||||
starts a new file for each period. Periods follow UTC, the universal time that
|
||||
ignores local time zones. The period goes before `.db`, such as
|
||||
`-2026-10-01.db`. Rows older than the expiry are deleted each time a file is
|
||||
opened and by the archive sweep. Renaming the webhook or the target renames the
|
||||
files. **Download** on the webhook page returns the target's whole archive as
|
||||
one JSON file compressed with gzip.
|
||||
|
||||
## HTTP routes reference
|
||||
|
||||
@@ -613,9 +628,9 @@ gzipped JSON file.
|
||||
## Metrics reference
|
||||
|
||||
`/metrics` serves these metrics for Prometheus, the monitoring system, plus the
|
||||
Go runtime and process metrics the Prometheus library provides. Each delivery
|
||||
metric carries one label, `target_type`, which is `http`, `slack`, `database`,
|
||||
`log` or `unknown`.
|
||||
Go runtime and process metrics the Prometheus library provides. A label is a
|
||||
name and value attached to a metric. Each delivery metric carries one label,
|
||||
`target_type`, which is `http`, `slack`, `database`, `log` or `unknown`.
|
||||
|
||||
- `webhooker_events_received_total` and `webhooker_events_resubmitted_total`,
|
||||
two counters (totals that only grow) with no label;
|
||||
@@ -629,17 +644,17 @@ metric carries one label, `target_type`, which is `http`, `slack`, `database`,
|
||||
(current values) sampled every 30 seconds;
|
||||
- `webhooker_circuit_breakers_open`.
|
||||
|
||||
Two inbound HTTP metrics, `http_request_duration_seconds` and
|
||||
`http_response_size_bytes`, carry the route pattern as their `handler` label,
|
||||
never the real path. A third, `http_requests_inflight`, counts all routes
|
||||
together.
|
||||
`http_request_duration_seconds` and `http_response_size_bytes` measure inbound
|
||||
requests. Their `handler` label is the route pattern, never the real path.
|
||||
`http_requests_inflight` counts all routes together.
|
||||
|
||||
## Development
|
||||
|
||||
You need the Go version named in `go.mod`, and Docker. The tests, the linters,
|
||||
prettier and the stylesheet build run in Docker, at versions pinned (fixed to
|
||||
one exact release) in the `Dockerfile`, `package.json` and `yarn.lock`. `gofmt`
|
||||
and `goimports` run on the host.
|
||||
`prettier` and the stylesheet build run in Docker. Their versions are pinned
|
||||
(fixed to one exact release) in the `Dockerfile`, `package.json` and
|
||||
`yarn.lock`. `gofmt` runs on the host. `goimports` runs on the host too, when it
|
||||
is installed. `script/bootstrap` does not install it.
|
||||
|
||||
```bash
|
||||
make bootstrap # Install git, make, Go and the Go modules
|
||||
@@ -652,25 +667,26 @@ make build # Build bin/webhooker, version-stamped
|
||||
make docker # Build the Docker image
|
||||
```
|
||||
|
||||
Each `make` target except `build`, `run`, `dev`, `deps` and `clean` runs a
|
||||
script in `script/`, listed under [Entrypoints](#entrypoints). Every
|
||||
`docker build` in `script/` passes `--no-cache`, so a check that passes has
|
||||
really run.
|
||||
Most `make` targets run a script in `script/`, listed under
|
||||
[Entrypoints](#entrypoints). `build`, `run`, `dev`, `deps` and `clean` run their
|
||||
own commands. Every `docker build` in `script/` passes `--no-cache`, so a check
|
||||
that passes has really run.
|
||||
|
||||
The binary's version comes from `script/version`: `git describe` on the
|
||||
checkout, or `VERSION` when that is set. It is shown at
|
||||
`/.well-known/healthcheck` and in the page footer.
|
||||
|
||||
The pages use one third-party script, Alpine.js, in its CSP build
|
||||
`@alpinejs/csp`, which runs under a Content-Security-Policy that forbids `eval`.
|
||||
The npm registry is where JavaScript packages are published. The package file in
|
||||
`3p/` is byte for byte the one it publishes.
|
||||
The pages use one third-party script, Alpine.js. They load `@alpinejs/csp`, the
|
||||
version of it that works when the Content-Security-Policy forbids running text
|
||||
as code. The npm registry is where JavaScript packages are published. The
|
||||
package file in `3p/` is byte for byte the one the npm registry publishes.
|
||||
|
||||
A browser test in `internal/server` loads the pages in a headless browser, one
|
||||
without a window, under the real Content-Security-Policy. `make test` leaves it
|
||||
out; run `make test-browser` after changing `templates/` or `static/js/`.
|
||||
`static/css/tailwind.css` is generated by Tailwind and committed; `make check`
|
||||
fails when it is out of date, and `make css` regenerates it.
|
||||
`static/css/tailwind.css` is generated by Tailwind, a CSS generator, and
|
||||
committed; `make check` fails when it is out of date, and `make css` regenerates
|
||||
it.
|
||||
|
||||
## Entrypoints
|
||||
|
||||
@@ -687,22 +703,22 @@ application are under [Entrypoint URLs](#entrypoint-urls).
|
||||
- `script/test` runs the tests in Docker.
|
||||
- `script/test-browser` runs the browser test in Docker.
|
||||
- `script/lint` runs `gofmt`, `golangci-lint` and ESLint in Docker.
|
||||
- `script/fmt` formats the Go code with `gofmt` and `goimports` on the host, and
|
||||
the Markdown with prettier in Docker.
|
||||
- `script/fmt-check` fails when `gofmt` or prettier would change a file. It does
|
||||
not run `goimports`, and it writes nothing.
|
||||
- `script/fmt` formats the Go code with `gofmt` on the host and the Markdown
|
||||
with `prettier` in Docker. It also runs `goimports` when that is installed.
|
||||
- `script/fmt-check` fails when `gofmt` or `prettier` would change a file. It
|
||||
does not run `goimports`, and it writes nothing.
|
||||
- `script/css` regenerates `static/css/tailwind.css` in Docker.
|
||||
- `script/css-check` fails when `static/css/tailwind.css` is out of date.
|
||||
- `script/check` runs `script/test`, `script/lint`, `script/fmt-check` and
|
||||
`script/css-check`.
|
||||
- `script/version` prints the version to stamp into the binary.
|
||||
- `script/docker` builds the image tagged `webhooker`.
|
||||
- `script/cibuild` is what CI, the check run on every push, runs:
|
||||
- CI is the check that runs on every push. It runs `script/cibuild`:
|
||||
`script/bootstrap`, `script/check`, then the image build.
|
||||
- `script/precommit` checks that `go mod tidy` changes nothing, then runs
|
||||
`script/check`.
|
||||
- `script/install-precommit` installs the git pre-commit hook that runs
|
||||
`script/precommit`.
|
||||
- `script/install-precommit` installs the git hook that runs `script/precommit`
|
||||
before each commit.
|
||||
|
||||
## TODO
|
||||
|
||||
|
||||
Reference in New Issue
Block a user