README.md

prem-gateway

prem-gateway is an API gateway designed to handle and manage various operations, directing requests from prem-app to either prem-daemon for Docker image management or directly to Docker images that provide prem-services.

Table of Contents

• Features
• Services
• Usage
  • Setup
  • Start/Stop
  • Production
  • Service Management
• License

Features

• API Gateway
• Domain Management
• TLS
• (More features like Authentication/Authorization, Rate Limiting, Logging, and Metrics to be added soon.)

Services

• dnsd - Read More
• authd - Read More
• controllerd - Read More

Usage

Setup

Create a Docker network:

docker network create prem-gateway

Set file permission:

chmod 600 ./traefik/letsencrypt/acme.json

Start/Stop

Start the prem-gateway:

make up

To stop the gateway:

make down

Production

For production environments, use the Let's Encrypt production server:

make up LETSENCRYPT_PROD=true

Service Management

To restart services and assign them with a subdomain/TLS certificate:

make up LETSENCRYPT_PROD=true SERVICES=premd,premapp

Run prem-gateway with prem-app and prem-daemon:

make runall PREMD_IMAGE={IMG} PREMAPP_IMAGE={IMG}

Stop prem-gateway, prem-app, and prem-daemon:

make stopall PREMD_IMAGE={IMG} PREMAPP_IMAGE={IMG}

License

prem-gateway is licensed under MIT License.

---

Feel free to adapt this template to better fit the specifics and personality of your project!