Skip to content

Commit 89268f2

Browse files
authored
feat: add new options for v4.1.0 (#33)
* feat: add new options for v4.1.0 * fix: bot suggestions * feat: add disable ui warnings option * chore: update changelog
1 parent 6dd51aa commit 89268f2

4 files changed

Lines changed: 42 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: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,38 @@ 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+
- Log new sessions in `TRACE`
13+
- Support for logging in JSON
14+
- Add option to disable UI warnings
15+
16+
### Improvements
17+
18+
- Generate OAuth verifier on every login attempt
19+
- Add routine to cleanup expired sessions
20+
- Log unsafe redirect URI in OAuth controller
21+
22+
### Fixes
23+
24+
- Ensure OAuth providers have the `PROVIDERS_` prefix
25+
- Allow for all sub-domains to be considered safe for redirects
26+
27+
### Technical
28+
29+
- Use Gorm generics for all database actions
30+
- Attempt to clean-up the decoders logic
31+
- Make air development workflow faster by not installing delve on every reload
32+
- Bump dependencies
33+
- Update translations
34+
635
## v4.0.1
736

8-
<Callout>
37+
<Callout type="warning">
938
This release contains a security fix regarding label discovery, please update
1039
as soon as possible.
1140
</Callout>

content/docs/reference/configuration.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ Tinyauth can be configured using environment variables or CLI flags. The table b
2222
| `DATABASE_PATH` | `--database-path` | Path to the SQLite database file. | `/data/tinyauth.db` | no |
2323
| `DISABLE_ANALYTICS` | `--disable-analytics` | Disable anonymous version collection. | `false` | no |
2424
| `DISABLE_RESOURCES` | `--disable-resources` | Disable the resources server. | `false` | no |
25+
| `DISABLE_UI_WARNINGS` | `--disable-ui-warnings` | Disable UI warnings about insecure configurations. | `false` | no |
2526
| `FORGOT_PASSWORD_MESSAGE` | `--forgot-password-message` | Message to show on the forgot password page. | `` | no |
27+
| `LOG_JSON` | `--log-json` | Enable JSON formatted logs. | `false` | no |
2628
| `LOG_LEVEL` | `--log-level` | Log level (`trace`, `debug`, `info`, `warn`, `error`, `fatal`, `panic`). | `info` | no |
2729
| `LOGIN_MAX_RETRIES` | `--login-max-retries` | Maximum login attempts before timeout (0 to disable). | `5` | no |
2830
| `LOGIN_TIMEOUT` | `--login-timeout` | Login timeout in seconds after max retries reached (0 to disable). | `300` | no |
@@ -32,6 +34,7 @@ Tinyauth can be configured using environment variables or CLI flags. The table b
3234
| `RESOURCES_DIR` | `--resources-dir` | Path to a directory containing custom resources (e.g., background image). | `/data/resources` | no |
3335
| `SECURE_COOKIE` | `--secure-cookie` | Send cookie over secure connection only. | `false` | no |
3436
| `SESSION_EXPIRY` | `--session-expiry` | Session (cookie) expiration time in seconds. | `86400` | no |
37+
| `SOCKET_PATH` | `--socket-path` | Path to the Unix socket to bind the server to. | `` | no |
3538
| `TRUSTED_PROXIES` | `--trusted-proxies` | Comma-separated list of trusted proxies (IP addresses or CIDRs) for correct client IP detection. | `` | no |
3639
| `USERS` | `--users` | Comma-separated list of users in the format `username:hash`. | `` | yes |
3740
| `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)