Skip to content

Commit 62de2cf

Browse files
committed
Adapted readme and settings.json.template
1 parent 4957f82 commit 62de2cf

File tree

2 files changed

+22
-4
lines changed

2 files changed

+22
-4
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,21 @@ Settings come from ``settings.json``, see ``settings.json.template`` for an exam
3636
3737
``port`` is the port this service listens on.
3838
39-
## V1
40-
- [ ] API to create/destroy backends - REF: https://github.com/colyseus/proxy/blob/master/proxy.ts
39+
## OAuth2 backed Etherpads
40+
41+
``clientId`` is the clientId used to authenticate with the backend Etherpad instances. This should be a random string that is unique to this service.
42+
43+
``clientSecret`` is the clientSecret used to authenticate with the backend Etherpad instances. This should be a random string that is unique to this service.
44+
``tokenURL`` is the URL of the OAuth2 token endpoint. This is normally `http://<your-host>:<your-port>/oidc/token`
45+
46+
## Basic Auth backed Etherpads
47+
48+
``username`` is the username used to authenticate with the backend Etherpad instances. This should be a random string that is unique to this service.
49+
50+
``password`` is the password used to authenticate with the backend Etherpad instances. This should be a random string that is unique to this service.
51+
52+
Pads will be fetched every checkInterval * seconds whereas the normal checkInterval runs every checkInterval * milliseconds.
53+
If pads are deleted they are also deleted from the reverse proxy so it can be reassigned to another backend.
4154

4255
# License
4356
Apache 2

settings.json.template

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,16 @@
33
"backends" : {
44
"backend1": {
55
"host": "localhost",
6-
"port": 9001
6+
"port": 9001,
7+
"clientId": "admin_client",
8+
"clientSecret": "admin",
9+
"tokenURL": "http://localhost:9001/oidc/token"
710
},
811
"backend2": {
912
"host": "localhost",
10-
"port": 9002
13+
"port": 9002,
14+
"username": "admin",
15+
"password": "admin",
1116
},
1217
"backend3": {
1318
"host": "localhost",

0 commit comments

Comments
 (0)