# richdocuments

**Repository Path**: mirrors_owncloud/richdocuments

## Basic Information

- **Project Name**: richdocuments
- **Description**:  :notebook_with_decorative_cover: Collabora Online for ownCloud
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-11-07
- **Last Updated**: 2026-02-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

ownCloud application to integrate Collabora Online
==================================================
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=owncloud_richdocuments&metric=alert_status)](https://sonarcloud.io/dashboard?id=owncloud_richdocuments)
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=owncloud_richdocuments&metric=security_rating)](https://sonarcloud.io/dashboard?id=owncloud_richdocuments)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=owncloud_richdocuments&metric=coverage)](https://sonarcloud.io/dashboard?id=owncloud_richdocuments)

Collabora Online for ownCloud provides collaborating editing functions for text documents, spreadsheets and presentations inside ownCloud for improved productivity.

See also: https://owncloud.com/collabora/collaborative-editing/

### Configuration

- Set WOPI Server URL

    ```
    $ occ config:app:set richdocuments wopi_url --value [your-host-public-ip]:8098 
    ```

- Enable/Disable Secure View and set its settings

    ```
    $ occ config:app:set richdocuments secure_view_option --value true
    $ occ config:app:set richdocuments watermark_text --value "Restricted to {viewer-email}" 
    $ occ config:app:set richdocuments secure_view_open_action_default --value true
    ```

### Developing

The easiest way to integrate Collabora with development instance of ownCloud is by disabling SSL for Collabora.

- Start Collabora Server with default settings

    ```
    $ docker run -t -d -p 9980:9980 -e "extra_params=--o:ssl.enable=false" -e "username=admin" -e "password=admin" --name collabora --cap-add MKNOD collabora/code:6.4.8.6
    ```

- Access Collabora Admin at `http://[your-host-public-ip]:9980/loleaflet/dist/admin/admin.html` e.g. `172.16.12.95`,

- Set in `Settings -> Admin -> Additional -> Collabora Online server -> http://[your-host-public-ip]:9980`


### Installation

NOTE: Collabora server needs to be reachable from ownCloud server, and Collabora server needs to be able to reach ownCloud server

NOTE: it is possible to use Collabora Online’s integration with re-compiled and/or re-branded backends.

## Installing connector for ownCloud Web

You will need:
* [ownCloud server](https://owncloud.com/download-server/#owncloud-server) with ownCloud Web (it can be compiled from source code or installed from the [official marketplace](https://marketplace.owncloud.com/apps/web)).
* Official ownCloud Collabora Online integration app. You can install it from the [ownCloud marketplace](https://marketplace.owncloud.com/apps/richdocuments).

To enable work within ownCloud web, register the connector in the ownCloud Web config.json:

* If you installed ownCloud Web from the official marketplace, the path is `<owncloud-root-catalog>/config/config.json`
* If you compiled it from source code yourself using [this instruction](https://owncloud.dev/clients/web/backend-oc10/#running-web), the path is `<owncloud-web-root-catalog>/config/config.json`.

To register the connector, use these lines:

```
"external_apps": [
    {
        "id": "richdocuments",
        "path": "http(s)://<owncloud-10-server-address>/index.php/apps/richdocuments/js/richdocuments.js"
    }
]
```

## Compiling the connector for ownCloud Web

Build all the dependencies:

```
yarn install
```
Build the resulting file `js/web/richdocuments.js`:

```
yarn build
```