Skip to content

Commit 81a0210

Browse files
authored
feat: New Crowdin updates (#351)
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - New Features - Comprehensive German localization across UI strings and full documentation. - German translations added for API, CLI, Unraid Connect, Unraid OS guides, troubleshooting, release notes, and VM/Storage/Network pages. - Documentation - Large set of new German guides (setup, API/OIDC, CLI, WireGuard, Tailscale, ZFS, cache/pools, diagnostics, FAQs). - New localized categories and indexes; many docs refined for clarity and formatting. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent 5f5b64f commit 81a0210

File tree

1,035 files changed

+81569
-961
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,035 files changed

+81569
-961
lines changed

.github/workflows/main.yml

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -27,37 +27,10 @@ jobs:
2727
- name: Install dependencies
2828
run: npm ci
2929

30-
- name: Sync with Crowdin
31-
id: crowdin-sync
32-
continue-on-error: true
33-
env:
34-
CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
35-
run: npm run crowdin:sync
36-
37-
- name: Report Crowdin sync failure
38-
if: ${{ always() && steps.crowdin-sync.outcome != 'success' }}
39-
run: echo "::warning::Crowdin sync failed; continuing deploy with available locales."
40-
4130
- name: Build documentation
42-
id: build-docs
43-
continue-on-error: true
4431
run: npm run build
4532

46-
- name: Report build failure
47-
if: ${{ always() && steps.build-docs.outcome != 'success' }}
48-
run: echo "::warning::Documentation build failed; attempting deploy with existing artifacts."
49-
50-
- name: Ensure build artifacts
51-
id: ensure-build
52-
if: ${{ always() }}
53-
run: |
54-
if [ ! -d build ]; then
55-
echo "::error::No build artifacts found; deploy skipped."
56-
exit 1
57-
fi
58-
5933
- name: Deploy to Cloudflare Workers
60-
if: ${{ always() && steps.ensure-build.outcome == 'success' }}
6134
run: npx wrangler@latest deploy
6235
env:
6336
CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_DEPLOY_TOKEN }}

.github/workflows/pr.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ jobs:
4949
- name: Install dependencies
5050
run: npm ci
5151

52-
- name: Build documentation (English only)
53-
run: npm run build -- --locale en
52+
- name: Build documentation
53+
run: npm run build
5454
env:
5555
BASE_URL: /docs/pr-preview/pr-${{ github.event.number }}/
5656
GITHUB_BRANCH: ${{ github.head_ref }}

docs/API/cli.mdx

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,7 @@ sidebar_position: 4
77
# CLI Commands
88

99
:::info[Command Structure]
10-
1110
All commands follow the pattern: `unraid-api <command> [options]`
12-
1311
:::
1412

1513
## 🚀 Service Management
@@ -93,9 +91,7 @@ Switch between production and staging environments.
9391
### Developer Mode
9492

9593
:::tip[Web GUI Management]
96-
9794
You can also manage developer options through the web interface at **Settings****Management Access****Developer Options**
98-
9995
:::
10096

