Skip to content

Commit 1ee2e05

Browse files
SvanvithSvanvith
authored
write instruction how to enable MS-Office formats in the new button … (#706)
* write instruction how to eneable MS-Office formats in the new button and put together collabora related docs in a new collabora folder * add info, that it doesn't work with internal docker volumes and remove the Jupyter part * add index.md for collabora
1 parent ee22314 commit 1ee2e05

5 files changed

Lines changed: 145 additions & 5 deletions

File tree

‎docs/admin/configuration/collabora/_category_.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "Collabora",
3+
"position": 30
4+
}

docs/admin/configuration/collabora.md renamed to docs/admin/configuration/collabora/collabora-fonts.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
sidebar_position: 70
3-
id: collabora
2+
sidebar_position: 10
3+
id: collabora-fonts
44
title: Collabora additional fonts
55
description: How to add additional fonts to Collabora
66
draft: false
@@ -29,7 +29,7 @@ apt install ttf-mscorefonts-installer
2929

3030
During the installation, you will be prompted to accept the EULA (End User License Agreement).
3131

32-
<img src={require("./img/collabora/accept-eula.png").default} alt="Accept EULA" width="1920"/>
32+
<img src={require("../img/collabora/accept-eula.png").default} alt="Accept EULA" width="1920"/>
3333

3434
## 3. Restart Collabora
3535

@@ -41,4 +41,4 @@ docker compose restart
4141

4242
Once restarted, Collabora will recognize the newly installed fonts, and they will be available when editing documents.
4343

44-
<img src={require("./img/collabora/new-fonts.png").default} alt="New Fonts added" width="1920"/>
44+
<img src={require("../img/collabora/new-fonts.png").default} alt="New Fonts added" width="1920"/>

‎docs/admin/configuration/collabora/collabora-ms-office-formats.md‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
---
2+
sidebar_position: 20
3+
id: collabora-ms-office-formats
4+
title: Enable MS-Office formats
5+
description: How to enable MS-Office formats
6+
draft: false
7+
---
8+
9+
## Enable Microsoft file formats in the New menu
10+
11+
:::note
12+
Starting with version 5.2.0, OpenCloud no longer enables Microsoft file formats as default creation options in the New menu. To make them available again, you must define them explicitly in `app-registry.yaml`.
13+
:::
14+
15+
### Create the configuration file
16+
17+
Create an `app-registry.yaml` file in your OpenCloud configuration directory.
18+
19+
This change cannot be applied in setups that use internal Docker volumes only, because the config directory is not available directly on the host.
20+
21+
For production deployments, bind-mounted volumes are recommended, as they provide a predictable host path for configuration, persistence, and backups.
22+
23+
If your deployment uses a bind mount for the OpenCloud config directory, place the file in the mapped config directory on the host system. The exact path depends on your Docker Compose setup and may differ from `config/opencloud`.
24+
25+
Example:
26+
27+
````bash
28+
/path/to/your/opencloud/config/app-registry.yaml
29+
30+
Insert following content:
31+
32+
```yaml
33+
app_registry:
34+
mimetypes:
35+
- mime_type: application/pdf
36+
extension: pdf
37+
name: PDF
38+
description: PDF document
39+
icon: ''
40+
default_app: ''
41+
allow_creation: false
42+
- mime_type: application/vnd.oasis.opendocument.text
43+
extension: odt
44+
name: Document
45+
description: OpenDocument text document
46+
icon: ''
47+
default_app: Collabora
48+
allow_creation: true
49+
- mime_type: application/vnd.oasis.opendocument.spreadsheet
50+
extension: ods
51+
name: Spreadsheet
52+
description: OpenDocument spreadsheet document
53+
icon: ''
54+
default_app: Collabora
55+
allow_creation: true
56+
- mime_type: application/vnd.oasis.opendocument.presentation
57+
extension: odp
58+
name: Presentation
59+
description: OpenDocument presentation document
60+
icon: ''
61+
default_app: Collabora
62+
allow_creation: true
63+
- mime_type: application/vnd.openxmlformats-officedocument.wordprocessingml.document
64+
extension: docx
65+
name: Microsoft Word
66+
description: Microsoft Word document
67+
icon: ''
68+
default_app: Collabora
69+
allow_creation: true
70+
- mime_type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
71+
extension: xlsx
72+
name: Microsoft Excel
73+
description: Microsoft Excel document
74+
icon: ''
75+
default_app: Collabora
76+
allow_creation: true
77+
- mime_type: application/vnd.openxmlformats-officedocument.presentationml.presentation
78+
extension: pptx
79+
name: Microsoft PowerPoint
80+
description: Microsoft PowerPoint document
81+
icon: ''
82+
default_app: Collabora
83+
allow_creation: true
84+
````
85+
86+
### Verify ownership and permissions
87+
88+
:::important UID/GID and volume permissions
89+
Make sure that `app-registry.yaml` can be read by the user running the OpenCloud container. Incorrect ownership or permissions on mounted files can prevent OpenCloud from using the configuration.
90+
:::
91+
92+
By default, OpenCloud uses:
93+
94+
```bash
95+
UID=1000
96+
GID=1000
97+
```
98+
99+
Adjust the file ownership and permissions if your container runs with different values.
100+
101+
### Restart OpenCloud
102+
103+
Restart your deployment after creating the file:
104+
105+
```bash
106+
docker compose down
107+
docker compose up -d
108+
```
109+
110+
After the restart, Microsoft formats such as Word, Excel, and PowerPoint are available again in the New menu.

‎docs/admin/configuration/collabora/index.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
sidebar_position: 1
3+
id: collabora
4+
title: Collabora
5+
description: Configuration guides for Collabora integration in OpenCloud
6+
draft: false
7+
---
8+
9+
# Collabora
10+
11+
This section collects the most common Collabora configuration topics for OpenCloud.
12+
It is meant as a quick entry point for administrators who want to improve document compatibility and editing experience.
13+
14+
## What you will find here
15+
16+
- Add additional fonts so documents render more reliably across systems.
17+
- Enable Microsoft Office formats in the New menu when you want to create `.docx`, `.xlsx`, or `.pptx` files directly.
18+
19+
## Guides
20+
21+
- [Install additional fonts](./collabora-fonts)
22+
- [Enable MS-Office formats](./collabora-ms-office-formats)
23+
24+
## Recommended order
25+
26+
If you are setting up Collabora for the first time, start with fonts and then decide whether Microsoft file formats should be available in the creation menu.

‎docs/admin/configuration/frontend-update-check.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 15
2+
sidebar_position: 35
33
id: frontend-check-updates
44
title: Frontend Update check
55
description: How to disable the frontend check for updates in OpenCloud.

0 commit comments

Comments
 (0)