Skip to content

Commit f53d5f1

Browse files
committed
docs: update Nginx configuration for client IP and set max body size to 100MB, remove bold styling from sso headings.
1 parent 55ec962 commit f53d5f1

File tree

3 files changed

+36
-33
lines changed

3 files changed

+36
-33
lines changed

docs/docs/installation.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,15 @@ To compile the latest unreleased version (`main` branch):
5353
Libredesk using websockets for real-time updates. If you are using Nginx, you need to add the following (or similar) configuration to your Nginx configuration file.
5454

5555
```nginx
56+
client_max_body_size 100M;
5657
location / {
5758
proxy_pass http://localhost:9000;
5859
proxy_http_version 1.1;
5960
proxy_set_header Upgrade $http_upgrade;
6061
proxy_set_header Connection 'upgrade';
6162
proxy_set_header Host $host;
63+
proxy_set_header X-Real-IP $remote_addr;
64+
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
6265
proxy_cache_bypass $http_upgrade;
6366
}
6467
```

docs/docs/sso.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -9,49 +9,49 @@ Libredesk supports external OpenID Connect providers (e.g., Google, Keycloak) fo
99

1010
Since each provider’s configuration might differ, consult your provider’s documentation for any additional or divergent settings.
1111

12-
1. **Provider Setup:**
12+
1. Provider setup:
1313
In your provider’s admin console, create a new OpenID Connect application/client. Retrieve:
14-
- **Client ID**
15-
- **Client Secret**
16-
17-
2. **Libredesk Configuration:**
18-
In Libredesk, navigate to **Security > SSO** and click **New SSO**. Enter:
19-
- **Provider URL** (e.g., the URL of your OpenID provider)
20-
- **Client ID**
21-
- **Client Secret**
22-
- A descriptive **Name** for the connection
23-
24-
3. **Redirect URL:**
25-
After saving, copy the generated **Callback URL** from Libredesk and add it as a valid redirect URI in your provider’s client settings.
14+
- Client ID
15+
- Client Secret
16+
17+
2. Libredesk configuration:
18+
In Libredesk, navigate to Security > SSO and click New SSO and enter the following details:
19+
- Provider URL (e.g., the URL of your OpenID provider)
20+
- Client ID
21+
- Client Secret
22+
- A descriptive name for the connection
23+
24+
3. Redirect URL:
25+
After saving, copy the generated Callback URL from Libredesk and add it as a valid redirect URI in your provider’s client settings.
2626

2727
## Provider Examples
2828

29-
### Keycloak
29+
#### Keycloak
3030

3131
1. Log in to your Keycloak Admin Console.
3232

33-
2. In Keycloak, navigate to **Clients** and click **Create**:
33+
2. In Keycloak, navigate to Clients and click Create:
3434

35-
- **Client ID** (e.g., `libredesk-app`)
36-
- **Client Protocol**: `openid-connect`
37-
- **Root URL** and **Web Origins**: your app domain (e.g., `https://ticket.example.com`)
38-
- Under **Authentication flow**, uncheck everything except **Standard flow**
39-
- Click **Save**
35+
- Client ID (e.g., `libredesk-app`)
36+
- Client Protocol: `openid-connect`
37+
- Root URL and Web Origins: your app domain (e.g., `https://ticket.example.com`)
38+
- Under Authentication flow, uncheck everything except the standard flow
39+
- Click save
4040

41-
3. Go to the **Credentials** tab:
42-
- Ensure **Client Authenticator** is set to `Client Id and Secret`
43-
- Note down the generated **Client Secret**
41+
3. Go to the credentials tab:
42+
- Ensure client authenticator is set to `Client Id and Secret`
43+
- Note down the generated client secret
4444

45-
4. In Libredesk, go to **Security > SSO** and click **New SSO**:
46-
- **Provider URL** (e.g., `https://keycloak.example.com/realms/yourrealm`)
47-
- **Name** (e.g., `Keycloak`)
48-
- **Client ID**
49-
- **Client Secret**
50-
- Click **Save**
45+
4. In Libredesk, go to Admin > Security > SSO and click New SSO:
46+
- Provider URL (e.g., `https://keycloak.example.com/realms/yourrealm`)
47+
- Name (e.g., `Keycloak`)
48+
- Client ID
49+
- Client secret
50+
- Click save
5151

52-
5. After saving, click on the three dots and choose **Edit** to open the newly SSO entry.
52+
5. After saving, click on the three dots and choose Edit to open the new SSO entry.
5353

54-
6. Copy the generated **Callback URL** from Libredesk.
54+
6. Copy the generated Callback URL from Libredesk.
5555

56-
7. Back in Keycloak, edit the client and add the **Callback URL** to **Valid Redirect URIs**:
56+
7. Back in Keycloak, edit the client and add the Callback URL to Valid Redirect URIs:
5757
- e.g., `https://ticket.example.com/api/v1/oidc/1/finish`

docs/docs/translations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Translations / Internationalization
22

3-
You can help translate LibreDesk into different languages by contributing here: [LibreDesk Translation Project](https://crowdin.com/project/libredesk)
3+
You can help translate libreDesk into different languages by contributing here: [LibreDesk Translation Project](https://crowdin.com/project/libredesk)

0 commit comments

Comments
 (0)