10197
```bash
@@ -114,9 +110,7 @@ Configure developer features for the API:
114110
## API Key Management
115111

116112
:::tip[Web GUI Management]
117-
118113
You can also manage API keys through the web interface at **Settings****Management Access****API Keys**
119-
120114
:::
121115

122116
### API Key Commands
@@ -138,9 +132,7 @@ Options:
138132
## SSO (Single Sign-On) Management
139133

140134
:::info[OIDC Configuration]
141-
142135
For OIDC/SSO provider configuration, see the web interface at **Settings****Management Access****API****OIDC** or refer to the [OIDC Provider Setup](./oidc-provider-setup.mdx) guide.
143-
144136
:::
145137

146138
### SSO Base Command

docs/API/how-to-use-the-api.mdx

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,7 @@ import ManageApiKeysCli from './partials/manage-api-keys-cli.mdx';
1212
# Using the Unraid API
1313

1414
:::tip[Quick Start]
15-
1615
The Unraid API provides a powerful GraphQL interface for managing your server. This guide covers authentication, common queries, and best practices.
17-
1816
:::
1917

2018
The Unraid API provides a GraphQL interface that allows you to interact with your Unraid server. This guide will help you get started with exploring and using the API.
@@ -24,9 +22,7 @@ The Unraid API provides a GraphQL interface that allows you to interact with you
2422
### Web GUI Method (Recommended)
2523

2624
:::info[Preferred Method]
27-
2825
Using the Web GUI is the easiest way to enable the GraphQL sandbox.
29-
3026
:::
3127

3228
1. Navigate to **Settings****Management Access****Developer Options**
@@ -54,9 +50,7 @@ unraid-api developer
5450
## 🔑 Authentication
5551

5652
:::warning[Required for Most Operations]
57-
5853
Most queries and mutations require authentication. Always include appropriate credentials in your requests.
59-
6054
:::
6155

6256
You can authenticate using:
@@ -206,21 +200,17 @@ Available roles:
206200
## ✨ Best Practices
207201

208202
:::tip[Pro Tips]
209-
210203
1. Use the Apollo Sandbox to explore the schema and test queries
211204
2. Start with small queries and gradually add fields as needed
212205
3. Monitor your query complexity to maintain performance
213206
4. Use appropriate roles and permissions for your API keys
214207
5. Keep your API keys secure and rotate them periodically
215-
216208
:::
217209

218210
## ⏱️ Rate Limiting
219211

220212
:::caution[Rate Limits]
221-
222213
The API implements rate limiting to prevent abuse. Ensure your applications handle rate limit responses appropriately.
223-
224214
:::
225215

226216
## 🚨 Error Handling
@@ -242,12 +232,10 @@ The API returns standard GraphQL errors in the following format:
242232
## 📚 Additional Resources
243233

244234
:::info[Learn More]
245-
246235
- Use the Apollo Sandbox's schema explorer to browse all available types and fields
247236
- Check the documentation tab in Apollo Sandbox for detailed field descriptions
248237
- Monitor the API's health using `unraid-api status`
249238
- Generate reports using `unraid-api report` for troubleshooting
250239

251240
For more information about specific commands and configuration options, refer to the [CLI documentation](cli.mdx) or run `unraid-api --help`.
252-
253241
:::

docs/API/index.mdx

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,7 @@ import GetStartedPre72 from './partials/get-started-pre72.mdx';
1313
# Welcome to Unraid API
1414

1515
:::tip[What's New]
16-
1716
Starting with Unraid OS v7.2, the API comes built into the operating system - no plugin installation required!
18-
1917
:::
2018

2119
The Unraid API provides a GraphQL interface for programmatic interaction with your Unraid server. It enables automation, monitoring, and integration capabilities.
@@ -40,45 +38,34 @@ For Unraid versions prior to v7.2 or to access newer API features:
4038
3. Access API functionality through the [GraphQL Sandbox](./how-to-use-the-api.mdx)
4139

4240
:::info[Important Notes]
43-
4441
- The Unraid Connect plugin provides the API for pre-7.2 versions
4542
- You do NOT need to sign in to Unraid Connect to use the API locally
4643
- Installing the plugin on 7.2+ gives you access to newer API features before they're included in OS releases
47-
4844
:::
4945

5046
## 📚 Documentation Sections
5147

5248
<div style={{display: 'grid', gridTemplateColumns: 'repeat(auto-fit, minmax(250px, 1fr))', gap: '1rem'}}>
5349
<Card title="CLI Commands" icon="terminal" href="./cli">
54-
5550
Complete reference for all CLI commands
56-
5751
</Card>
5852

5953
<Card title="Using the API" icon="code" href="./how-to-use-the-api">
60-
6154
Learn how to interact with the GraphQL API
62-
6355
</Card>
6456

6557
<Card title="OIDC Setup" icon="shield" href="./oidc-provider-setup">
66-
6758
Configure SSO authentication providers
68-
6959
</Card>
7060

7161
<Card title="Upcoming Features" icon="rocket" href="./upcoming-features">
72-
7362
See what's coming next
74-
7563
</Card>
7664
</div>
7765

7866
## 🌟 Key Features
7967

8068
:::info[Core Capabilities]
81-
8269
The API provides:
8370

8471
- **GraphQL Interface**: Modern, flexible API with strong typing
@@ -87,7 +74,6 @@ The API provides:
8774
- **Developer Tools**: Built-in GraphQL sandbox configurable via web interface or CLI
8875
- **Role-Based Access**: Granular permission control
8976
- **Web Management**: Manage API keys and settings through the web interface
90-
9177
:::
9278

9379
## 🚀 Get Started

docs/API/oidc-provider-setup.mdx

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,7 @@ sidebar_position: 3
77
# OIDC Provider Setup
88

99
:::info[What is OIDC?]
10-
1110
OpenID Connect (OIDC) is an authentication protocol that allows users to sign in using their existing accounts from providers like Google, Microsoft, or your corporate identity provider. It enables Single Sign-On (SSO) for seamless and secure authentication.
12-
1311
:::
1412

1513
This guide walks you through configuring OIDC (OpenID Connect) providers for SSO authentication in the Unraid API using the web interface.
@@ -22,7 +20,6 @@ This guide walks you through configuring OIDC (OpenID Connect) providers for SSO
2220
1. Navigate to your Unraid server's web interface
2321
2. Go to **Settings****Management Access****API****OIDC**
2422
3. You'll see tabs for different providers - click the **+** button to add a new provider
25-
2623
</details>
2724

2825
### OIDC Providers Interface Overview
@@ -72,7 +69,6 @@ Simple mode is the easiest way to configure authorization. You can:
7269
- You want to verify multiple claims (e.g., email domain AND verified status)
7370
- You have complex authorization requirements
7471
- You need fine-grained control over how rules are evaluated
75-
7672
</details>
7773

7874
## Authorization Rules
@@ -153,7 +149,6 @@ In Simple Authorization:
153149
- Email must be verified
154150
- User must be in specific group
155151
- Account must have 2FA enabled (if claim available)
156-
157152
</details>
158153

159154
<details>
@@ -196,25 +191,20 @@ In Simple Authorization:
196191
- **Enable Developer Sandbox**: Toggle to enable GraphQL sandbox at `/graphql`
197192
- The interface uses a dark theme for better visibility
198193
- Field validation indicators help ensure correct configuration
199-
200194
</details>
201195

202196
### Required Redirect URI
203197

204198
:::caution[Important Configuration]
205-
206199
All providers must be configured with this exact redirect URI format:
207-
208200
:::
209201

210202
```bash
211203
http://YOUR_UNRAID_IP/graphql/api/auth/oidc/callback
212204
```
213205

214206
:::tip
215-
216207
Replace `YOUR_UNRAID_IP` with your actual server IP address (e.g., `192.168.1.100` or `tower.local`).
217-
218208
:::
219209

220210
### Issuer URL Format
@@ -316,9 +306,7 @@ The Unraid.net provider is built-in and pre-configured. You only need to configu
316306
- **Redirect URI**: `http://YOUR_UNRAID_IP/graphql/api/auth/oidc/callback`
317307

