Skip to content

Commit 8791b1a

Browse files
committed
feat: add new options for v4.1.0
1 parent 6dd51aa commit 8791b1a

4 files changed

Lines changed: 39 additions & 5 deletions

File tree

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -168,10 +168,10 @@ The following options are deprecated:
168168

169169
Changed options:
170170

171-
| Current | New |
172-
| ----------------------------------- | ----------------------------------- |
173-
| `COOKIE_SECURE` (`--cookie-secure`) | `SECURE_COOKIE` (`--secure-cookie`) |
174-
| `LOG_LEVEL` (`--log-level`) | `LOG_LEVEL` (`--log-level`) |
171+
| Current | New | Values |
172+
| ----------------------------------- | ----------------------------------- | ----------------------------------------------------------- |
173+
| `COOKIE_SECURE` (`--cookie-secure`) | `SECURE_COOKIE` (`--secure-cookie`) | `true`, `false` |
174+
| `LOG_LEVEL` (`--log-level`) | `LOG_LEVEL` (`--log-level`) | `trace`, `debug`, `info`, `warn`, `error`, `fatal`, `panic` |
175175

176176
## API Changes
177177

content/docs/changelog.mdx

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,36 @@ title: Changelog
33
description: Overview of changes and updates in Tinyauth versions.
44
---
55

6+
## v4.1.0
7+
8+
### New Features
9+
10+
- Light mode
11+
- Support for listening on UNIX sockets
12+
- Support for logging in JSON
13+
- Log new sessions in `TRACE`
14+
15+
### Improvements
16+
17+
- Generate OAuth verifier on every login attempt
18+
- Add routine to cleanup expired sessions
19+
20+
### Fixes
21+
22+
- Ensure OAuth providers have the `PROVIDERS_` prefix
23+
- Allow for all sub-domains to be considered safe for redirects
24+
25+
### Technical
26+
27+
- Use Gorm generics for all database actions
28+
- Attempt to clean-up the decoders logic
29+
- Make air development workflow faster by not installing delve on every reload
30+
- Bump dependencies
31+
- Update translations
32+
633
## v4.0.1
734

8-
<Callout>
35+
<Callout type="warning">
936
This release contains a security fix regarding label discovery, please update
1037
as soon as possible.
1138
</Callout>

content/docs/reference/configuration.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,14 @@ Tinyauth can be configured using environment variables or CLI flags. The table b
2626
| `LOG_LEVEL` | `--log-level` | Log level (`trace`, `debug`, `info`, `warn`, `error`, `fatal`, `panic`). | `info` | no |
2727
| `LOGIN_MAX_RETRIES` | `--login-max-retries` | Maximum login attempts before timeout (0 to disable). | `5` | no |
2828
| `LOGIN_TIMEOUT` | `--login-timeout` | Login timeout in seconds after max retries reached (0 to disable). | `300` | no |
29+
| `LOG_JSON` | `--log-json` | Enable JSON formatted logs. | `false` | no |
2930
| `OAUTH_AUTO_REDIRECT` | `--oauth-auto-redirect` | Auto redirect to the specified OAuth provider. | `` | no |
3031
| `OAUTH_WHITELIST` | `--oauth-whitelist` | Comma-separated list of email addresses to whitelist when using OAuth. | `` | no |
3132
| `PORT` | `--port` | Port to run the server on. | `3000` | no |
3233
| `RESOURCES_DIR` | `--resources-dir` | Path to a directory containing custom resources (e.g., background image). | `/data/resources` | no |
3334
| `SECURE_COOKIE` | `--secure-cookie` | Send cookie over secure connection only. | `false` | no |
3435
| `SESSION_EXPIRY` | `--session-expiry` | Session (cookie) expiration time in seconds. | `86400` | no |
36+
| `SOCKET_PATH` | `--socket-path` | Path to the Unix socket to bind the server to. | `` | no |
3537
| `TRUSTED_PROXIES` | `--trusted-proxies` | Comma-separated list of trusted proxies (IP addresses or CIDRs) for correct client IP detection. | `` | no |
3638
| `USERS` | `--users` | Comma-separated list of users in the format `username:hash`. | `` | yes |
3739
| `USERS_FILE` | `--users-file` | Path to a file containing users in the format `username:hash`. | `` | no |

content/docs/reference/headers.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,11 @@ The `Remote-Name` header contains the full name of the currently logged-in user.
2828

2929
The `Remote-Groups` header contains the groups of the currently logged-in user, retrieved from the `groups` claim in the OIDC server. These can be used to allow access to specific user groups configured by the OIDC server. More details are available in the [OIDC access controls](/docs/guides/access-controls.md#access-controls-using-oidc-groups) guide.
3030

31+
<Callout type="warning">
32+
Remote groups are only available for OIDC providers that support the `groups`
33+
claim. LDAP groups are **not** supported.
34+
</Callout>
35+
3136
### Custom headers
3237

3338
Custom headers can be set using the `tinyauth.headers` label on any container that uses the Tinyauth middleware. For example:

0 commit comments

Comments
 (0)