https://github.com/webhippie/redirects
Simple pattern-based redirect server
https://github.com/webhippie/redirects
pattern redirects server webserver
Last synced: 4 months ago
JSON representation
Simple pattern-based redirect server
- Host: GitHub
- URL: https://github.com/webhippie/redirects
- Owner: webhippie
- License: apache-2.0
- Created: 2017-03-02T20:32:24.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2026-02-02T08:36:04.000Z (5 months ago)
- Last Synced: 2026-02-02T21:24:08.222Z (5 months ago)
- Topics: pattern, redirects, server, webserver
- Language: Go
- Homepage: https://webhippie.github.io/redirects/
- Size: 2.37 MB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Dco: DCO
Awesome Lists containing this project
README
# Redirects
[](https://github.com/webhippie/redirects/actions/workflows/general.yml) [](https://matrix.to/#/#webhippie:matrix.org) [](https://app.codacy.com/gh/webhippie/redirects/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [](https://pkg.go.dev/github.com/webhippie/redirects) [](https://goreportcard.com/report/github.com/webhippie/redirects) [](https://github.com/webhippie/redirects) [](https://cloudsmith.com)
Redirects is a pretty simple pattern-based redirect server. It supports
different kinds of backends to store the patterns like JSON, YAML, TOML, Etcd,
Consul and Zookeeper. We are using it mostly as a default route for our reverse
proxy like [Træfɪk](https://traefik.io/).
## Install
You can download prebuilt binaries from the [GitHub releases][releases] or from
our [download site][downloads]. Besides that we also prepared repositories for
DEB and RPM packages which can be found at [Cloudsmith][pkgrepo]. If you prefer
to use containers you could use our images published on [GHCR][ghcr],
[Docker Hub][dockerhub] or [Quay][quay]. If you need further guidance how to
install this take a look at our [documentation][docs].
Package repository hosting is graciously provided by [Cloudsmith][cloudsmith].
Cloudsmith is the only fully hosted, cloud-native, universal package management
solution, that enables your organization to create, store and share packages in
any format, to any place, with total confidence.
## Build
If you are not familiar with [Nix][nix] it is up to you to have a working
environment for Go (>= 1.24.0) as the setup won't we covered within this guide.
Please follow the official install instructions for [Go][golang]. Beside that we
are using [go-task][gotask] to define all commands to build this project.
```console
git clone https://github.com/webhippie/redirects.git
cd redirects
task build
./bin/redirects -h
```
If you got [Nix][nix] and [Direnv][direnv] configured you can simply execute
the following commands to get al dependencies including [go-task][gotask] and
the required runtimes installed. You are also able to directly use the process
manager of [devenv][devenv]:
```console
cat << EOF > .envrc
use flake . --impure --extra-experimental-features nix-command
EOF
direnv allow
```
## Development
To start developing on this project you have to execute only one command:
```console
task watch
```
The development server should be running on
[http://localhost:8080](http://localhost:8080). Generally it supports hot
reloading which means the services are automatically restarted/reloaded on code
changes.
If you got [Nix][nix] configured you can simply execute the [devenv][devenv]
command to start the server:
```console
devenv up
```
## Security
If you find a security issue please contact
[thomas@webhippie.de](mailto:thomas@webhippie.de) first.
## Contributing
Fork -> Patch -> Push -> Pull Request
## Authors
- [Thomas Boerger](https://github.com/tboerger)
## License
Apache-2.0
## Copyright
```console
Copyright (c) 2017 Thomas Boerger
```
[releases]: https://github.com/webhippie/redirects/releases
[downloads]: https://dl.webhippie.de/#redirects/
[ghcr]: https://github.com/webhippie/redirects/pkgs/container/redirects
[dockerhub]: https://hub.docker.com/r/webhippie/redirects/tags/
[quay]: https://quay.io/repository/webhippie/redirects?tab=tags
[docs]: https://webhippie.github.io/redirects/#getting-started
[nix]: https://nixos.org/
[golang]: http://golang.org/doc/install.html
[gotask]: https://taskfile.dev/installation/
[direnv]: https://direnv.net/
[devenv]: https://devenv.sh/
[pkgrepo]: https://cloudsmith.io/~webhippie/repos/general/groups/
[cloudsmith]: https://cloudsmith.com/