Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mbround18/redirect
Simple redirection tool! Ready to use, docker capable, Kubernetes friendly, any Linux based env ready!
https://github.com/mbround18/redirect
docker docker-image easy-to-use kubernetes redirect simple
Last synced: 24 days ago
JSON representation
Simple redirection tool! Ready to use, docker capable, Kubernetes friendly, any Linux based env ready!
- Host: GitHub
- URL: https://github.com/mbround18/redirect
- Owner: mbround18
- Created: 2021-09-30T17:26:38.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-02T22:25:27.000Z (about 1 month ago)
- Last Synced: 2024-12-02T23:27:07.611Z (about 1 month ago)
- Topics: docker, docker-image, easy-to-use, kubernetes, redirect, simple
- Language: Rust
- Homepage: https://registry.hub.docker.com/repository/docker/mbround18/redirect
- Size: 8.35 MB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Redirect
Extremely lightweight redirecting agent that uses less than 5MB ram to run redirections. For an example visit [links.boop.ninja/github](https://links.boop.ninja/github)
## Usage CLI
1. Set ENV Variable `REDIRECTS`
1. Examples:
```shell
REDIRECTS="google>https://google.com|discord>https://discord.gg/d5N7JwzPgt"
```
> NOTE! both `>` and `|` are not URL safe, these are used to designate how the app breaks the variable up.
> You can include newlines in the variable to make it easier to read. If your url uses `>` or `|` please url encode it!
2. Set ENV variable `DEFAULT_ENDPOINT` to point to the url you which to direct any other traffic towards.
3. Launch the redirect agent.
## Usage Docker
```sh
docker run \
-p 8000:8000 \
-e DEFAULT_ENDPOINT="https://github.com/mbround18" \
-e REDIRECTS="google>https://google.com|discord>https://discord.gg/d5N7JwzPgt" \
mbround18/redirect:latest
```
## Usage Docker Compose
```yaml
version: "3.9" # optional since v1.27.0
services:
web:
build: .
image: mbround18/redirect:latest
environment:
- 'DEFAULT_ENDPOINT="https://github.com/mbround18"'
- 'REDIRECTS="google>https://google.com|discord>https://discord.gg/d5N7JwzPgt"'
ports:
- "8000:8000"
```
## Statistics
With about 20 routes preloaded in the environment variable, the web services consumes about 3-4 MB
Additionally, it does not even register on the cpu scale which is in millicores (the metrics tool is [Lens](https://k8slens.dev/) :P all other apps work register on the cluster ;) )
