Skip to content

Commit ca82286

Browse files
committed
better intro
1 parent 0412e70 commit ca82286

3 files changed

Lines changed: 29 additions & 23 deletions

File tree

docs/advanced-usage/authentication.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ You can generate a Bearer token using one of the `login` endpoints:
1919
- **Basic Authentication:** If Basic Authentication is enabled, authenticate via `POST /api/auth/basic/login` with your username and password.
2020
- **OAuth2 Authentication:** If [OAuth2 authentication](#setting-up-oauth2-authentication-single-sign-on) is enabled, authenticate via `GET /api/auth/oauth2/login` through your configured identity provider.
2121

22-
Generated access tokens are valid for **1 hour**, and refresh tokens for **30 days**. These durations can be adjusted on the [Configuration](../server-docs/configuration.md) page.
22+
Generated access tokens are valid for **5 minutes**, and refresh tokens for **30 days**. These durations can be adjusted on the [Configuration](../server-docs/configuration.md) page.
2323

2424
### Refreshing Tokens
2525

26-
When your access token expires, request a new one using your refresh token via the endpoint `POST /api/auth/refresh`.
26+
When your access token expires, request a new token pair using your refresh token by calling the `POST /api/auth/refresh` endpoint with your refresh token. Your current refresh token will be invalid after this call so make sure to always use the token received from the response for future token refreshes.
2727

2828
### Revoking Tokens
2929

30-
You can revoke a token using the `POST /api/auth/revoke`. This will effectively log out the user by removing the token from the database and invalidating it.
30+
You can revoke a token by calling the `POST /api/auth/revoke` endpoint with your refresh token. This will effectively log out the user, by blocking future token refreshes.
3131

3232
## Setting Up OAuth2 Authentication (Single Sign-On)
3333

docs/intro.md

Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -27,33 +27,39 @@ Let's take a look at all the main functions of GameVault:
2727
### Client Features
2828

2929
- 🔎 [Browse your server's game collection](./client-docs/gui#library)
30-
- 📥 [Download your games from your server](./client-docs/how-to-use#downloading-games)
31-
- ⚙️ [Automatically extract and install games](./client-docs/how-to-use#1-extracting-the-game)
32-
- 🎮 [Launch and play the games on your PC](./client-docs/how-to-use#playing-a-game)
33-
- ⏱️ [Track playtimes and progress (even when the server is offline)](./client-docs/how-to-use#tracking-your-game-progress)
34-
- 👥 [Compare game progress with other users on the server](./client-docs/gui#community)
35-
- ✏️ [Edit any game metadata](./client-docs/gui#metadata)
36-
- 🔒 [Manage your users and games with a powerful Admin UI](./client-docs/gui#administration)
30+
- 📥 [Download games from your server](./client-docs/how-to-use#downloading-games)
31+
- ⚙️ [Automatic game extraction and installation](./client-docs/how-to-use#1-extracting-the-game)
32+
- 🎮 [Launch and play games on your Computer](./client-docs/how-to-use#playing-a-game)
33+
- ⏱️ [Track playtime and progress (works offline)](./client-docs/how-to-use#tracking-your-game-progress)
34+
- 👥 [Compare game progress with other users](./client-docs/gui#community)
35+
- ✏️ [Edit game metadata](./client-docs/gui#metadata)
36+
- 🔒 [Manage users and games through Admin UI](./client-docs/gui#administration)
37+
- 🎥 [Built-in media player for trailers and gameplay videos](./client-docs/gui#game)
38+
- 🎨 [Themes](./client-docs/gui#application)
3739

3840
### Server Features
3941

40-
- ♻️ [Automatic indexer to sync games from the file system into the database](./server-docs/indexing.md)
41-
- 📚 [Automatic enrichment of games with metadata, box arts, tags, genres, description and more using various APIs](./server-docs/metadata-enrichment/metadata.md)
42-
- 👥 [Multi-User Authentication](./server-docs/user-management.md)
43-
- 🔒 [Role-Based Access Control](./server-docs/user-management#user-roles)
44-
- 👨‍👩‍👧‍👦 [Parental Control Features](./server-docs/parental-control)
45-
- ⏱️ [Game Progress and Statistics Tracking](./client-docs/how-to-use#tracking-your-game-progress)
46-
- 🚨 [Health Monitoring and Logging](./advanced-usage/rest-api)
47-
- 🔎 [Full-Text Search, Filters, Sorting, Pagination](./advanced-usage/rest-api)
48-
- 🔌 [Fully Documented API](./advanced-usage/rest-api)
49-
- ⚙️ [Highly Configurable](./server-docs/configuration)
50-
- ⚙️ [Modular Plugin Framework](./server-docs/plugins.md)
42+
- 🔄 [Automatic game indexing from file system](./server-docs/indexing.md)
43+
- 🤖 [Intelligent game type detection](./server-docs/game-types.md)
44+
- 📚 [Automatic metadata enrichment from various video game databases](./server-docs/metadata-enrichment/metadata.md)
45+
- 👥 [Multi-user authentication system](./server-docs/user-management.md)
46+
- 🔒 [Role-based access control](./server-docs/user-management#user-roles)
47+
- 👨‍👩‍👧‍👦 [Parental control features](./server-docs/parental-control)
48+
- ⏱️ [Game progress tracking system](./client-docs/how-to-use#tracking-your-game-progress)
49+
- 🚨 [Built-in health monitoring and logging](./advanced-usage/rest-api)
50+
- 🔎 [Advanced search, filtering, and sorting](./advanced-usage/rest-api)
51+
- 🔌 [Comprehensive API documentation](./advanced-usage/rest-api)
52+
- ⚙️ [Highly configurable server settings](./server-docs/configuration)
53+
- 🔌 [Extensible plugin framework](./server-docs/plugins.md)
54+
- 🔄 [WebSocket support for real-time updates](./server-docs/websockets.md)
55+
- 💾 [Database backup and restoration](./server-docs/configuration)
56+
- 🔐 [OAuth2 authentication support](./advanced-usage/authentication#setting-up-oauth2-authentication-single-sign-on)
5157

5258
### Premium Features
5359

5460
- Visit our [GameVault+](./gamevault-plus/introduction.md) page to learn more about our premium features.
5561

56-
## Support
62+
## Support Us
5763

5864
We're working hard in our free time to provide you, your friends, and families with the best self-hosted gaming experience. It would mean a lot to us if you could support us developers by [getting GameVault+](./gamevault-plus/introduction.md).
5965

docs/server-docs/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ This page describes the various configuration properties used in the application
124124
| Property | Description | Default | Possible Values |
125125
| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | --------------------------------------------------------------------------- |
126126
| `AUTH_SEED` ` | Random seed for generating tokens. Generated automatically if not set. | Hash of any credential in the config. | Any random string, it doesn't matter what it says, or how long it is. |
127-
| `AUTH_ACCESS_TOKEN_EXPIRES_IN` | Specifies how long an access token is valid. | `1h` | A valid [ms-format](https://github.com/vercel/ms) string (e.g. "1h", "30m") |
127+
| `AUTH_ACCESS_TOKEN_EXPIRES_IN` | Specifies how long an access token is valid. | `5m` | A valid [ms-format](https://github.com/vercel/ms) string (e.g. "1h", "30m") |
128128
| `AUTH_REFRESH_TOKEN_EXPIRES_IN` | Specifies how long a refresh token is valid. | `30d` | A valid [ms-format](https://github.com/vercel/ms) string (e.g. "1h", "30m") |
129129
| `AUTH_BASIC_AUTH_ENABLED` | Enables or disables Basic Auth. Disabling this will disable registering and logging in using username and password. | `true` | `true`, `false` |
130130
| `AUTH_OAUTH2_ENABLED` | Enables or disables OAuth2 integration. | `false` | `true`, `false` |

0 commit comments

Comments
 (0)