You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-10Lines changed: 5 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,19 +14,16 @@
14
14
15
15
<br />
16
16
17
-
Tinyauth is a simple authentication middleware that adds simple username/password login or OAuth with Google, Github and any generic provider to all of your docker apps. It is designed for traefik but it can be extended to work with other reverse proxies like caddy and nginx.
17
+
Tinyauth is a simple authentication middleware that adds simple username/password login or OAuth with Google, Github and any generic provider to all of your docker apps. It supports all the popular proxies like Traefik, Nginx and Caddy.
18
18
19
19

20
20
21
21
> [!WARNING]
22
22
> Tinyauth is in active development and configuration may change often. Please make sure to carefully read the release notes before updating.
23
23
24
-
> [!NOTE]
25
-
> Tinyauth is intended for homelab use only and it is not made for production use cases. If you are looking for something production ready please use [authentik](https://goauthentik.io) instead.
26
-
27
24
## Getting Started
28
25
29
-
You can easily get started with tinyauth by following the guide in the [documentation](https://tinyauth.app/docs/getting-started.html). There is also an available [docker compose file](./docker-compose.example.yml) that has traefik, whoami and tinyauth to demonstrate its capabilities.
26
+
You can easily get started with tinyauth by following the guide in the [documentation](https://tinyauth.app/docs/getting-started.html). There is also an available [docker compose](./docker-compose.example.yml) file that has traefik, whoami and tinyauth to demonstrate its capabilities.
30
27
31
28
## Demo
32
29
@@ -38,15 +35,15 @@ You can find documentation and guides on all of the available configuration of t
38
35
39
36
## Discord
40
37
41
-
I just made a Discord server for tinyauth! It is not only for tinyauth but general self-hostingand homelabbing. [See you there!](https://discord.gg/eHzVaCzRRd).
38
+
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!
42
39
43
40
## Contributing
44
41
45
-
All contributions to the codebase are welcome! If you have any recommendations on how to improve security or find a security issue in tinyauth please open an issue or pull request so it can be fixed as soon as possible!
42
+
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.
46
43
47
44
## Localization
48
45
49
-
If you would like to help translating the project in more languages you can do so by visiting the [Crowdin](https://crowdin.com/project/tinyauth) page.
46
+
If you would like to help translating tinyauth into more languages, visit the [Crowdin](https://crowdin.com/project/tinyauth) page.
50
47
51
48
## License
52
49
@@ -60,8 +57,6 @@ Thanks a lot to the following people for providing me with more coffee:
60
57
61
58
## Acknowledgements
62
59
63
-
Credits for the logo of this app go to:
64
-
65
60
-**Freepik** for providing the police hat and badge.
66
61
-**Renee French** for the original gopher logo.
67
62
-**Coderabbit AI** for providing free AI code reviews.
0 commit comments