Πώς να κάνετε self-hosting του Etherpad το 2026: pads, plugins και αντίγραφα ασφαλείας βάσης δεδομένων

Αν έχετε ήδη δοκιμάσει να κάνετε self-hosting του Etherpad, πιθανότατα γνωρίζετε αυτή την απογοητευτική κατάσταση: το UI εμφανίζεται, αλλά οι sessions αποσυνδέονται επειδή τα proxy timeouts είναι πολύ μικρά. Η αναδημιουργία του container σπάνια διορθώνει μια ασυμφωνία μεταξύ URLs, state και dependencies.

Αυτός ο οδηγός χρησιμοποιεί ένα συγκεκριμένο κριτήριο επιτυχούς ολοκλήρωσης — να ανοίξετε ένα pad σε δύο browsers, να επεξεργαστείτε ταυτόχρονα, να ελέγξετε τα revisions και να κάνετε export του αποτελέσματος στην απαιτούμενη μορφή. Κάθε επιλογή διαμόρφωσης αξιολογείται με βάση αυτό το κριτήριο και όχι με βάση μια πράσινη ένδειξη του container.

Επιλέξτε την ελάχιστη βιώσιμη τοπολογία Etherpad

Η ελάχιστη υπεύθυνη τοπολογία Etherpad περιλαμβάνει έναν private listener στο 9001, ένα ingress route και ένα τεκμηριωμένο όριο state. Το network contract για χρήση του Etherpad από πολλούς χρήστες με durable data είναι το Postgres ή άλλη υποστηριζόμενη βάση δεδομένων. Κρατήστε τα private endpoints σε internal DNS, επιτρέψτε μόνο τις απαιτούμενες outbound κλήσεις και δώστε στο Etherpad ένα service credential με περιορισμένα δικαιώματα.

Επικυρώστε την τοπολογία ζητώντας από έναν clean client να ανοίξει ένα pad σε δύο browsers, να επεξεργαστεί ταυτόχρονα, να ελέγξει τα revisions και να κάνει export του αποτελέσματος στην απαιτούμενη μορφή. Παρακολουθήστε τις WebSocket sessions, το revision count, τις εγγραφές στη βάση δεδομένων και την εκτέλεση των plugins όσο εκτελείται η διαδικασία. Το αποτέλεσμα δείχνει αν η επόμενη βελτίωση ανήκει στη μνήμη, στο storage, στο networking ή σε ξεχωριστό worker, αντί να σας ενθαρρύνει να αυξήσετε αυθαίρετα το μέγεθος του container.

Δημιουργήστε ένα Etherpad container που αντικαθίσταται εύκολα

Χρησιμοποιήστε το container ως runtime που μπορεί να αντικατασταθεί και όχι ως το σημείο όπου βρίσκεται η αλήθεια.

docker run -d \
  --name etherpad \
  --restart unless-stopped \
  -p 127.0.0.1:9001:9001 \
  -v etherpad-data:/opt/etherpad-lite/var \
  -e ADMIN_PASSWORD=replace-with-a-long-random-value \
  etherpad/etherpad:latest

Προσθέστε τις ελεγμένες ρυθμίσεις σύνδεσης για το Postgres ή άλλη υποστηριζόμενη βάση δεδομένων για χρήση από πολλούς χρήστες με durable data· χρησιμοποιήστε private names για private services. Ελέγξτε τον user του container, τα writable paths και τον listener που έχει γίνει bind πριν το εκθέσετε. Εκτελέστε την πλήρη διαδικασία — ανοίξτε ένα pad σε δύο browsers, επεξεργαστείτε ταυτόχρονα, ελέγξτε τα revisions και κάντε export του αποτελέσματος στην απαιτούμενη μορφή — και αποθηκεύστε το ακριβές image reference που παρήγαγε το αποτέλεσμα.

Αποτρέψτε την επιτυχία του proxy από το να καλύψει μια αστοχία της εφαρμογής

Το browser, ο API client και το Etherpad πρέπει να συμφωνούν σε ένα origin. Για να το πετύχετε, ορίστε το public URL και υποστήριξη proxy WebSocket. Διατηρήστε το αρχικό host και protocol, κρατώντας παράλληλα το port 9001 μη διαθέσιμο ως ανταγωνιστική public address.

Ο οδηγός αντιμετώπισης προβλημάτων για site που δεν είναι διαθέσιμο βοηθά να ξεχωρίσετε ένα unreachable route από μια εφαρμογή που ανταποκρίνεται. Η διάκριση αυτή είναι σημαντική εδώ: οι sessions αποσυνδέονται επειδή τα proxy timeouts είναι πολύ μικρά. Μόνο η πρώτη περίπτωση διορθώνεται με αλλαγές στο ingress· η δεύτερη απαιτεί έλεγχο των Etherpad logs, του state ή του workload.

