Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add the Collaboration stack debugging doc #9113

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions changelog/unreleased/add-debugging-doc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Enhancement: Add the Collaboration stack deployment

Add the Collaboration stack deployment
Add the Collaboration stack debugging doc

https://github.com/owncloud/ocis/pull/9113
26 changes: 26 additions & 0 deletions deployments/examples/ocis_collaboraton/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Documentation
The documentation is incomplete because the Collaboration server is in a development state.

# Infinite Scale Collaboration Deployment Example

This deployment example of the oCIS with the new Collaboration server.
Comment on lines +1 to +6
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Documentation
The documentation is incomplete because the Collaboration server is in a development state.
# Infinite Scale Collaboration Deployment Example
This deployment example of the oCIS with the new Collaboration server.
# Infinite Scale Collaboration Deployment Example
IMPORTANT: This documentation is a first draft because the Collaboration service is currently under development.
This oCIS deployment example shows the setup with the new Collaboration service replacing on a long run the WOPI deployment example.


## Overview

* oCIS, Collaboration server, Collabora or OnlyOffice running behind Traefik as reverse proxy
* Collabora or OnlyOffice enable you to edit documents in your browser
* Collaboration server acts as a bridge to make the oCIS storage accessible to Collabora or OnlyOffice
* Traefik generating self-signed certificates for local setup or obtaining valid SSL certificates for a server setup
Please note: Against the stack that uses [wopiserver](https://owncloud.dev/ocis/deployment/ocis_wopi/), we don't need the app_provider anymore. The new Collaboration server now includes an app_provider.
Comment on lines +10 to +14
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* oCIS, Collaboration server, Collabora or OnlyOffice running behind Traefik as reverse proxy
* Collabora or OnlyOffice enable you to edit documents in your browser
* Collaboration server acts as a bridge to make the oCIS storage accessible to Collabora or OnlyOffice
* Traefik generating self-signed certificates for local setup or obtaining valid SSL certificates for a server setup
Please note: Against the stack that uses [wopiserver](https://owncloud.dev/ocis/deployment/ocis_wopi/), we don't need the app_provider anymore. The new Collaboration server now includes an app_provider.
* oCIS, the collaboration service, Collabora or OnlyOffice are running behind Traefik as reverse proxy
* Collabora or OnlyOffice enable you to edit documents in your browser
* The collaboration service acts as a bridge to make the oCIS storage accessible to Collabora or OnlyOffice
* Traefik generates self-signed certificates for local setup, or obtaining valid LetsEncrypt SSL certificates for a server setup
Note: Compared to the stack that uses [wopiserver](https://owncloud.dev/ocis/deployment/ocis_wopi/), we don't need the extra `app_provider` setup anymore. The new collaboration service now includes an `app_provider`.


### Running
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Running
## Using the Deployment Example


```bash
docker compose -f docker-compose.collabora.yml up -d
```

```bash
docker compose -f docker-compose.onlyoffice.yml up -d
```

Also see the [Admin Documentation](https://doc.owncloud.com/ocis/latest/index.html) for administrative and more configuration details.
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
app_registry:
mimetypes:
- mime_type: application/pdf
extension: pdf
name: PDF
description: PDF document
icon: ''
default_app: ''
allow_creation: false
- mime_type: application/vnd.oasis.opendocument.text
extension: odt
name: OpenDocument
description: OpenDocument text document
icon: ''
default_app: Collabora
allow_creation: true
- mime_type: application/vnd.oasis.opendocument.spreadsheet
extension: ods
name: OpenSpreadsheet
description: OpenDocument spreadsheet document
icon: ''
default_app: Collabora
allow_creation: true
- mime_type: application/vnd.oasis.opendocument.presentation
extension: odp
name: OpenPresentation
description: OpenDocument presentation document
icon: ''
default_app: Collabora
allow_creation: true
- mime_type: application/vnd.openxmlformats-officedocument.wordprocessingml.document
extension: docx
name: Microsoft Word
description: Microsoft Word document
icon: ''
default_app: OnlyOffice
allow_creation: true
- mime_type: application/vnd.openxmlformats-officedocument.wordprocessingml.form
extension: docxf
name: Form Document
description: Form Document
icon: ''
default_app: OnlyOffice
allow_creation: true
- mime_type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
extension: xlsx
name: Microsoft Excel
description: Microsoft Excel document
icon: ''
default_app: OnlyOffice
allow_creation: true
- mime_type: application/vnd.openxmlformats-officedocument.presentationml.presentation
extension: pptx
name: Microsoft PowerPoint
description: Microsoft PowerPoint document
icon: ''
default_app: OnlyOffice
allow_creation: true
- mime_type: application/vnd.jupyter
extension: ipynb
name: Jupyter Notebook
description: Jupyter Notebook
icon: ''
default_app: ''
allow_creation: true
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
password
12345678
123
ownCloud
ownCloud-1
37 changes: 37 additions & 0 deletions deployments/examples/ocis_collaboraton/config/ocis/csp.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
directives:
child-src:
- '''self'''
connect-src:
- '''self'''
default-src:
- '''none'''
font-src:
- '''self'''
frame-ancestors:
- '''self'''
frame-src:
- '''self'''
- 'https://embed.diagrams.net/'
# In contrary to bash and docker the default is given after the | character
- 'https://${ONLYOFFICE_DOMAIN|onlyoffice.owncloud.test}/'
- 'https://${COLLABORA_DOMAIN|collabora.owncloud.test}/'
img-src:
- '''self'''
- 'data:'
- 'blob:'
# In contrary to bash and docker the default is given after the | character
- 'https://${ONLYOFFICE_DOMAIN|onlyoffice.owncloud.test}/'
- 'https://${COLLABORA_DOMAIN|collabora.owncloud.test}/'
manifest-src:
- '''self'''
media-src:
- '''self'''
object-src:
- '''self'''
- 'blob:'
script-src:
- '''self'''
- '''unsafe-inline'''
style-src:
- '''self'''
- '''unsafe-inline'''
18 changes: 18 additions & 0 deletions deployments/examples/ocis_collaboraton/config/ocis/web.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
web:
config:
external_apps:
- id: preview
path: web-app-preview
config:
mimeTypes:
- image/tiff
- image/bmp
- image/x-ms-bmp
- id: importer
path: web-app-importer
config:
companionUrl: https://${COMPANION_DOMAIN|companion.owncloud.test}
supportedClouds:
- WebdavPublicLink
#- OneDrive # needs a client id and secret
#- GoogleDrive # needs a client id and secret and an addition to the DNS zone
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#!/bin/sh
set -e

# we can't mount it directly because the run-document-server.sh script wants to move it
cp /etc/onlyoffice/documentserver/local.dist.json /etc/onlyoffice/documentserver/local.json

/app/ds/run-document-server.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
{
"services": {
"CoAuthoring": {
"sql": {
"type": "postgres",
"dbHost": "localhost",
"dbPort": "5432",
"dbName": "onlyoffice",
"dbUser": "onlyoffice",
"dbPass": "onlyoffice"
},
"token": {
"enable": {
"request": {
"inbox": true,
"outbox": true
},
"browser": true
},
"inbox": {
"header": "Authorization"
},
"outbox": {
"header": "Authorization"
}
},
"secret": {
"inbox": {
"string": "B8LjkNqGxn6gf8bkuBUiMwyuCFwFddnu"
},
"outbox": {
"string": "B8LjkNqGxn6gf8bkuBUiMwyuCFwFddnu"
},
"session": {
"string": "B8LjkNqGxn6gf8bkuBUiMwyuCFwFddnu"
}
}
}
},
"rabbitmq": {
"url": "amqp://guest:guest@localhost"
},
"FileConverter": {
"converter": {
"inputLimits": [
{
"type": "docx;dotx;docm;dotm",
"zip": {
"uncompressed": "1GB",
"template": "*.xml"
}
},
{
"type": "xlsx;xltx;xlsm;xltm",
"zip": {
"uncompressed": "1GB",
"template": "*.xml"
}
},
{
"type": "pptx;ppsx;potx;pptm;ppsm;potm",
"zip": {
"uncompressed": "1GB",
"template": "*.xml"
}
}
]
}
}

}
Loading