Archived
1
Fork 0
A highly-performant, customizable redirect server, powered by Caddy https://hub.docker.com/r/theorangeone/starfish
This repository has been archived on 2026-05-18. You can view files and clone it, but you cannot make any changes to its state, such as pushing and creating new issues, pull requests or comments.
  • Python 76.7%
  • Dockerfile 12.5%
  • Shell 10.8%
Find a file
2020-12-08 09:58:48 +00:00
.github/workflows Add CI badges 2020-03-21 13:43:46 +00:00
scripts Take input and output file as arguments 2020-03-21 12:11:26 +00:00
starfish Add a dockerfile 2020-03-21 13:40:35 +00:00
.gitignore Init project 2020-03-21 11:53:22 +00:00
dev-requirements.txt Init project 2020-03-21 11:53:22 +00:00
docker-entrypoint.sh Add a dockerfile 2020-03-21 13:40:35 +00:00
Dockerfile Convert caddy to stable and don't pin specific python version 2020-05-09 13:04:15 +01:00
LICENSE Create LICENSE 2020-12-08 09:58:48 +00:00
README.md Add CI badges 2020-03-21 13:43:46 +00:00
requirements.txt Add config parsing 2020-03-21 12:45:28 +00:00
setup.cfg Init project 2020-03-21 11:53:22 +00:00

Starfish

Docker Build

Starfish generates Caddy Caddyfile configurations based off a simple YAML file, to perform redirections.

Requirements

Install the dependencies in requirements.txt inside your environment with pip install -r requirements.txt.

You'll also need a valid redirect.yml file. An example can be found at starfish/example-redirects.yml.

Usage

The easiest way to use this is via Docker, and docker-compose:

version: "2.3"

services:
  caddy:
    image: theorangeone/starfish
    container_name: starfish
    volumes:
      - ./redirects.yml:/config/redirects.yml
    ports:
      - 80:80
    restart: unless-stopped