Browse Source

Etherpad app

Bob Mottram 8 years ago
parent
commit
54c19d0d33
1 changed files with 617 additions and 0 deletions
  1. 617
    0
      src/freedombone-app-etherpad

+ 617
- 0
src/freedombone-app-etherpad View File

@@ -0,0 +1,617 @@
1
+#!/bin/bash
2
+#
3
+# .---.                  .              .
4
+# |                      |              |
5
+# |--- .--. .-.  .-.  .-.|  .-. .--.--. |.-.  .-. .--.  .-.
6
+# |    |   (.-' (.-' (   | (   )|  |  | |   )(   )|  | (.-'
7
+# '    '     --'  --'  -' -  -' '  '   -' -'   -' '   -  --'
8
+#
9
+#                    Freedom in the Cloud
10
+#
11
+# Etherpad app
12
+#
13
+# License
14
+# =======
15
+#
16
+# Copyright (C) 2016 Bob Mottram <bob@freedombone.net>
17
+#
18
+# This program is free software: you can redistribute it and/or modify
19
+# it under the terms of the GNU Affero General Public License as published by
20
+# the Free Software Foundation, either version 3 of the License, or
21
+# (at your option) any later version.
22
+#
23
+# This program is distributed in the hope that it will be useful,
24
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
25
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
26
+# GNU Affero General Public License for more details.
27
+#
28
+# You should have received a copy of the GNU Affero General Public License
29
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
30
+
31
+VARIANTS="full full-vim writer"
32
+
33
+IN_DEFAULT_INSTALL=1
34
+SHOW_ON_ABOUT=1
35
+
36
+ETHERPAD_DOMAIN_NAME=
37
+ETHERPAD_CODE=
38
+ETHERPAD_ONION_PORT=8101
39
+ETHERPAD_REPO="https://github.com/ether/etherpad-lite"
40
+ETHERPAD_COMMIT='223127bf39d2ba431d9c1965a7f2aadadc73d77a'
41
+ETHERPAD_ADMIN_PASSWORD=
42
+ETHERPAD_TITLE=$'Freedombone Docs'
43
+ETHERPAD_WELCOME_MESSAGE=$"Welcome to ${ETHERPAD_TITLE}!\n\nThis pad text is synchronized as you type, so that everyone viewing this page sees the same text. This allows you to collaborate seamlessly on documents!"
44
+
45
+etherpad_variables=(ETHERPAD_COMMIT
46
+                    ONION_ONLY
47
+                    DEFAULT_DOMAIN_NAME
48
+                    ETHERPAD_DOMAIN_NAME
49
+                    ETHERPAD_CODE
50
+                    ETHERPAD_TITLE
51
+                    ETHERPAD_WELCOME_MESSAGE
52
+                    DDNS_PROVIDER
53
+                    MY_USERNAME)
54
+
55
+function create_etherpad_settings {
56
+    echo '{' > /var/www/$ETHERPAD_DOMAIN_NAME/htdocs/settings.json
57
+    echo "  \"title\": \"${ETHERPAD_TITLE}\"," >> /var/www/$ETHERPAD_DOMAIN_NAME/htdocs/settings.json
58
+    echo '  "favicon": "favicon.ico",' >> /var/www/$ETHERPAD_DOMAIN_NAME/htdocs/settings.json
59
+
60
+    echo '  "ip": "0.0.0.0",' >> /var/www/$ETHERPAD_DOMAIN_NAME/htdocs/settings.json
61
+    echo '  "port" : 9001,' >> /var/www/$ETHERPAD_DOMAIN_NAME/htdocs/settings.json
62
+
63
+    echo '  "showSettingsInAdminPage" : true,' >> /var/www/$ETHERPAD_DOMAIN_NAME/htdocs/settings.json
64
+
65
+    if [[ $ONION_ONLY == 'no' ]]; then
66
+        echo '  "ssl" : {' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
67
+        echo "            \"key\"  : \"/etc/ssl/private/${ETHERPAD_DOMAIN_NAME}.key\"," >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
68
+        echo "            \"cert\" : \"/etc/ssl/certs/${ETHERPAD_DOMAIN_NAME}.pem\"," >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
69
+        echo '          },' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
70
+    fi
71
+
72
+    echo '   "dbType" : "mysql",' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
73
+    echo '   "dbSettings" : {' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
74
+    echo '                    "user"    : "root",' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
75
+    echo '                    "host"    : "localhost",' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
76
+    echo "                    \"password\": \"${MARIADB_PASSWORD}\"," >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
77
+    echo '                    "database": "etherpad",' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
78
+    echo '                    "charset" : "utf8mb4"' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
79
+    echo '                  },' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
80
+
81
+    echo "  \"defaultPadText\" : \"${ETHERPAD_WELCOME_MESSAGE}\"," >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
82
+
83
+    echo '  "padOptions": {' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
84
+    echo '    "noColors": false,' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
85
+    echo '    "showControls": true,' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
86
+    echo '    "showChat": true,' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
87
+    echo '    "showLineNumbers": true,' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
88
+    echo '    "useMonospaceFont": false,' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
89
+    echo '    "userName": false,' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
90
+    echo '    "userColor": false,' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
91
+    echo '    "rtl": false,' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
92
+    echo '    "alwaysShowChat": false,' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
93
+    echo '    "chatAndUsers": false,' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
94
+    echo '    "lang": "en-gb"' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
95
+    echo '  },' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
96
+
97
+    echo '  "suppressErrorsInPadText" : true,' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
98
+
99
+    echo '  "requireSession" : false,' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
100
+
101
+    echo '  "editOnly" : false,' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
102
+
103
+    echo '  "sessionNoPassword" : false,' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
104
+
105
+    echo '  "minify" : true,' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
106
+
107
+    echo '  "maxAge" : 21600, // 60 * 60 * 6 = 6 hours' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
108
+
109
+    echo '  "abiword" : null,' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
110
+
111
+    echo '  "soffice" : null,' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
112
+
113
+    echo '  "tidyHtml" : null,' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
114
+
115
+    echo '  "allowUnknownFileEnds" : false,' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
116
+
117
+    echo '  "requireAuthentication" : true,' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
118
+
119
+    echo '  "requireAuthorization" : true,' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
120
+
121
+    echo '  "trustProxy" : false,' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
122
+
123
+    echo '  "disableIPlogging" : true,' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
124
+
125
+    echo '  "users": {' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
126
+    echo "    \"${MY_USERNAME}\": {" >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
127
+    echo "      \"password\": \"${ETHERPAD_ADMIN_PASSWORD}\"," >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
128
+    echo '      "is_admin": true' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
129
+    echo '    }' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
130
+    echo '  },' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
131
+
132
+    echo '  "socketTransportProtocols" : ["xhr-polling", "jsonp-polling", "htmlfile"],' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
133
+
134
+    echo '  "loadTest": false,' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
135
+
136
+    echo '  "indentationOnNewLine": false,' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
137
+
138
+    echo '  "toolbar": {' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
139
+    echo '    "left": [' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
140
+    echo '      ["bold", "italic", "underline", "strikethrough"],' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
141
+    echo '      ["orderedlist", "unorderedlist", "indent", "outdent"],' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
142
+    echo '      ["undo", "redo"],' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
143
+    echo '      ["clearauthorship"]' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
144
+    echo '    ],' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
145
+    echo '    "right": [' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
146
+    echo '      ["importexport", "timeslider", "savedrevision"],' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
147
+    echo '      ["settings", "embed"],' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
148
+    echo '      ["showusers"]' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
149
+    echo '    ],' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
150
+    echo '    "timeslider": [' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
151
+    echo '      ["timeslider_export", "timeslider_returnToPad"]' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
152
+    echo '    ]' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
153
+    echo '  },' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
154
+    echo '  "loglevel": "INFO",' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
155
+    echo '  "logconfig" :' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
156
+    echo '    { "appenders": [' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
157
+    echo '        { "type": "console"' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
158
+    echo '        //, "category": "access"// only logs pad access' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
159
+    echo '        }' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
160
+    echo '      , { "type": "logLevelFilter"' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
161
+    echo '        , "level": "error" // filters out all log messages that have a lower level than "error"' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
162
+    echo '        , "appender":' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
163
+    echo '          { "type": "smtp"' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
164
+    echo '          , "subject": "[Admin] An error occured in your Etherpad instance!"' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
165
+    echo "          , \"recipients\": \"admin@${DEFAULT_DOMAIN_NAME}\"" >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
166
+    echo '          , "sendInterval": 300 // 60 * 5 = 5 minutes -- will buffer log messages; set to 0 to send a mail for every message' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
167
+    echo '          , "transport": "SMTP", "SMTP": { // see https://github.com/andris9/Nodemailer#possible-transport-methods' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
168
+    echo '              "host": "localhost", "port": 25,' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
169
+    echo '              "secureConnection": false,' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
170
+    echo '            }' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
171
+    echo '          }' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
172
+    echo '      ]' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
173
+    echo '    }' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
174
+    echo '}' >> /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
175
+}
176
+
177
+function remove_user_etherpad {
178
+    remove_username="$1"
179
+    read_config_param ETHERPAD_DOMAIN_NAME
180
+
181
+    if ! grep -q "\"${remove_username}\": {" /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json; then
182
+        sed -i "/\"${remove_username}\": {/,/},/d" /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
183
+    fi
184
+}
185
+
186
+function add_user_etherpad {
187
+    new_username="$1"
188
+    new_user_password="$2"
189
+    read_config_param ETHERPAD_DOMAIN_NAME
190
+    if ! grep -q "\"${new_username}\": {" /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json; then
191
+        sed -i "/\"users\": {/a    \"${new_username}\": {
192
+      \"password\": \"${new_user_password}\",
193
+      \"is_admin\": false
194
+    }," /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs/settings.json
195
+    fi
196
+}
197
+
198
+function install_interactive_etherpad {
199
+    if [ ! $ONION_ONLY ]; then
200
+        ONION_ONLY='no'
201
+    fi
202
+
203
+    if [[ $ONION_ONLY != "no" ]]; then
204
+        ETHERPAD_DOMAIN_NAME='etherpad.local'
205
+        write_config_param "ETHERPAD_DOMAIN_NAME" "$ETHERPAD_DOMAIN_NAME"
206
+    else
207
+        function_check interactive_site_details
208
+        interactive_site_details "etherpad" "ETHERPAD_DOMAIN_NAME" "ETHERPAD_CODE"
209
+    fi
210
+    APP_INSTALLED=1
211
+}
212
+
213
+function etherpad_set_title {
214
+    read_config_param "ETHERPAD_TITLE"
215
+    data=$(tempfile 2>/dev/null)
216
+    trap "rm -f $data" 0 1 2 5 15
217
+    dialog --title $"Etherpad Title" \
218
+           --backtitle $"Freedombone Control Panel" \
219
+           --inputbox $'Set a title for your etherpad system' 10 60 "$ETHERPAD_TITLE" 2>$data
220
+    sel=$?
221
+    case $sel in
222
+        0)
223
+            temp_title=$(<$data)
224
+            if [ ${#temp_title} -gt 0 ]; then
225
+                ETHERPAD_TITLE="$temp_title"
226
+                settings_file=/var/www/$ETHERPAD_DOMAIN_NAME/htdocs/settings.json
227
+
228
+                write_config_param "ETHERPAD_TITLE" "$ETHERPAD_TITLE"
229
+                sed -i "s|\"title\":.*|\"title\": \"${ETHERPAD_TITLE}\"|g" $settings_file
230
+
231
+                dialog --title $"Etherpad Title" \
232
+                       --msgbox $"Title has been set" 6 60
233
+            fi
234
+           ;;
235
+    esac
236
+}
237
+
238
+function etherpad_set_welcome_message {
239
+    read_config_param "ETHERPAD_WELCOME_MESSAGE"
240
+    data=$(tempfile 2>/dev/null)
241
+    trap "rm -f $data" 0 1 2 5 15
242
+    dialog --title $"Etherpad Welcome Message" \
243
+           --backtitle $"Freedombone Control Panel" \
244
+           --inputbox $'Set a welcome message, which can include html formatting' 10 60 "$ETHERPAD_WELCOME_MESSAGE" 2>$data
245
+    sel=$?
246
+    case $sel in
247
+        0)
248
+            temp_welcome=$(<$data)
249
+            if [ ${#temp_welcome} -gt 0 ]; then
250
+                ETHERPAD_WELCOME_MESSAGE="$temp_welcome"
251
+                settings_file=/var/www/$ETHERPAD_DOMAIN_NAME/htdocs/settings.json
252
+
253
+                write_config_param "ETHERPAD_WELCOME_MESSAGE" "$ETHERPAD_WELCOME_MESSAGE"
254
+                sed -i "s|\"defaultPadText\" :.*|\"defaultPadText\" : \"${ETHERPAD_WELCOME_MESSAGE}\"|g" $settings_file
255
+
256
+                dialog --title $"Etherpad Welcome Message" \
257
+                       --msgbox $"Welcome message has been set" 6 60
258
+            fi
259
+           ;;
260
+    esac
261
+}
262
+
263
+function configure_interactive_etherpad {
264
+    while true
265
+    do
266
+        data=$(tempfile 2>/dev/null)
267
+        trap "rm -f $data" 0 1 2 5 15
268
+        dialog --backtitle $"Freedombone Control Panel" \
269
+               --title $"Etherpad Settings" \
270
+               --radiolist $"Choose an operation:" 12 70 3 \
271
+               1 $"Set Title" off \
272
+               2 $"Set a welcome message" off \
273
+               3 $"Exit" on 2> $data
274
+        sel=$?
275
+        case $sel in
276
+            1) return;;
277
+            255) return;;
278
+        esac
279
+        case $(cat $data) in
280
+            1) etherpad_set_title;;
281
+            2) etherpad_set_welcome_message;;
282
+            3) break;;
283
+        esac
284
+    done
285
+}
286
+
287
+function reconfigure_etherpad {
288
+    create_etherpad_settings
289
+    systemctl restart etherpad
290
+}
291
+
292
+function upgrade_etherpad {
293
+    read_config_param "ETHERPAD_DOMAIN_NAME"
294
+
295
+    function_check set_repo_commit
296
+    set_repo_commit /var/www/$ETHERPAD_DOMAIN_NAME/htdocs "etherpad commit" "$ETHERPAD_COMMIT" $ETHERPAD_REPO
297
+}
298
+
299
+function backup_local_etherpad {
300
+    ETHERPAD_DOMAIN_NAME='etherpad'
301
+    if grep -q "etherpad domain" $COMPLETION_FILE; then
302
+        ETHERPAD_DOMAIN_NAME=$(get_completion_param "etherpad domain")
303
+    fi
304
+
305
+    source_directory=/var/www/${ETHERPAD_DOMAIN_NAME}/htdocs
306
+    if [ -d $source_directory ]; then
307
+        dest_directory=etherpad
308
+        function_check suspend_site
309
+        suspend_site ${ETHERPAD_DOMAIN_NAME}
310
+
311
+        function_check backup_directory_to_usb
312
+        backup_directory_to_usb $source_directory $dest_directory
313
+
314
+        function_check backup_database_to_usb
315
+        backup_database_to_usb etherpad
316
+
317
+        function_check restart_site
318
+        restart_site
319
+    fi
320
+}
321
+
322
+function restore_local_etherpad {
323
+    if ! grep -q "etherpad domain" $COMPLETION_FILE; then
324
+        return
325
+    fi
326
+    ETHERPAD_DOMAIN_NAME=$(get_completion_param "etherpad domain")
327
+    if [ $ETHERPAD_DOMAIN_NAME ]; then
328
+        temp_restore_dir=/root/tempetherpad
329
+        etherpad_dir=/var/www/${ETHERPAD_DOMAIN_NAME}/htdocs
330
+
331
+        function_check etherpad_create_database
332
+        etherpad_create_database
333
+
334
+        restore_database etherpad ${ETHERPAD_DOMAIN_NAME}
335
+        if [ -d $temp_restore_dir ]; then
336
+            rm -rf $temp_restore_dir
337
+        fi
338
+
339
+        chown -R etherpad: /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs
340
+        if [ -f /etc/ssl/certs/${ETHERPAD_DOMAIN_NAME}.pem ]; then
341
+            chown etherpad: /etc/ssl/certs/${ETHERPAD_DOMAIN_NAME}.pem
342
+        fi
343
+        if [ -f /etc/ssl/private/${ETHERPAD_DOMAIN_NAME}.key ]; then
344
+            chown etherpad: /etc/ssl/private/${ETHERPAD_DOMAIN_NAME}.key
345
+        fi
346
+    fi
347
+}
348
+
349
+function backup_remote_etherpad {
350
+    if grep -q "etherpad domain" $COMPLETION_FILE; then
351
+        ETHERPAD_DOMAIN_NAME=$(get_completion_param "etherpad domain")
352
+        temp_backup_dir=/var/www/${ETHERPAD_DOMAIN_NAME}/htdocs
353
+        if [ -d $temp_backup_dir ]; then
354
+            function_check suspend_site
355
+            suspend_site ${ETHERPAD_DOMAIN_NAME}
356
+
357
+            function_check backup_database_to_friend
358
+            backup_database_to_friend etherpad
359
+
360
+            function_check backup_directory_to_friend
361
+            backup_directory_to_friend $temp_backup_dir etherpad
362
+
363
+            function_check restart_site
364
+            restart_site
365
+        else
366
+            echo $"etherpad domain specified but not found in ${temp_backup_dir}"
367
+        fi
368
+    fi
369
+}
370
+
371
+function restore_remote_etherpad {
372
+    if grep -q "etherpad domain" $COMPLETION_FILE; then
373
+        ETHERPAD_DOMAIN_NAME=$(get_completion_param "etherpad domain")
374
+
375
+        function_check etherpad_create_database
376
+        etherpad_create_database
377
+
378
+        function_check restore_database_from_friend
379
+        restore_database_from_friend etherpad ${ETHERPAD_DOMAIN_NAME}
380
+        if [ -d /root/tempetherpad ]; then
381
+            rm -rf /root/tempetherpad
382
+        fi
383
+
384
+        chown -R etherpad: /var/www/${ETHERPAD_DOMAIN_NAME}/htdocs
385
+        if [ -f /etc/ssl/certs/${ETHERPAD_DOMAIN_NAME}.pem ]; then
386
+            chown etherpad: /etc/ssl/certs/${ETHERPAD_DOMAIN_NAME}.pem
387
+        fi
388
+        if [ -f /etc/ssl/private/${ETHERPAD_DOMAIN_NAME}.key ]; then
389
+            chown etherpad: /etc/ssl/private/${ETHERPAD_DOMAIN_NAME}.key
390
+        fi
391
+    fi
392
+}
393
+
394
+function remove_etherpad {
395
+    if [ ${#ETHERPAD_DOMAIN_NAME} -eq 0 ]; then
396
+        return
397
+    fi
398
+    read_config_param "ETHERPAD_DOMAIN_NAME"
399
+    read_config_param "MY_USERNAME"
400
+    echo "Removing $ETHERPAD_DOMAIN_NAME"
401
+    if [ -f /etc/systemd/system/etherpad.service ]; then
402
+        systemctl stop etherpad
403
+        systemctl disable etherpad
404
+        rm /etc/systemd/system/etherpad.service
405
+    fi
406
+    nginx_dissite $ETHERPAD_DOMAIN_NAME
407
+    remove_certs $ETHERPAD_DOMAIN_NAME
408
+    if [ -d /var/www/$ETHERPAD_DOMAIN_NAME ]; then
409
+        rm -rf /var/www/$ETHERPAD_DOMAIN_NAME
410
+    fi
411
+    if [ -f /etc/nginx/sites-available/$ETHERPAD_DOMAIN_NAME ]; then
412
+        rm /etc/nginx/sites-available/$ETHERPAD_DOMAIN_NAME
413
+    fi
414
+    function_check drop_database
415
+    drop_database etherpad
416
+    function_check remove_onion_service
417
+    remove_onion_service etherpad ${ETHERPAD_ONION_PORT}
418
+    remove_app etherpad
419
+    remove_completion_param install_etherpad
420
+    sed -i '/etherpad/d' $COMPLETION_FILE
421
+    sed -i '/Etherpad/d' /home/$MY_USERNAME/README
422
+    remove_backup_database_local etherpad
423
+    deluser --remove-all-files etherpad
424
+    remove_nodejs etherpad
425
+}
426
+
427
+function install_etherpad {
428
+    if [ ! $ETHERPAD_DOMAIN_NAME ]; then
429
+        echo $'No domain name was given for etherpad'
430
+        exit 7359
431
+    fi
432
+
433
+    function_check install_mariadb
434
+    install_mariadb
435
+
436
+    function_check get_mariadb_password
437
+    get_mariadb_password
438
+
439
+    function_check repair_databases_script
440
+    repair_databases_script
441
+
442
+    apt-get -yq install gzip git curl python libssl-dev pkg-config \
443
+            build-essential python g++ make checkinstall
444
+
445
+    function_check install_nodejs
446
+    install_nodejs etherpad
447
+
448
+    if [ ! -d /var/www/$ETHERPAD_DOMAIN_NAME ]; then
449
+        mkdir /var/www/$ETHERPAD_DOMAIN_NAME
450
+    fi
451
+    if [ ! -d /var/www/$ETHERPAD_DOMAIN_NAME/htdocs ]; then
452
+        function_check git_clone
453
+        git_clone $ETHERPAD_REPO /var/www/$ETHERPAD_DOMAIN_NAME/htdocs
454
+        if [ ! -d /var/www/$ETHERPAD_DOMAIN_NAME/htdocs ]; then
455
+            echo $'Unable to clone etherpad repo'
456
+            exit 56382
457
+        fi
458
+    fi
459
+
460
+    cd /var/www/$ETHERPAD_DOMAIN_NAME/htdocs
461
+    git checkout $ETHERPAD_COMMIT -b $ETHERPAD_COMMIT
462
+    set_completion_param "etherpad commit" "$ETHERPAD_COMMIT"
463
+
464
+    chmod a+w /var/www/$ETHERPAD_DOMAIN_NAME/htdocs
465
+    chown www-data:www-data /var/www/$ETHERPAD_DOMAIN_NAME/htdocs
466
+
467
+    function_check etherpad_create_database
468
+    etherpad_create_database
469
+
470
+    function_check add_ddns_domain
471
+    add_ddns_domain $ETHERPAD_DOMAIN_NAME
472
+
473
+    if [ ! $ETHERPAD_ADMIN_PASSWORD ]; then
474
+        if [ -f $IMAGE_PASSWORD_FILE ]; then
475
+            ETHERPAD_ADMIN_PASSWORD="$(printf `cat $IMAGE_PASSWORD_FILE`)"
476
+        else
477
+            ETHERPAD_ADMIN_PASSWORD="$(create_password ${MINIMUM_PASSWORD_LENGTH})"
478
+        fi
479
+    fi
480
+
481
+    create_etherpad_settings
482
+
483
+    adduser --system --home=/var/www/$ETHERPAD_DOMAIN_NAME/htdocs/ --group etherpad
484
+    chown -R etherpad: /var/www/$ETHERPAD_DOMAIN_NAME/htdocs/
485
+
486
+    echo '[Unit]' > /etc/systemd/system/etherpad.service
487
+    echo 'Description=etherpad-lite (real-time collaborative document editing)' >> /etc/systemd/system/etherpad.service
488
+    echo 'After=syslog.target network.target' >> /etc/systemd/system/etherpad.service
489
+    echo '' >> /etc/systemd/system/etherpad.service
490
+    echo '[Service]' >> /etc/systemd/system/etherpad.service
491
+    echo 'Type=simple' >> /etc/systemd/system/etherpad.service
492
+    echo 'User=etherpad-lite' >> /etc/systemd/system/etherpad.service
493
+    echo 'Group=etherpad-lite' >> /etc/systemd/system/etherpad.service
494
+    echo "ExecStart=/var/www/$ETHERPAD_DOMAIN_NAME/htdocs//bin/run.sh" >> /etc/systemd/system/etherpad.service
495
+    echo '' >> /etc/systemd/system/etherpad.service
496
+    echo '[Install]' >> /etc/systemd/system/etherpad.service
497
+    echo 'WantedBy=multi-user.target' >> /etc/systemd/system/etherpad.service
498
+    chmod +x /etc/systemd/system/etherpad.service
499
+
500
+    etherpad_nginx_site=/etc/nginx/sites-available/$ETHERPAD_DOMAIN_NAME
501
+    if [[ $ONION_ONLY == "no" ]]; then
502
+        function_check nginx_http_redirect
503
+        nginx_http_redirect $ETHERPAD_DOMAIN_NAME
504
+        echo 'server {' >> $etherpad_nginx_site
505
+        echo '  listen 443 ssl;' >> $etherpad_nginx_site
506
+        echo "  server_name $ETHERPAD_DOMAIN_NAME;" >> $etherpad_nginx_site
507
+        echo '' >> $etherpad_nginx_site
508
+        echo '  # Security' >> $etherpad_nginx_site
509
+        function_check nginx_ssl
510
+        nginx_ssl $ETHERPAD_DOMAIN_NAME
511
+
512
+        function_check nginx_disable_sniffing
513
+        nginx_disable_sniffing $ETHERPAD_DOMAIN_NAME
514
+
515
+        echo '  add_header Strict-Transport-Security max-age=15768000;' >> $etherpad_nginx_site
516
+        echo '' >> $etherpad_nginx_site
517
+        echo '  # Logs' >> $etherpad_nginx_site
518
+        echo '  access_log off;' >> $etherpad_nginx_site
519
+        echo '  error_log off;' >> $etherpad_nginx_site
520
+        echo '' >> $etherpad_nginx_site
521
+        echo '  # Root' >> $etherpad_nginx_site
522
+        echo "  root /var/www/$ETHERPAD_DOMAIN_NAME/htdocs;" >> $etherpad_nginx_site
523
+        echo '' >> $etherpad_nginx_site
524
+        echo '  location / {' >> $etherpad_nginx_site
525
+        function_check nginx_limits
526
+        nginx_limits $ETHERPAD_DOMAIN_NAME '15m'
527
+        echo '    proxy_pass        http://localhost:9001/;' >> $etherpad_nginx_site
528
+        echo '    proxy_set_header  Host $host;' >> $etherpad_nginx_site
529
+        echo '    proxy_buffering   off;' >> $etherpad_nginx_site
530
+        echo '  }' >> $etherpad_nginx_site
531
+        echo '}' >> $etherpad_nginx_site
532
+    else
533
+        echo -n '' > $etherpad_nginx_site
534
+    fi
535
+    echo 'server {' >> $etherpad_nginx_site
536
+    echo "    listen 127.0.0.1:$ETHERPAD_ONION_PORT default_server;" >> $etherpad_nginx_site
537
+    echo "    server_name $ETHERPAD_DOMAIN_NAME;" >> $etherpad_nginx_site
538
+    echo '' >> $etherpad_nginx_site
539
+    function_check nginx_disable_sniffing
540
+    nginx_disable_sniffing $ETHERPAD_DOMAIN_NAME
541
+    echo '' >> $etherpad_nginx_site
542
+    echo '  # Logs' >> $etherpad_nginx_site
543
+    echo '  access_log off;' >> $etherpad_nginx_site
544
+    echo '  error_log off;' >> $etherpad_nginx_site
545
+    echo '' >> $etherpad_nginx_site
546
+    echo '  # Root' >> $etherpad_nginx_site
547
+    echo "  root /var/www/$ETHERPAD_DOMAIN_NAME/htdocs;" >> $etherpad_nginx_site
548
+    echo '' >> $etherpad_nginx_site
549
+    echo '  location / {' >> $etherpad_nginx_site
550
+    function_check nginx_limits
551
+    nginx_limits $ETHERPAD_DOMAIN_NAME '15m'
552
+    echo '    proxy_pass        http://localhost:9001/;' >> $etherpad_nginx_site
553
+    echo '    proxy_set_header  Host $host;' >> $etherpad_nginx_site
554
+    echo '    proxy_buffering   off;' >> $etherpad_nginx_site
555
+    echo '  }' >> $etherpad_nginx_site
556
+    echo '}' >> $etherpad_nginx_site
557
+
558
+    function_check create_site_certificate
559
+    create_site_certificate $ETHERPAD_DOMAIN_NAME 'yes'
560
+
561
+    if [ -f /etc/ssl/certs/${ETHERPAD_DOMAIN_NAME}.crt ]; then
562
+        mv /etc/ssl/certs/${ETHERPAD_DOMAIN_NAME}.crt /etc/ssl/certs/${ETHERPAD_DOMAIN_NAME}.pem
563
+    fi
564
+    if [ -f /etc/ssl/certs/${ETHERPAD_DOMAIN_NAME}.pem ]; then
565
+        chown etherpad: /etc/ssl/certs/${ETHERPAD_DOMAIN_NAME}.pem
566
+    fi
567
+    if [ -f /etc/ssl/private/${ETHERPAD_DOMAIN_NAME}.key ]; then
568
+        chown etherpad: /etc/ssl/private/${ETHERPAD_DOMAIN_NAME}.key
569
+    fi
570
+
571
+    # Ensure that the database gets backed up locally, if remote
572
+    # backups are not being used
573
+    function_check backup_databases_script_header
574
+    backup_databases_script_header
575
+
576
+    function_check backup_database_local
577
+    backup_database_local etherpad
578
+
579
+    function_check nginx_ensite
580
+    nginx_ensite $ETHERPAD_DOMAIN_NAME
581
+
582
+    ETHERPAD_ONION_HOSTNAME=$(add_onion_service etherpad 80 ${ETHERPAD_ONION_PORT})
583
+
584
+    # some post-install instructions for the user
585
+    if ! grep -q $"Etherpad administrator" /home/$MY_USERNAME/README; then
586
+        echo '' >> /home/$MY_USERNAME/README
587
+        echo $'# Etherpad' >> /home/$MY_USERNAME/README
588
+        echo $"Etherpad administrator nickname: $MY_USERNAME" >> /home/$MY_USERNAME/README
589
+        echo $"Etherpad administrator password: $ETHERPAD_ADMIN_PASSWORD" >> /home/$MY_USERNAME/README
590
+        chown $MY_USERNAME:$MY_USERNAME /home/$MY_USERNAME/README
591
+        chmod 600 /home/$MY_USERNAME/README
592
+    else
593
+        if [ -f /home/$MY_USERNAME/README ]; then
594
+            sed -i "s|Etherpad administrator password.*|Etherpad administrator password: $ETHERPAD_ADMIN_PASSWORD|g" /home/$MY_USERNAME/README
595
+        fi
596
+    fi
597
+
598
+    if ! grep -q "Etherpad onion domain" /home/$MY_USERNAME/README; then
599
+        echo $"Etherpad onion domain: ${ETHERPAD_ONION_HOSTNAME}" >> /home/$MY_USERNAME/README
600
+        echo '' >> /home/$MY_USERNAME/README
601
+        chown $MY_USERNAME:$MY_USERNAME /home/$MY_USERNAME/README
602
+        chmod 600 /home/$MY_USERNAME/README
603
+    else
604
+        if [ -f /home/$MY_USERNAME/README ]; then
605
+            sed -i "s|Etherpad onion domain.*|Etherpad onion domain: ${ETHERPAD_ONION_HOSTNAME}|g" /home/$MY_USERNAME/README
606
+        fi
607
+    fi
608
+
609
+    set_completion_param "etherpad domain" "$ETHERPAD_DOMAIN_NAME"
610
+
611
+    systemctl enable etherpad
612
+    systemctl daemon-reload
613
+    systemctl start etherpad
614
+    systemctl restart nginx
615
+
616
+    APP_INSTALLED=1
617
+}