Skip to content

Commit

Permalink
add tutorial on using reva with the wopiserver
Browse files Browse the repository at this point in the history
  • Loading branch information
LovisaLugnegard committed Jul 1, 2020
1 parent 8d8fe39 commit 2dd0aa0
Showing 1 changed file with 112 additions and 0 deletions.
112 changes: 112 additions & 0 deletions docs/content/en/docs/tutorials/wopi-tutorial.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
---
title: "Use WOPI with Reva"
linkTitle: "Use WOPI with Reva"
weight: 5
description: >
Connect the cs3 wopiserver with Reva
---

This is a guide on how you can run both Reva and wopiserver locally in a dev environment.
The wopiserver will allow you to connect Reva to online editors such as collabora.

## Prerequisites
If you encounter strange problems, please check which version of the prerequisites you are running, it might be that you need to update/downgrade. For reference ask someone who already has reva and Phoenix running, they will have updated information on the versions.
* golang >= 1.12
* make/automake
* git >= 2
* python >=3.7

## 1. Clone the wopiserver and Reva repos
Clone the wopiserver repo from https://github.com/cs3org/wopiserver

```
git clone https://github.com/cs3org/wopiserver
```

Clone the reva repo from https://github.com/cs3org/reva

```
git clone https://github.com/cs3org/reva
```

## 2. Configure Reva
Add `disable_tus = true` under `[http.services.dataprovider]` and under `[grpc.services.storageprovider]` in the file `ocmd-server-1.toml`.

## 3. Build Reva
Go to your Reva folder

```
cd reva
```

Now you need to build Reva by running the following commands (you need to be in the *reva* folder)

```
make deps
```

```
make build
```

## 4. Run Reva
Now you need to run Revad (the Reva daemon). Follow these steps
from the *reva* folder:

```
cd examples/ocm/ && ../../cmd/revad/revad -c ocmd-server-1.toml & ../../cmd/revad/revad -c ocmd-server-2.toml &.
```

The Reva daemon (revad) should now be running.

## 5. Configure the wopiserver
Follow the instructions in the readme for running the server locally ("Run the WOPI server locally", https://github.com/cs3org/wopiserver). You will need to do come changes in the config file, here is a more relevant example of a wopi config when runnning the server together with reva:

```
#
# wopiserver.conf - basic working configuration for a docker image
#
[general]
storagetype = cs3
port = 8880
allowedclients = localhost
oosurl = https://oos.web.cern.ch
codeurl = https://collabora.cern.ch:9980/byoa/collabora
codimdurl = http://cbox-wopidev-01.cern.ch:8000
tokenvalidity = 86400
wopiurl = localhost:8880
downloadurl = localhost:8880/wopi/cbox/download
# Logging level. Debug enables the Flask debug mode as well.
# Valid values are: Debug, Info, Warning, Error.
loglevel = Debug
[security]
usehttps = no
# location of the secret files. Requires a restart of the
# WOPI server when either the files or their content change.
wopisecretfile = /etc/wopi/wopisecret
iopsecretfile = /etc/wopi/iopsecret
[cs3]
revahost = localhost:19000
authtokenvalidity = 3600
endpoint = 123e4567-e89b-12d3-a456-426655440000
[io]
# Size used for buffered xroot reads [bytes]
chunksize = 4194304
```

## 6. Run wopiserver
Run according to instructions in the readme ("Run the WOPI server locally", https://github.com/cs3org/wopiserver).

## 7. Local changes
To try the connection you could for example go to a new reva terminal window and type
`./cmd/reva/reva -insecure login basic` - use einstein and relativity as log in ccredentials
`./cmd/reva/reva -insecure open-file-in-app-provider /home/example.txt read` - this should print out the app provider url in your terminal.

## 8. Enjoy your new Reva and wopiserver set up!

0 comments on commit 2dd0aa0

Please sign in to comment.