Skip to content

Commit

Permalink
web,etherpad: add etherpad addon for sharing document
Browse files Browse the repository at this point in the history
  • Loading branch information
netaskd authored and saghul committed Aug 7, 2019
1 parent 2f9192c commit 62f2d11
Show file tree
Hide file tree
Showing 10 changed files with 485 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Makefile
Expand Up @@ -2,7 +2,7 @@ FORCE_REBUILD ?= 0
JITSI_RELEASE ?= stable
JITSI_BUILD ?= latest
JITSI_REPO ?= jitsi
JITSI_SERVICES ?= base base-java web prosody jicofo jvb jigasi
JITSI_SERVICES ?= base base-java web prosody jicofo jvb jigasi etherpad

ifeq ($(FORCE_REBUILD), 1)
BUILD_ARGS = "--no-cache"
Expand Down
17 changes: 16 additions & 1 deletion README.md
Expand Up @@ -35,7 +35,10 @@ follow these steps:
a different port, in case you edited the compose file).

If you want to use jigasi too, first configure your env file with SIP credentials
and then run Docker Compose as follows: ``docker-compose -f docker-compose.yml -f jigasi.yml up -d``
and then run Docker Compose as follows: ``docker-compose -f docker-compose.yml -f jigasi.yml up``

If you want to enable document sharing via [Etherpad], configure it and run Docker Compose as
follows: ``docker-compose -f docker-compose.yml -f etherpad.yml up``

## Architecture

Expand Down Expand Up @@ -199,6 +202,17 @@ This can be tested using the [jwt.io] debugger. Use the following samople payloa
}
```

### Shared document editing using Etherpad

You can collaboratively edit a document via [Etherpad]. In order to enable it, set the config options bellow and run
Docker Compose with the additional config file `etherpad.yml`.

Here are the required options:

Variable | Description | Example
--- | --- | ---
`ETHERPAD_URL_BASE` | Set etherpad-lite URL | http://etherpad.meet.jitsi:9001

### Advanced configuration

These configuration options are already set and generally don't need to be changed.
Expand Down Expand Up @@ -270,4 +284,5 @@ option.
[ICE]: https://en.wikipedia.org/wiki/Interactive_Connectivity_Establishment
[STUN]: https://en.wikipedia.org/wiki/STUN
[jwt.io]: https://jwt.io/#debugger-io
[Etherpad]: https://github.com/ether/etherpad-lite

1 change: 1 addition & 0 deletions docker-compose.yml
Expand Up @@ -24,6 +24,7 @@ services:
- XMPP_BOSH_URL_BASE
- XMPP_GUEST_DOMAIN
- XMPP_MUC_DOMAIN
- ETHERPAD_URL_BASE
- TZ
networks:
meet.jitsi:
Expand Down
8 changes: 8 additions & 0 deletions env.example
Expand Up @@ -33,6 +33,14 @@ TZ=Europe/Amsterdam
#LETSENCRYPT_EMAIL=alice@atlanta.net


#
# Etherpad integration (for document sharing)
#

# Set etherpad-lite URL (uncomment to enable).
#ETHERPAD_URL_BASE=http://etherpad.meet.jitsi:9001


#
# Basic Jigasi configuration options (needed for SIP gateway support)
#
Expand Down
10 changes: 10 additions & 0 deletions etherpad.yml
@@ -0,0 +1,10 @@
version: '3'

services:
# Etherpad: real-time collaborative document editing
etherpad:
image: jitsi/etherpad
networks:
meet.jitsi:
aliases:
- etherpad.meet.jitsi
5 changes: 5 additions & 0 deletions etherpad/Dockerfile
@@ -0,0 +1,5 @@
FROM etherpad/etherpad

ADD ./rootfs/defaults/settings.json /opt/etherpad-lite/settings.json

EXPOSE 9001
4 changes: 4 additions & 0 deletions etherpad/Makefile
@@ -0,0 +1,4 @@
build:
docker build $(BUILD_ARGS) -t jitsi/etherpad .

.PHONY: build

0 comments on commit 62f2d11

Please sign in to comment.