webhippie / redirects

Simple pattern-based redirect server

Website

Our general website, nothing fancy, just a plain landing page and really nothing more than that. You can wind it at webhippie.de

Hosting

The website is hosted on Netlify, the website gets automatically updated on every push to the master branch.

Install

This website uses the Hugo static site generator. If you are planning to contribute you'll want to download and install Hugo on your local machine. The installation of Hugo is out of the scope of this document, so please take the official install instructions to get Hugo up and running.

Development

To generate the website and serve it on localhost:1313 just execute this command and stop it with Ctrl+C:

make server

When you are done with your changes just create a pull request, after merging the pull request the website will be updated automatically.

Security

If you find a security issue please contact [email protected] first.

Contributing

Fork -> Patch -> Push -> Pull Request

Authors

• Thomas Boerger

License

CC-BY-SA-4.0

Copyright

Copyright (c) 2015 Thomas Boerger <[email protected]>

redirects's Issues

Order redirects by priority

Use uuid instead of md5 hashes

Currently we are building the unique id with a md5 hash, it should be done with a uuid instead. https://github.com/satori/go.uuid seems to be a proper library

Create homebrew formula

We are refering to a homebrew formula on the readme, this should be integrated.

Initial release of basic version

Just prepared an initial basic version which could be released to the public.

Implement show sub-command

Create a valid default config

If the config file for JSON, YAML or TOML store doesn't already exist create it.

Integrate megacheck command

We should integrate https://github.com/dominikh/go-tools/tree/master/cmd/megacheck into the CI process, this can solve the call of 3 or more different tools for code linting.

Customizeable templates

It should be good to provide some template customization for the error pages. We should provide a flag to configure the path for custom files.

Evaluate infreqdb as storage

Maybe we should also integrate https://github.com/turbobytes/infreqdb as a storage backend, sounds cool for AWS deployments.

Implement JSON backend

The storage backend for JSON have to be implemented.

Correct mapping of flags to variables

Implement storage-specific Let's Encrypt cache

Currently the Let's Encrypt cache is hard-coded to certs folder within the current working directory. This should depend on the used storage driver and store the certs over there.

Implement TOML backend

The storage backend for TOML have to be implemented.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

dockerfile

docker/Dockerfile.linux.386

• i386/alpine 3.19@sha256:15c46ced65c6abed6a27472a7904b04273e9a8091a5627badd6ff016ab073171

docker/Dockerfile.linux.amd64

• alpine 3.19@sha256:6457d53fb065d6f250e1504b9bc42d5b6c65941d57532c072d929dd0628977d0

docker/Dockerfile.linux.arm

• arm32v6/alpine 3.19@sha256:b229a85166aadbde58e73e03c5e2b9737fb4642ffb2d98ba453adc90d144c1d8

docker/Dockerfile.linux.arm64

• arm64v8/alpine 3.19@sha256:a0264d60f80df12bc1e6dd98bae6c43debe6667c0ba482711f0d806493467a46

github-actions

.github/workflows/binaries.yml

• actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
• aws-actions/configure-aws-credentials v4
• actions/setup-go v5
• actionhippie/gpgsign v1
• actionhippie/calens v1
• ncipollo/release-action v1

.github/workflows/changes.yml

• actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
• actions/setup-go v5
• EndBug/add-and-commit v9

.github/workflows/docker.yml

• actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
• actions/setup-go v5
• docker/metadata-action v5
• docker/setup-qemu-action v3
• docker/setup-buildx-action v3
• docker/login-action v3
• docker/login-action v3
• docker/login-action v3
• docker/build-push-action v5
• actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
• docker/metadata-action v5
• actionhippie/manifest v1
• docker/metadata-action v5
• actionhippie/manifest v1
• docker/metadata-action v5
• actionhippie/manifest v1
• actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
• actionhippie/pushrm v1
• actionhippie/pushrm v1

.github/workflows/docs.yml

• actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
• peaceiris/actions-hugo v2
• peaceiris/actions-gh-pages v3

.github/workflows/general.yml

• actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
• actions/setup-go v5
• codacy/codacy-coverage-reporter-action v1

gomod

go.mod

• go 1.19
• github.com/BurntSushi/toml v1.3.2
• github.com/go-chi/chi/v5 v5.0.12
• github.com/jackspirou/syscerts v0.0.0-20160531025014-b68f5469dff1@b68f5469dff1
• github.com/joho/godotenv v1.5.1
• github.com/kvtools/consul v1.0.2
• github.com/kvtools/etcdv3 v1.0.2
• github.com/kvtools/valkeyrie v1.0.0
• github.com/kvtools/zookeeper v1.0.2
• github.com/oklog/run v1.1.0
• github.com/prometheus/client_golang v1.19.0
• github.com/rs/zerolog v1.32.0
• github.com/satori/go.uuid v1.2.0
• github.com/spf13/cobra v1.8.0
• github.com/spf13/viper v1.18.2
• github.com/stretchr/testify v1.9.0
• gopkg.in/yaml.v3 v3.0.1

---

• Check this box to trigger a request for Renovate to run again on this repository

Display proper 404 error page

If no source matches the requested url we have to display a proper 404 error page.

Support cert and credential auth

For the distributed storage we have to support client certificates and credentials to authenticate for write/read access.

Replace libkv by Valkeyrie

The currently used library don't get lots of updates, let's replace it by a better mantained alternative.

Properly handle storage init errors

On the storage initialization we are currently only printing errors, these errors have to be handled properly. We can not do anything if the storage fails to setup.

Write tests for redirects

As the redirects are the core of everything we need to provide some tests to make sure it works like expected.

Implement remove sub-command

Support multiple storages

It should be useful to allow multiple storages configured and used, like relying on JSON and Etcd backends. Beside that we should define a default storage.

Write tests for the storage

The storage layer is beside the redirects the most important part of the application so we should write some simple unit tests to make sure we are not breaking something.

Integrate distributed locking

For storage services like Etcd, Consul and Zookeeper we need to implement a distributed, reliable locking mechanism to prevent race conditions.

Implement update sub-command

Implement YAML backend

The storage backend for YAML have to be implemented.

Implement list sub-command

Drop Let's Encrypt

This doesn't have a bigger benefit, it just wastes the time to maintain yet.

Create a GitHub page

We should create a pretty simple GitHub page to document the functionality of redirects.

Documentation?

No documentation? URL to github.io is dead

Integrate Etcd, Consul and Zookeeper via libkv

The title tells enough, currently I started to implement JSON and YAML, but the others have to be supported as well.

Use webhippie drone instead of gitea

Currently we are using the Gitea DroneCI, but we should simply use the Webhippie DroneCI which is entirely under my control.

Implement create sub-command

Implement the redirect functionality

The title tells enough, currently there is no redirect implemented at all...

Split available storage options

To make it better configurable we should split the available options properly instead of providing 2 flags for all. For now we need these flags:

• --json
• --json-file
• --yaml
• --yaml-file

For future versions we will also add flags for certs, keys and cas required to communicate with Etcd, Consul or Zookeper.

Enable S3 uploads of releases