redirector/README.md
2023-07-07 08:25:39 +02:00

1 KiB

Redirector

Simple redirection service. Runs on Node and uses Hono.

Can be adapted to run on Bun, Cloudflare Workers, or any other serverless platform.

Available as a Docker image.

Usage

yarn install
REDIRECT_URL=https://nzambello.dev PERMANENT=true yarn start

Then, open http://localhost:7878/ in your browser.

open http://localhost:7878

and you will be redirected to REDIRECT_URL from your env.

Configuration

It loads configuration from environment variables:

  • REDIRECT_URL: (required) the url to redirect to
  • PERMANENT: if true, it will return a 301 status code, otherwise 302

Docker example

docker run -p 7878:7878 -e REDIRECT_URL=https://nzambello.dev -e PERMANENT=true nzambello/redirector:latest

Docker compose example

version: "3.8"

services:
  redirector:
    image: nzambello/redirector:latest
    environment:
      - REDIRECT_URL=https://nzambello.dev
      - PERMANENT=true
    ports:
      - 7878:7878