mirror of
https://github.com/steveiliop56/tinyauth.git
synced 2025-10-28 04:35:40 +00:00
68 lines
4.8 KiB
Markdown
68 lines
4.8 KiB
Markdown
<div align="center">
|
|
<img alt="Tinyauth" title="Tinyauth" width="96" src="assets/logo-rounded.png">
|
|
<h1>Tinyauth</h1>
|
|
<p>The simplest way to protect your apps with a login screen.</p>
|
|
</div>
|
|
|
|
<div align="center">
|
|
<img alt="License" src="https://img.shields.io/github/license/steveiliop56/tinyauth">
|
|
<img alt="Release" src="https://img.shields.io/github/v/release/steveiliop56/tinyauth">
|
|
<img alt="Issues" src="https://img.shields.io/github/issues/steveiliop56/tinyauth">
|
|
<img alt="Tinyauth CI" src="https://github.com/steveiliop56/tinyauth/actions/workflows/ci.yml/badge.svg">
|
|
<a title="Crowdin" target="_blank" href="https://crowdin.com/project/tinyauth"><img src="https://badges.crowdin.net/tinyauth/localized.svg"></a>
|
|
</div>
|
|
|
|
<br />
|
|
|
|
Tinyauth is a simple authentication middleware that adds a simple login screen or OAuth with Google, Github or any other provider to all of your apps. It supports all the popular proxies like Traefik, Nginx and Caddy.
|
|
|
|
|
|
|
|
> [!WARNING]
|
|
> Tinyauth is in active development and configuration may change often. Please make sure to carefully read the release notes before updating.
|
|
|
|
## Getting Started
|
|
|
|
You can easily get started with Tinyauth by following the guide in the [documentation](https://tinyauth.app/docs/getting-started). There is also an available [docker compose](./docker-compose.example.yml) file that has Traefik, Whoami and Tinyauth to demonstrate its capabilities.
|
|
|
|
## Demo
|
|
|
|
If you are still not sure if Tinyauth suits your needs you can try out the [demo](https://demo.tinyauth.app). The default username is `user` and the default password is `password`.
|
|
|
|
## Documentation
|
|
|
|
You can find documentation and guides on all of the available configuration of Tinyauth in the [website](https://tinyauth.app).
|
|
|
|
## Discord
|
|
|
|
Tinyauth has a [discord](https://discord.gg/eHzVaCzRRd) server. Feel free to hop in to chat about self-hosting, homelabs and of course Tinyauth. See you there!
|
|
|
|
## Contributing
|
|
|
|
All contributions to the codebase are welcome! If you have any free time feel free to pick up an [issue](https://github.com/steveiliop56/tinyauth/issues) or add your own missing features. Make sure to check out the [contributing guide](./CONTRIBUTING.md) for instructions on how to get the development server up and running.
|
|
|
|
## Localization
|
|
|
|
If you would like to help translate Tinyauth into more languages, visit the [Crowdin](https://crowdin.com/project/tinyauth) page.
|
|
|
|
## 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. For more information about the license check the [license](./LICENSE) file.
|
|
|
|
## Sponsors
|
|
|
|
A big thank you to the following people for providing me with more coffee:
|
|
|
|
<!-- sponsors --><a href="https://github.com/erwinkramer"><img src="https://github.com/erwinkramer.png" width="64px" alt="User avatar: erwinkramer" /></a> <a href="https://github.com/nicotsx"><img src="https://github.com/nicotsx.png" width="64px" alt="User avatar: nicotsx" /></a> <a href="https://github.com/SimpleHomelab"><img src="https://github.com/SimpleHomelab.png" width="64px" alt="User avatar: SimpleHomelab" /></a> <a href="https://github.com/jmadden91"><img src="https://github.com/jmadden91.png" width="64px" alt="User avatar: jmadden91" /></a> <a href="https://github.com/tribor"><img src="https://github.com/tribor.png" width="64px" alt="User avatar: tribor" /></a> <a href="https://github.com/eliasbenb"><img src="https://github.com/eliasbenb.png" width="64px" alt="User avatar: eliasbenb" /></a> <a href="https://github.com/afunworm"><img src="https://github.com/afunworm.png" width="64px" alt="User avatar: afunworm" /></a> <a href="https://github.com/chip-well"><img src="https://github.com/chip-well.png" width="64px" alt="User avatar: chip-well" /></a> <a href="https://github.com/Lancelot-Enguerrand"><img src="https://github.com/Lancelot-Enguerrand.png" width="64px" alt="User avatar: Lancelot-Enguerrand" /></a> <!-- sponsors -->
|
|
|
|
## Acknowledgements
|
|
|
|
- **Freepik** for providing the police hat and badge.
|
|
- **Renee French** for the original gopher logo.
|
|
- **Coderabbit AI** for providing free AI code reviews.
|
|
- **Syrhu** for providing the background image of the app.
|
|
|
|
## Star History
|
|
|
|
[](https://www.star-history.com/#steveiliop56/tinyauth&Date)
|