318308
:::tip[Redirect URI Protocol]
319-
320309
**Match the protocol to your server setup:** Use `http://` if accessing your Unraid server without SSL/TLS (typical for local network access). Use `https://` if you've configured SSL/TLS on your server. Some OIDC providers (like Google) require HTTPS and won't accept HTTP redirect URIs.
321-
322310
:::
323311

324312
Configure authorization rules using Simple Mode (allowed email domains/addresses) or Advanced Mode for complex requirements.
@@ -335,7 +323,6 @@ Configure authorization rules using Simple Mode (allowed email domains/addresses
335323
3. Choose **Web application** as the application type
336324
4. Add your redirect URI to **Authorized redirect URIs**
337325
5. Configure the OAuth consent screen if prompted
338-
339326
</details>
340327

341328
**Configuration:**
@@ -346,15 +333,13 @@ Configure authorization rules using Simple Mode (allowed email domains/addresses
346333
- **Redirect URI**: `http://YOUR_UNRAID_IP/graphql/api/auth/oidc/callback`
347334

348335
:::warning[Google Domain Requirements]
349-
350336
**Google requires valid domain names for OAuth redirect URIs.** Local IP addresses and `.local` domains are not accepted. To use Google OAuth with your Unraid server, you'll need:
351337

352338
- **Option 1: Reverse Proxy** - Set up a reverse proxy (like NGINX Proxy Manager or Traefik) with a valid domain name pointing to your Unraid API
353339
- **Option 2: Tailscale** - Use Tailscale to get a valid `*.ts.net` domain that Google will accept
354340
- **Option 3: Dynamic DNS** - Use a DDNS service to get a public domain name for your server
355341

356342
Remember to update your redirect URI in both Google Cloud Console and your Unraid OIDC configuration to use the valid domain.
357-
358343
:::
359344

360345
For Google Workspace domains, use Advanced Mode with the `hd` claim to restrict access to your organization's domain.

docs/API/programmatic-api-key-management.mdx

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,7 @@ The `unraid-api apikey` command supports both interactive and non-interactive mo
1818
- Infrastructure as code workflows
1919

2020
:::tip[Quick Start]
21-
2221
Jump to the [Complete Workflow Example](#complete-workflow-example) to see everything in action.
23-
2422
:::
2523

2624
## Creating API Keys Programmatically
@@ -62,9 +60,7 @@ unraid-api apikey --create --name "existing key" --roles ADMIN --overwrite --jso
6260
```
6361

6462
:::warning[Key Replacement]
65-
6663
The `--overwrite` flag will permanently replace the existing key. The old key will be immediately invalidated.
67-
6864
:::
6965

7066
## Deleting API Keys Programmatically
@@ -203,7 +199,6 @@ echo "Deployment completed successfully"
203199
## Best Practices
204200

205201
:::info[Security Best Practices]
206-
207202
**Minimal Permissions**
208203

209204
- Use specific permissions instead of ADMIN role when possible
@@ -214,7 +209,6 @@ echo "Deployment completed successfully"
214209
- Always clean up temporary keys after use
215210
- Store API keys securely (environment variables, secrets management)
216211
- Use descriptive names and descriptions for audit trails
217-
218212
:::
219213

220214
### Error Handling
@@ -234,7 +228,6 @@ echo "Deployment completed successfully"
234228
### Common Issues
235229

236230
:::note[Common Error Messages]
237-
238231
**"API key name must contain only letters, numbers, and spaces"**
239232

240233
- **Solution:** Remove special characters like hyphens, underscores, or symbols
@@ -246,7 +239,6 @@ echo "Deployment completed successfully"
246239
**"Please add at least one role or permission to the key"**
247240

248241
- **Solution:** Specify either `--roles` or `--permissions` (or both)
249-
250242
:::
251243

252244
### Debug Mode

0 commit comments

Comments
 (0)