Documentation

Docker Hub

The official Docker image is available on Docker Hub. You can pull the latest version and start using Redirect Manager immediately.

Architecture Overview

Redirect Manager is built with modern technologies to ensure high performance and reliability:

• •

  Runtime: Node.js 20+ with TypeScript for type safety and modern JavaScript features

• •

  Framework: Express.js for robust HTTP handling and middleware support

• •

  Database: PostgreSQL 15+ with Prisma ORM for reliable data persistence

• •

  Authentication: JWT-based authentication for secure API access

• •

  Deployment: Docker containerization for easy deployment and scaling

Request flow (redirect + proxy)

Run Redirect Manager as a small edge/proxy in front of your website. Every request hits Redirect Manager first. If a rule matches, it returns a redirect response (for example 301 or 302). If no rule matches, it can proxy/fall back to your website/SPA.

• •

  Redirect path: a rule matches → Redirect Manager returns 301/302 to the client.

• •

  Proxy/fallback path: no rule matches → Redirect Manager forwards the request to your website/SPA and returns the response.

• •

  Management: you update redirect rules via the Admin API; rules are persisted in PostgreSQL.

Docker Compose Example

The easiest way to get started is using Docker Compose. This example includes both the Redirect Manager API and PostgreSQL database.

version: '3.8'

services:
  db:
    image: postgres:15-alpine
    environment:
      POSTGRES_USER: rm_user
      POSTGRES_PASSWORD: rm_password
      POSTGRES_DB: redirect_manager
    volumes:
      - postgres_data:/var/lib/postgresql/data

  redirect-manager:
    image: andreitrukhin/redirect-manager-api:1.0.0-beta.2
    ports:
      - "8080:8080"
    environment:
      DATABASE_URL: postgresql://rm_user:rm_password@db:5432/redirect_manager?schema=public
      JWT_SECRET: your_very_secure_random_secret_at_least_16_chars
      ADMIN_USERNAME: admin
      ADMIN_PASSWORD: admin_password
      REVERSE_PROXY_TARGET_BASE_URL: https://your-main-site.com
      API_DOCS_ENABLED: true
    depends_on:
      - db

volumes:
  postgres_data:

To start the services, save the above configuration as docker-compose.yaml and run:

Environment Variables

Configure Redirect Manager using the following environment variables:

Key Features

API Endpoints

Once deployed, the following endpoints are available:

• •

  /api/v1/auth/token - Obtain JWT authentication token

• •

  /api/v1/redirects - Manage redirect rules (CRUD operations)

• •

  /api/v1/health - Health check endpoint

• •

  /api/v1/docs - Interactive API documentation (when enabled)

Quick Start Guide

curl -X POST http://localhost:8080/api/v1/auth/token \
  -H "Content-Type: application/json" \
  -d '{"username":"admin","password":"admin_password"}'

curl -X POST http://localhost:8080/api/v1/redirects \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "source": "/old-path",
    "destination": "/new-path",
    "statusCode": 301,
    "enabled": true
  }'