Σχεδιάστε το restore του Etherpad πριν από το launch

Προστατέψτε το state του Etherpad πριν βελτιστοποιήσετε το container του. Το απαιτούμενο σύνολο αποτελείται από τη βάση δεδομένων, τα uploaded plugins και τις ρυθμίσεις. Κάντε mount το /opt/etherpad-lite/var πριν από το bootstrap, γράψτε ακίνδυνα sample data και αντικαταστήστε το container, ώστε να αποδείξετε ότι η συγκεκριμένη διαδρομή είναι πράγματι persistent. Αν πρέπει να συμφωνούν πολλά stores, τεκμηριώστε τη σειρά με την οποία διακόπτονται οι εγγραφές και λαμβάνονται τα backups.

Κρατήστε αντίγραφα εκτός του deployment server και κρυπτογραφήστε υλικό που περιέχει credentials ή private content. Η ανάκτηση είναι επιτυχής όταν επιστρέφουν τα pads, οι authors, τα revisions και τα plugins και οι ταυτόχρονες επεξεργασίες εξακολουθούν να συγκλίνουν. Η διάκριση μεταξύ ενός persistent mount και ενός ανεξάρτητου αντιγράφου καλύπτεται στο persistent storage και snapshots.

Επιλέξτε το trust boundary του Etherpad

Κλείστε το bootstrap window μόλις υπάρξει ο πρώτος έμπιστος administrator. Η συγκεκριμένη παγίδα του Etherpad είναι να διανεμηθεί με γνωστό admin password ή να παραμείνουν τα pads writable από όλους· το ασφαλέστερο όριο είναι να ορίσετε πραγματικό admin password, να αποφασίσετε ποιοι επιτρέπεται να δημιουργούν pads και να μην θεωρείτε ότι ένα δυσνόητο pad URL είναι private.

Αντικαταστήστε αμέσως το ενδεικτικό ADMIN_PASSWORD, αποθηκεύστε το εκτός του image και κάντε rotation όπως θα κάνατε με administrator credential αν εκτεθεί. Το private networking πρέπει να μεταφέρει τα credentials των dependencies, ενώ οι ρόλοι μέσα στο Etherpad πρέπει να παρέχουν τα απολύτως απαραίτητα δικαιώματα. Μην καταγράφετε sensitive request bodies και provider responses στα routine logs.

Κάντε upgrade του Etherpad χωρίς εικασίες

Παρατηρήστε την εργασία που εκτελεί το Etherpad: WebSocket sessions, revision count, εγγραφές στη βάση δεδομένων και εκτέλεση plugins. Ορίστε limits με επαρκές headroom για αυτή την εργασία και αποφύγετε ένα liveness probe που ανταγωνίζεται την εκτέλεσή της. Ο operator check πρέπει και πάλι να επιχειρεί, σε προγραμματισμένο διάστημα, να ανοίξει ένα pad σε δύο browsers, να επεξεργαστεί ταυτόχρονα, να ελέγξει τα revisions και να κάνει export του αποτελέσματος στην απαιτούμενη μορφή.

Για τα updates, θυμηθείτε ότι οι εκδόσεις των Etherpad plugins, το syntax των ρυθμίσεων και τα database migrations πρέπει να ελέγχονται μαζί. Κάντε deploy τον υποψήφιο version απέναντι σε ένα recovered copy και επαναλάβετε το γνωστό test. Αν οι sessions αποσυνδέονται επειδή τα proxy timeouts είναι πολύ μικρά, χρησιμοποιήστε τα runtime logs και το πραγματικό network request για να εντοπίσετε ποια παραδοχή άλλαξε.

Τι πρέπει να περνά πριν φτάσουν πραγματικά δεδομένα στο Etherpad

Για το Etherpad, ορίστε μια known-good transaction πριν από το launch: ανοίξτε ένα pad σε δύο browsers, επεξεργαστείτε ταυτόχρονα, ελέγξτε τα revisions και κάντε export του αποτελέσματος στην απαιτούμενη μορφή. Καταγράψτε τα prerequisites, την αναμενόμενη απόκριση και τα βήματα cleanup σε version control, χωρίς secret values. Κάντε pin το image που χρησιμοποιήθηκε για να καθιερωθεί αυτή η αναφορά.

