mirror of
https://github.com/steveiliop56/tinyauth.git
synced 2025-10-31 06:05:43 +00:00
37 lines
2.0 KiB
Markdown
37 lines
2.0 KiB
Markdown
# Tinyauth - The simplest way to protect your apps with a login screen
|
|
|
|
Tinyauth is an extremely simple traefik middleware that adds a login screen to all of your apps that are using the traefik reverse proxy. Tinyauth is configurable through environment variables and it is only 20MB in size.
|
|
|
|
## Getting started
|
|
|
|
Tinyauth is extremely easy to run since it's shipped as a docker container. The guide on how to get started is available on the website [here](https://tinyauth.doesmycode.work/).
|
|
|
|
## FAQ
|
|
|
|
### Why?
|
|
|
|
Why make this project? Well, we all know that more powerful alternatives like authentik and authelia exist, but when I tried to use them, I felt overwhelmed with all the configration options and environment variables I had to configure in order for them to work. So, I decided to make a small alternative in Go to both test my skills and cover my simple login screen needs.
|
|
|
|
### Is this secure?
|
|
|
|
Probably, the sessions are managed with the gin sessions package so it should be very secure. It is definitely not made for production but it could easily serve as a simple login screen to all of your homelab apps.
|
|
|
|
### Do I need to login every time?
|
|
|
|
No, when you login, tinyauth sets a `tinyauth` cookie in your browser that applies to all of the subdomains of your domain.
|
|
|
|
## License
|
|
|
|
Tinyauth is licensed under the GNU General Public License v3.0. TL;DR — You may copy, distribute and modify the software as long as you track changes/dates in source files. Any modifications to or software including (via compiler) GPL-licensed code must also be made available under the GPL along with build & install instructions.
|
|
|
|
## Contributing
|
|
|
|
Any contributions to the codebase are welcome! I am not a cybersecurity person so my code may have a security issue, if you find something that could be used to exploit and bypass tinyauth please let me know as soon as possible so I can fix it.
|
|
|
|
## Acknowledgements
|
|
|
|
Credits for the logo go to:
|
|
|
|
- Freepik for providing the hat and police badge.
|
|
- Renee French for making the gopher logo.
|