Getting Started
As promised in the readme, tinyauth is extremely easy to get up and running.
Installation
To get started simply add the tinyauth service next to your traefik container:
tinyauth:
container_name: tinyauth
image: ghcr.io/steveiliop56/tinyauth:latest
environment:
- SECRET=some-random-32-chars-string
- APP_URL=https://tinyauth.example.com
- USERS=your-email-password-hash
labels:
traefik.enable: true
traefik.http.routers.tinyauth.rule: Host(`tinyauth.example.com`)
traefik.http.services.tinyauth.loadbalancer.server.port: 3000
traefik.http.middlewares.tinyauth.forwardauth.address: http://tinyauth:3000/api/auth
INFO
Make sure to set the labels according to your own setup, this guide includes the most basic ones.
WARNING
Tinyauth accepts a comma separated list of email:password-hash
combinations. To generate your hash go to IT Tools and use the bcrypt module. Make sure to escape the hash by doubling every dollar sign. Example: user@example.com:$$2a$$10$$UdLYoJ5lgPsC0RKqYH/jMua7zIn0g9kPqWmhYayJYLaZQ/FTmH2/u
(email is user@example.com
and password is password
).
TIP
You can also use the Tinyauth CLI to generate your credentials. For more information check the CLI reference here.
Then for every app you want tinyauth to protect just add the following label:
traefik.http.routers.[your-router].middlewares: tinyauth
And that's it! When you try to visit an app you should be redirected to the tinyauth login page.