Χρησιμοποιήστε τη transaction για να επικυρώσετε μια αντικατάσταση και ένα ανεξάρτητο restore. Το restored service είναι αποδεκτό μόνο όταν επιστρέφουν τα pads, οι authors, τα revisions και τα plugins και οι ταυτόχρονες επεξεργασίες εξακολουθούν να συγκλίνουν. Παράλληλα, παρακολουθήστε τις WebSocket sessions, το revision count, τις εγγραφές στη βάση δεδομένων και την εκτέλεση των plugins και μετατρέψτε το πιο αργό ή πιο περιορισμένο τμήμα σε service-level alert.

Το gate χρειάζεται επίσης μια negative case: αρνηθείτε προσωρινά στην test identity την πρόσβαση στο Postgres ή σε άλλη υποστηριζόμενη βάση δεδομένων για χρήση από πολλούς χρήστες με durable data. Επιβεβαιώστε ότι το Etherpad παράγει actionable error διατηρώντας τα δεδομένα, επαναφέρετε τη σωστή κατάσταση και επαναλάβετε την known-good transaction. Η διατήρηση και των δύο αποτελεσμάτων αποτρέπει ένα superficial health endpoint από το να γίνει το μοναδικό production evidence.

Κάντε deploy το Etherpad στο Dockup χωρίς να χάσετε τα όριά του

Για το Etherpad, το Dockup είναι πιο χρήσιμο στο όριο μεταξύ ενός image και ενός durable service. Διατηρεί συνδεδεμένα το route προς το 9001, το TLS, τις secret values και το storage κατά τις αντικαταστάσεις των containers, είτε το compute ανήκει στο Dockup είτε στον attached server σας.

Ολοκληρώστε με γνώση της εφαρμογής: ορίστε το public URL και υποστήριξη proxy WebSocket· συνδεθείτε σε και ελέγξτε το Postgres ή άλλη υποστηριζόμενη βάση δεδομένων για χρήση από πολλούς χρήστες με durable data· και εκτελέστε την εξής επαλήθευση: ανοίξτε ένα pad σε δύο browsers, επεξεργαστείτε ταυτόχρονα, ελέγξτε τα revisions και κάντε export του αποτελέσματος στην απαιτούμενη μορφή. Κρατήστε το αποτέλεσμα ως deployment check, ώστε το επόμενο image update να αξιολογείται με βάση τη συμπεριφορά και όχι την κατάσταση του container.

Συχνές ερωτήσεις

Τι χρειάζεται το Etherpad για deployment σε production;

Δρομολογήστε το Etherpad container στο port 9001 μέσω ενός HTTPS origin. Η supporting network requirement είναι το Postgres ή άλλη υποστηριζόμενη βάση δεδομένων για χρήση από πολλούς χρήστες με durable data. Μην θεωρήσετε το Etherpad έτοιμο μέχρι να μπορείτε να ανοίξετε ένα pad σε δύο browsers, να επεξεργαστείτε ταυτόχρονα, να ελέγξετε τα revisions και να κάνετε export του αποτελέσματος στην απαιτούμενη μορφή.

Ποια δεδομένα του Etherpad πρέπει να περιλαμβάνονται σε backup;

Κάντε persist το /opt/etherpad-lite/var και συμπεριλάβετε τη βάση δεδομένων, τα uploaded plugins και τις ρυθμίσεις στο ίδιο recovery manifest. Ένα καθαρό Etherpad restore είναι επιτυχές μόνο όταν επιστρέφουν τα pads, οι authors, τα revisions και τα plugins και οι ταυτόχρονες επεξεργασίες εξακολουθούν να συγκλίνουν.

Απαιτεί το Etherpad HTTPS πίσω από reverse proxy;

Χρησιμοποιήστε HTTPS για το public Etherpad origin και κρατήστε το port 9001 στο internal route. Εφαρμόστε σωστά τη ρύθμιση του Etherpad: ορίστε το public URL και υποστήριξη proxy WebSocket. Για το Etherpad, το HTTPS προστατεύει credentials ή user content κατά τη μεταφορά και διατηρεί συνεπή τη συμπεριφορά του client που εξαρτάται από το origin.

Πώς πρέπει να ελεγχθεί ένα Etherpad upgrade;

Κάντε restore το τρέχον state του Etherpad σε ένα isolated deployment, εφαρμόστε την υποψήφια έκδοση και επαναλάβετε τη transaction αποδοχής. Δώστε ιδιαίτερη προσοχή, επειδή οι εκδόσεις των Etherpad plugins, το syntax των ρυθμίσεων και τα database migrations πρέπει να ελέγχονται μαζί. Κρατήστε το προηγούμενο Etherpad image μέχρι να κατανοήσετε τα όρια του data migration και του rollback.