Redirects URLs based on routes declared in a JSON file.
Intended to be used behind a reverse proxy (like Traefik), as it only handles HTTP and accepts X-Forwarded-For, X-Forwarded-Host and X-Forwarded-Proto.
CLI arguments:
| Argument | Default | Description |
|---|---|---|
--help |
Show usage. | |
--debug |
false |
Show debug messages. |
--log |
false |
Log requests. |
--endpoint |
:8080 |
The address-port endpoint to bind to. |
--route-file |
routes.json |
The path to the routes JSON config file. |
--metrics |
"" |
Metrics endpoint. Disabled if not set. Should be blocked by the upstream reverse proxy to avoid leaking it. |
Route fields:
| Field | Default | Description |
|---|---|---|
id |
(required) | A unique ID for the route. May contain only alphanumeric characters, hyphens and underscores. |
source_url |
(required) | A regex pattern to match the source URL against. See the notes below. |
destination_url |
(required) | The URL to redirect to. It may reference capture groups (()) from the source URL pattern as $1, $2 etc. to create dynamic routes. |
priority |
0 |
If multiple routes match the source URL, the one with the highest priority is chosen. |
redirect_status |
302 |
The HTTP redirect status code to use. |
Source URL pattern notes:
- It should contain the full regex-escaped URL, including the beginning and end anchors (
^and$), to prevent ambiguity. - The trailing
/is required when no path exists. - Period (
.) must be escaped as\\.. - The pattern matching is using Go's regexp package, which may have some minor dialect differences from other regexp engines.
Route file example: routes.json
See the dev/example Docker Compose file: docker-compose.yml
- Build (Go):
go build -o url-manager - Lint:
golint ./... - Build and run along Traefik (Docker Compose):
docker-compose -f dev/docker-compose.yml up --force-recreate --build
- Unit tests.