Skip to content

Commit 3e51c84

Browse files
committed
fix: improvements to migration guide
1 parent 4582c99 commit 3e51c84

2 files changed

Lines changed: 11 additions & 6 deletions

File tree

content/docs/breaking-updates/3-to-4.mdx

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,17 @@ The new configuration for the OAuth providers includes a dynamic name in the con
5656
| `PROVIDERS_[PROVIDER]_CLIENT_SECRET` | `--providers-[provider]-client-secret` | The client secret for the OAuth client. | `` | yes |
5757
| `PROVIDERS_[PROVIDER]_CLIENT_SECRET_FILE` | `--providers-[provider]-client-secret-file` | A path to a file containing the client secret for the OAuth client. | `` | no |
5858
| `PROVIDERS_[PROVIDER]_SCOPES` | `--providers-[provider]-scopes` | The scopes needed for the OAuth provider. | `` | yes |
59+
| `PROVIDERS_[PROVIDER]_REDIRECT_URL` [^1] | `--providers-[provider]-redirect-url` | The redirect URL for the OAuth provider. | `` | yes |
5960
| `PROVIDERS_[PROVIDER]_AUTH_URL` | `--providers-[provider]-auth-url` | The authentication URL for the OAuth provider. | `` | yes |
6061
| `PROVIDERS_[PROVIDER]_TOKEN_URL` | `--providers-[provider]-token-url` | The token URL for the OAuth provider. | `` | yes |
61-
| `PROVIDERS_[PROVIDER]_USER_INFO_URL` | `--providers-[provider]-user-info-url` | The user information URL for the OAuth provider. | `` | yes |
62+
| `PROVIDERS_[PROVIDER]_USER_INFO_URL` [^2] | `--providers-[provider]-user-info-url` | The user information URL for the OAuth provider. | `` | yes |
6263
| `PROVIDERS_[PROVIDER]_INSECURE_SKIP_VERIFY` | `--providers-[provider]-insecure-skip-verify` | Skip SSL certificate check for provider. | `false` | no |
6364
| `PROVIDERS_[PROVIDER]_NAME` | `--providers-[provider]-name` | The name of the OAuth provider (for the UI button). | Provider ID with first letter capitalized. | no |
6465

66+
[^1]: This is required for now. While some providers handle this automatically, it's suggested you set it anyway.
67+
68+
[^2]: Please notice the added `_INFO_` in the name of this option.
69+
6570
For example, to configure Google OAuth:
6671

6772
```

content/docs/guides/advanced.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,14 @@ Some apps already offer authentication methods like basic auth (e.g., browser po
2323
services:
2424
whoami:
2525
labels:
26-
tinyauth.apps.whoami.response.basic.username: username
27-
tinyauth.apps.whoami.response.basic.password: password
26+
tinyauth.apps.whoami.response.basicauth.username: username
27+
tinyauth.apps.whoami.response.basicauth.password: password
2828
```
2929
3030
<Callout type="info">
31-
Use the `tinyauth.apps.whoami.response.basic.passwordfile` label instead of
32-
the plain one to keep the password secure in a secret file. Ensure the
33-
secret file is added as a volume to Tinyauth.
31+
Use the `tinyauth.apps.whoami.response.basicauth.passwordfile` label
32+
instead of the plain one to keep the password secure in a secret file.
33+
Ensure the secret file is added as a volume to Tinyauth.
3434
</Callout>
3535

3636
4. Restart the app. Logging in to Tinyauth will automatically log in to the protected app using basic auth.

0 commit comments

Comments
 (0)