Skip to content

Commit 19b6def

Browse files
authored
Fix several typos (#23)
* Keycloack -> Keycloak * lables -> labels * ony -> only * to to -> to * of of -> of
1 parent 8448c76 commit 19b6def

8 files changed

Lines changed: 9 additions & 9 deletions

File tree

docs/about.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ sidebar_position: 1
44

55
# About
66

7-
Before installing Tinyauth you may be wondering _Why should I use Tinyauth instead of Authelia/Authentik/Keycloack?_ which is a really valid question and I would like to answer in depth.
7+
Before installing Tinyauth you may be wondering _Why should I use Tinyauth instead of Authelia/Authentik/Keycloak?_ which is a really valid question and I would like to answer in depth.
88

99
## The issue with authentication in homelabs
1010

11-
Most of us like using an authentication middleware in front of our apps to either protect them when they don't offer a login screen or just to add an additional layer of authentication. While the projects mentioned above can certainly do the job and offer a variety of configuration options, they can often be hard to configure for new users, resource hungry (apps like Authentik and Keycloack are designed for businesses and not the average homelabber) or simply too annoying to set up and maintain. This is where Tinyauth comes in.
11+
Most of us like using an authentication middleware in front of our apps to either protect them when they don't offer a login screen or just to add an additional layer of authentication. While the projects mentioned above can certainly do the job and offer a variety of configuration options, they can often be hard to configure for new users, resource hungry (apps like Authentik and Keycloak are designed for businesses and not the average homelabber) or simply too annoying to set up and maintain. This is where Tinyauth comes in.
1212

1313
## Why I created Tinyauth
1414

docs/community/zitadel-oauth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ OAuth doesn't mean security, with the current setup everybody with a Zitadel acc
5454
:::
5555

5656
:::tip
57-
Since you have OAuth enabled, you can now remove the `USERS` or `USERS_FILE` environment variables so as you can ony login with your OAuth provider.
57+
Since you have OAuth enabled, you can now remove the `USERS` or `USERS_FILE` environment variables so as you can only login with your OAuth provider.
5858
:::
5959

6060
And you are done! After you restart Tinyauth and try to login to an app, you should have an additional option to login with Zitadel.

docs/guides/advanced.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Some apps already offer some sort of authentication method like basic auth (the
3737

3838
## Host network and Traefik
3939

40-
When using `network_mode: host` in docker alongside with Traefik, the `redirect_uri` in Tinyauth will always be the app URL instead of of the actual redirect URI. This is because Traefik does not respect the `X-Forwarded-Host` header from NAT IP addresses such as the docker internal one. This can be easily fixed by either using the following Traefik config:
40+
When using `network_mode: host` in docker alongside with Traefik, the `redirect_uri` in Tinyauth will always be the app URL instead of the actual redirect URI. This is because Traefik does not respect the `X-Forwarded-Host` header from NAT IP addresses such as the docker internal one. This can be easily fixed by either using the following Traefik config:
4141

4242
```yaml
4343
entryPoints:

docs/guides/github-app-oauth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ OAuth doesn't mean security, with the current setup everybody with a Github acco
5454
:::
5555

5656
:::tip
57-
Since you have OAuth enabled, you can now remove the `USERS` or `USERS_FILE` environment variables so as you can ony login with your OAuth provider.
57+
Since you have OAuth enabled, you can now remove the `USERS` or `USERS_FILE` environment variables so as you can only login with your OAuth provider.
5858
:::
5959

6060
And you are done! After you restart Tinyauth and try to login to an app, you should have an additional option to login with Github.

docs/guides/github-oauth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ OAuth doesn't mean security, with the current setup everybody with a Github acco
5050
:::
5151

5252
:::tip
53-
Since you have OAuth enabled, you can now remove the `USERS` or `USERS_FILE` environment variables so as you can ony login with your OAuth provider.
53+
Since you have OAuth enabled, you can now remove the `USERS` or `USERS_FILE` environment variables so as you can only login with your OAuth provider.
5454
:::
5555

5656
And you are done! After you restart Tinyauth and try to login to an app, you should have an additional option to login with Github.

docs/guides/google-oauth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ OAuth doesn't mean security, with the current setup everybody with a Github acco
7070
:::
7171

7272
:::tip
73-
Since you have OAuth enabled, you can now remove the `USERS` or `USERS_FILE` environment variables so as you can ony login with your OAuth provider.
73+
Since you have OAuth enabled, you can now remove the `USERS` or `USERS_FILE` environment variables so as you can only login with your OAuth provider.
7474
:::
7575

7676
And you are done! After you restart Tinyauth and try to login to an app, you should have an additional option to login with Google.

docs/guides/using-the-binary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Make sure to replace the paths in the service with the actual locations of your
7171
:::
7272

7373
:::tip
74-
If you are using CLI flags, you can remove the `EnvironmentFile` line and add your flags to to the `ExecStart` line, e.g. `ExecStart=/some/path/tinyauth --secret=secret --app-url=https://tinyauth.example.com`.
74+
If you are using CLI flags, you can remove the `EnvironmentFile` line and add your flags to the `ExecStart` line, e.g. `ExecStart=/some/path/tinyauth --secret=secret --app-url=https://tinyauth.example.com`.
7575
:::
7676

7777
Finally we need to reload the systemd daemon:

docs/reference/headers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ To add the headers to the proxy responses you need to configure your proxy to fo
6060

6161
### Traefik
6262

63-
Just add the following in the Tinyauth container lables:
63+
Just add the following in the Tinyauth container labels:
6464

6565
```yaml
6666
traefik.http.middlewares.tinyauth.forwardauth.authResponseHeaders: remote-user # This can be a comma separated list of more headers you will like to copy like the custom ones you set

0 commit comments

Comments
 (0)