Skip to content

Commit b37384a

Browse files
authored
chore: add prettier (#374)
* chore: add prettier * format * add to ci * use ; * use single quotes as its as well docusaurus default
1 parent 44bd321 commit b37384a

255 files changed

Lines changed: 2431 additions & 1913 deletions

File tree

Some content is hidden

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

.prettierignore

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
*
2+
3+
!*.md
4+
!*.mdx
5+
6+
!*/
7+
8+
assets/**
9+
static/**
10+
README.md
11+
CHANGELOG.md
12+
Contributing.md

.woodpecker/build.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ steps:
99
image: quay.io/thegeeklab/git-batch
1010
commands:
1111
- git batch -vv
12+
- name: format-check
13+
image: owncloudci/nodejs:20
14+
commands:
15+
- pnpm install
16+
- pnpm format:check
1217
- name: build
1318
image: owncloudci/nodejs:20
1419
commands:

docs/admin/configuration/authentication-and-user-management/external-idp.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -60,18 +60,18 @@ for an example.
6060

6161
```yaml
6262
role_assignment:
63-
driver: oidc
64-
oidc_role_mapper:
65-
role_claim: opencloudRoles
66-
role_mapping:
67-
- role_name: admin
68-
claim_value: myAdminRole
69-
- role_name: spaceadmin
70-
claim_value: mySpaceAdminRole
71-
- role_name: user
72-
claim_value: myUserRole
73-
- role_name: guest
74-
claim_value: myGuestRole
63+
driver: oidc
64+
oidc_role_mapper:
65+
role_claim: opencloudRoles
66+
role_mapping:
67+
- role_name: admin
68+
claim_value: myAdminRole
69+
- role_name: spaceadmin
70+
claim_value: mySpaceAdminRole
71+
- role_name: user
72+
claim_value: myUserRole
73+
- role_name: guest
74+
claim_value: myGuestRole
7575
```
7676
7777
This would assign the role `admin` to users with the value `myAdminRole` in the claim `opencloudRoles`.
@@ -115,7 +115,7 @@ The web client is used for browser-based access to OpenCloud:
115115

116116
- **Client ID**: `web`
117117
- **Client Type**: Public client
118-
- **Redirect URIs**:
118+
- **Redirect URIs**:
119119
- `https://your-domain.example.com/`
120120
- `https://your-domain.example.com/oidc-callback.html`
121121
- `https://your-domain.example.com/oidc-silent-redirect.html`

docs/admin/configuration/authentication-and-user-management/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: 'Authentication and Identity Management'
66

77
OpenCloud employs a dual-track authentication strategy:
88

9-
1. **Built-in IDP (Identity Provider)**:
9+
1. **Built-in IDP (Identity Provider)**:
1010
- Based on LibreGraph Connect (lico)
1111
- Targeted at smaller installations (up to 500 users)
1212
- Designed for standalone or small deployments

docs/admin/configuration/authentication-and-user-management/keycloak.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ title: Keycloak Integration
88

99
OpenCloud supports using Keycloak as an external identity provider, providing enterprise-grade identity management capabilities. This guide explains how to set up and configure Keycloak with OpenCloud.
1010
This guide is divided into three main sections:
11+
1112
- **[Keycloak Integration Overview](#opencloud-configuration-for-keycloak-general)**: A brief overview of the integration process.
1213
- **[Shared User Directory Mode](#configuration-for-shared-directory-mode)**: Keycloak and OpenCloud share a common LDAP directory for user management.
1314
- **[Autoprovisioning Mode](#configuration-for-autoprovisioning-mode)**: OpenCloud autoprovisions users in a separate LDAP directory managed by OpenCloud.
@@ -50,12 +51,12 @@ If you need to manually configure the clients in Keycloak:
5051
3. Navigate to Clients and click Create
5152
4. Configure each client according to the specifications above
5253
5. Ensure all clients have the appropriate scopes:
53-
- web-origins
54-
- profile
55-
- roles
56-
- groups
57-
- basic
58-
- email
54+
- web-origins
55+
- profile
56+
- roles
57+
- groups
58+
- basic
59+
- email
5960

6061
### Advanced Configuration
6162

@@ -66,7 +67,6 @@ OpenCloud supports Keycloak's backchannel logout feature, which allows Keycloak
6667
- **Backchannel Logout URL**: `https://your-domain.example.com/backchannel_logout`
6768
- **Backchannel Logout Session Required**: `true`
6869

69-
7070
## Shared User Directory Mode
7171

7272
```mermaid
@@ -98,6 +98,7 @@ graph TD
9898
In this mode, a readable LDAP Directory with existing users serves as a central user directory for both Keycloak and OpenCloud.
9999

100100
**Key characteristics:**
101+
101102
- LDAP is the source of truth for user information
102103
- The LDAP server uses standard attributes (uid, cn, sn, givenName, mail)
103104
- A common unique identifier (e.g. `entryUUID` or `objectGUID`) guarantees stable user mapping even if users are changing
@@ -115,6 +116,7 @@ OpenCloud can work with any LDAP schema containing standard attributes:
115116
- Default configuration sets LDAP as read-only
116117

117118
**Example LDAP Structure:**
119+
118120
```bash
119121
dc=example,dc=org # Base DN
120122
├── ou=users # User organizational unit
@@ -184,6 +186,7 @@ OpenCloud provides complete example deployments using Docker Compose:
184186
2. Edit the `.env` file to enable the Shared Directory Mode:
185187

186188
**For Shared Directory Mode:**
189+
187190
```bash
188191
# Enable services
189192
LDAP=:ldap.yml
@@ -202,6 +205,7 @@ Keycloak is configured during startup by importing the `keycloak-realm.dist.json
202205
Keycloak can import the realm configuration file **only once** during the first startup. If you need to change the configuration, you must delete the Keycloak container and volume and restart it. This will reset Keycloak to its initial state.
203206

204207
:::
208+
205209
## Autoprovisioning Mode
206210

207211
In this mode, Keycloak is holding all users and OpenCloud autoprovisions new users during first login.
@@ -289,6 +293,7 @@ OpenCloud provides complete example deployments using Docker Compose:
289293
2. Edit the `.env` file to enable the Autoprovisioning Mode:
290294

291295
**For Autoprovisioning Mode:**
296+
292297
```bash
293298
# Enable services
294299
LDAP=:ldap.yml
@@ -311,8 +316,8 @@ Keycloak can import the realm configuration file **only once** during the first
311316

312317
Common issues and solutions:
313318

314-
- **User cannot log in**:
315-
- Check LDAP connectivity and user existence
319+
- **User cannot log in**:
320+
- Check LDAP connectivity and user existence
316321
- Check if each user has an OpenCloud Role assigned
317322
- Verify that the client IDs and redirect URIs match exactly
318323
- **Groups not synchronized**: Verify group mappings in Keycloak

docs/admin/configuration/logging.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,23 @@ Set the global log level using the `OPEN_CLOUD_LOG_LEVEL` environment variable.
2121
## The log levels are:
2222

2323
### FATAL
24+
2425
Critical issues that cause the application to shut down — such as config errors or missing dependencies.
2526

2627
### ERROR
28+
2729
Severe problems that block proper operation and require admin attention.
2830

2931
### WARN
32+
3033
Unexpected conditions that don’t stop the app but may need investigation.
3134

3235
### INFO
36+
3337
Routine events that confirm expected behavior and operation.
3438

3539
### DEBUG
40+
3641
Highly detailed messages for diagnosing problems. Use cautiously in production due to verbosity.
3742

3843
---
@@ -47,3 +52,4 @@ To manually test with `curl`, add:
4752

4853
```bash
4954
--header "X-Request-ID: <your-id>"
55+
```

docs/admin/configuration/mail-notifications.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 9
33
id: mail-notificatons
44
title: Mail Notifications
5-
description: "How to activate mail notifications in OpenCloud."
5+
description: 'How to activate mail notifications in OpenCloud.'
66
---
77

88
# Mail notifications in OpenCloud
@@ -38,7 +38,7 @@ SMTP_USERNAME=YOUR_USERNAME
3838
SMTP_PASSWORD=YOUR_PASSWORD
3939
SMTP_TRANSPORT_ENCRYPTION=none
4040
SMTP_INSECURE=true
41-
````
41+
```
4242

4343
⚠️ In the .env file, values should be written without quotation marks. Do not use 'single quotes' or "double quotes" — just enter the plain value.
4444

@@ -55,10 +55,10 @@ For nano, press Ctrl + O to save and Ctrl + X to exit.
5555
Apply the changes by restarting the OpenCloud services:
5656

5757
```bash
58-
docker compose down
58+
docker compose down
5959
docker compose up -d
6060
```
6161

6262
---
6363

64-
OpenCloud is now successfully configured to deliver notification emails, including those triggered by actions such as file sharing.
64+
OpenCloud is now successfully configured to deliver notification emails, including those triggered by actions such as file sharing.

docs/admin/configuration/radicale-integration.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 12
33
id: radicale-integration
44
title: Calendar and Contacts Integration with Radicale
5-
description: "How to enable Calendar and Contacts integration via Radicale in OpenCloud."
5+
description: 'How to enable Calendar and Contacts integration via Radicale in OpenCloud.'
66
---
77

88
OpenCloud is able to act as an authenticating reverse proxy for the open-source
@@ -13,15 +13,13 @@ used with a wide selection of desktop- and mobile clients without hassle.
1313
The `opencloud_full` deployment example already contains all the required pieces to
1414
setup the integration. This guide explains the required steps to achieve that.
1515

16-
1716
:::note
1817
The calendar and contacts feature is - until further notice - intended for
1918
non-customers, i.e. please note that it is not covered under our business
2019
license, and we do not provide professional support for it. This means that
2120
this feature is maintained and supported on best effort without warranty.
2221
:::
2322

24-
2523
## Setting up Calendar and Contacts Integration with Radicale
2624

2725
To use this feature you need at least OpenCloud Version 2.3.0. Earlier releases lack
@@ -30,7 +28,7 @@ deployment based on the `opencloud_full` deployment example.
3028

3129
### 1. Configure the `.env` file to deploy Radicale
3230

33-
In the root directory of the `opencloud_full` deployment example, usually `opencloud/deployments/examples/opencloud_full`,
31+
In the root directory of the `opencloud_full` deployment example, usually `opencloud/deployments/examples/opencloud_full`,
3432
remove the `#` symbol from the line:
3533

3634
```
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
sidebar_position: 2
33
id: storage-cephfs
4-
title: "CephsFS"
4+
title: 'CephsFS'
55
draft: true
6-
---
6+
---

docs/admin/configuration/storage/decomposeds3.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
sidebar_position: 3
33
id: storage-decomposeds3
4-
title: "Decomposeds3"
4+
title: 'Decomposeds3'
55
---
66

77
# Decomposeds3 Storage Driver
@@ -11,13 +11,14 @@ Decomposeds3 is a storage driver for OpenCloud that uses MinIO, an S3-compatible
1111
---
1212

1313
**Prerequisites:**
14+
1415
- **Linux**, **Mac** or **Windows** Subsystem for Linux [(WSL)](https://learn.microsoft.com/en-us/windows/wsl/install)
1516
- [**Docker**](https://docs.docker.com/compose/install/)
1617
- [**Docker Compose**](https://docs.docker.com/compose/install/)
1718

1819
---
1920

20-
## 1. Download
21+
## 1. Download
2122

2223
Download the `opencloud_full` folder (this folder contains a multi-file Docker Compose configuration):
2324

@@ -49,7 +50,7 @@ docker compose up -d
4950

5051
This starts all necessary containers in the background.
5152

52-
## 3. Add local domains to /etc/hosts
53+
## 3. Add local domains to /etc/hosts
5354

5455
Edit the /etc/hosts file and add the following entries for local access:
5556

@@ -61,6 +62,7 @@ Edit the /etc/hosts file and add the following entries for local access:
6162
## 4. Login
6263

6364
Login with your browser:
65+
6466
- [https://cloud.opencloud.test](https://cloud.opencloud.test)
6567
- user: **admin**
6668
- password: **admin**
@@ -71,10 +73,10 @@ Login with your browser:
7173

7274
<img src={require("./../img/decomposeds3-with-minio.png").default} alt="Admin general" width="1920"/>
7375

74-
---
76+
---
7577

7678
### Troubleshooting
7779

78-
If you encounter any issues or errors, try finding a solution here:
80+
If you encounter any issues or errors, try finding a solution here:
7981

8082
- [Common Issues & Help](../../resources/common-issues.md)

0 commit comments

Comments
 (0)