traefik-http-api

work in process

Instalation

1. Clone repo
2. Run pnpm i
3. Copy the .env.example file and rename it to .env
4. Rename the traefikConfigTemplate.ts.example to traefikConfigTemplate.ts and change the authelia ip and you domain

Run the App

To run the app run:

pnpm run build
pnpm run start

The app will be available at you localhost port 4001

• If you get an error saying that the port is been use you can run lsof -ti :4001 | xargs kill -9 to kill the process running in that port.

Treafik setup

you need to add a http provider to your traefik static config. It looks like this:

# http API provider
http:
    endpoint: "http://localhost:4000/api/1/traefikconfig"

Change the IP address to the IP of the server running the api server.

Container options

Labels

You can set this labels in your container to overwrite default values

labels:
    - traefik.enable=true # reverse proxy the container
    - traefik.name=soemthing # router and services name
    - traefik.hostname=someApplicationName # overwrite the hostname like overwritten.domain.tld
    - traefik.webuiport=8080 # overwrite the webUI port like 192.168.1.1:8080
    - traefik.service.scheme=http # Default to http. The schema the services will use, either http/https. It will be added to the front of the url like scheme://service.yourDomain.tld 
    - traefik.service=someThingService # overwrite the service that is assigned to the router
    - traefik.http.disable=true # disable http api, useful if the container is running in the same server as traefik and you want to let the traefik docker provider handle the integration
    - traefik.middlewares=something,something,something@file,somthingelse@http # comma separated middleware, the server convert it to an array, default to auth
    - authelia_auth=false # by defaul the server add Authelia as middleware (auth), if you set the middleware label this get overwritten, this label only works when no middleware are defined in the traefik.middleware label
    - traefik.entrypoints=someEntrypoints,anotheEntrypoints # comma separated entrypoints, the server convert it to an array, default to https

Environment variables

You can set this labels in your container to overwrite default values

environment:
    - DOMAIN=domain.tld # your domain name
    - DATABASE_URL=file:./db/dev.db # database url, in future it will be use to change the current sqlite database to another database like postgres

Notes

The server that the http api provider gets the running containers from needs to have a dockersocket proxy running.