opendev
/
system-config
Code Issues Proposed changes

Adjust the example Etherpad API delete command 

Because our docker images include few CLI utilities, make the
example so that we rely on outside utilities on the host system for
making http connections to the API socket for simplicity.

Change-Id: I6a8abdbb55120db7d0f0b97255824f5a8fac76cb
This commit is contained in:
Jeremy Stanley 2021-01-13 17:05:00 +00:00
parent 44a076998b
commit 501de530d1
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/etherpad.rst
View File

@ -49,12 +49,14 @@ browser). This is fairly easily accomplished via the `HTTP API`_, but
you need the key which is saved in a file on the server so it's easiest
if done when SSH'd into it locally::
/usr/local/bin/docker-compose -f /etc/etherpad-docker/docker-compose.yaml exec -T etherpad \
bash -c "wget -qO- 'http://localhost:9001/api/1/deletePad?apikey='$(cat \
/opt/etherpad-lite/APIKEY.txt)'&padID=XXXXXXXXXX'"
wget -qO- "http://localhost:9001/api/1/deletePad?apikey=$(sudo \
docker-compose -f /etc/etherpad-docker/docker-compose.yaml exec etherpad \
cat /opt/etherpad-lite/APIKEY.txt)&padID=XXXXXXXXXX" ; echo
...where XXXXXXXXXX is the pad's name as it appears at the end of its
URL. If all goes well, you should receive a response like::
URL (the trailing echo is just because the API response doesn't end with
a newline and so your next appended shell prompt makes it harder to
read). If all goes well, you should receive a response like::
{"code":0,"message":"ok","data":null}