[SUPPORT] SmartPhoneLover - Etherpad (Real-time Collaborative Editor)


Recommended Posts

etherpad_banner.png

 

This docker template was created based on an already available official docker image

 

WebSite: https://etherpad.org/
GitHub: https://github.com/ether/etherpad-lite
DockerHub: https://hub.docker.com/r/etherpad/etherpad

Documentation (1): https://etherpad.org/doc/v1.8.16/
Documentation (2): https://github.com/ether/etherpad-lite/wiki
My Repository: https://github.com/SmartPhoneLover/unraid-docker-templates

 

DESCRIPTION
Etherpad is a real-time collaborative editor scalable to thousands of simultaneous real time users. It provides full data export capabilities, and runs on your server, under your control.

 

Here you will find some examples of different types of implementations for Etherpad, in live demos:
https://github.com/ether/etherpad-lite#try-it-out

 

NOTES
• This container works with an embedded database (DirtyDB) is no external database is configured (template), but you can use your own if you want, like: MariaDB, MySQL, MongoDB, PostgreSQL, and some more. Check 'https://www.npmjs.com/package/ueberdb2' to know more about them, and 'https://github.com/ether/etherpad-lite/blob/develop/doc/docker.md#database' to know how to configure them inside the template.
• This template includes only the most basic variables, but you have many many others to use and fully configure Etherpad. Check 'https://github.com/ether/etherpad-lite/blob/develop/doc/docker.md' to know more.
• You can also use a configuration file (settings.json) if you don't want to use variables within this template. Check 'https://github.com/ether/etherpad-lite#tweak-the-settings' for more details.
• Etherpad supports the use of plugins to improve its functionalities. Check 'https://github.com/ether/etherpad-lite/wiki/Available-Plugins' to know more.

 

VERSION
1.0 (2022-01-26)


If you are going to report a bug or request something to be added/modified, please, take into consideration that I will only be able to apply changes for the work I own only. For example, if I create a docker template for an already existing docker image (not created by me), I won't be able to do more for that image than forward your report or request to the owner of the project.


If you like my work, please consider making a little donation.
- DONATE -
Thank you very much 🙂

Link to comment
  • 4 months later...

Love this docker! Thank you for your work.

 

Would it be possible to explain how to add plugins for etherpad and make them persist between container restarts on unraid in more detail?

 

I tried adding the container variable with the key as ETHERPAD_PLUGINS and the value as ep_author_neat to no avail. This did work for me for the variable SKIN_VARIANTS, but not plugins

 

I think that has to be done during build? Is there another way?

Link to comment
  • 1 month later...

Hey - I am having trouble getting this to run at all. Running as-is out of the box produces an EACCESS error with regards to the DirtyDB file and does not create any files in the appdata beyond the etherpad directory. Using variables to specify a separate DB does not fix the issue, but causes the log screen to close on open. I am on unRAID 6.10.3

Edited by xle
typo
Link to comment
  • 2 weeks later...
On 7/12/2022 at 5:07 PM, xle said:

Hey - I am having trouble getting this to run at all. Running as-is out of the box produces an EACCESS error with regards to the DirtyDB file and does not create any files in the appdata beyond the etherpad directory. Using variables to specify a separate DB does not fix the issue, but causes the log screen to close on open. I am on unRAID 6.10.3

 

I had the same issue. If you open up the log you'll likely see it's a permissions issue. I just chmod 777 that directory within appdata and everything worked fine. Probably not the best way to do it as it's giving full access to everyone but I just did that and everything worked after a restart.

Link to comment
  • 1 month later...
  • 1 month later...

Hi i just tried to install this container but are running into problems.

I configured the container with default settings, and exchanged the database for initial testing with dirty db type and added the file path for dirty DB_FILENAME=var/dirty.db

DB_FILENAME=var/dirty.db also tried without var/

in all cases the Connection Failed in browser.

 

the container log does not sound very problematic, besides the dirty.db warning

 

[2022-10-28 15:55:08.447] [INFO] settings - All relative paths will be interpreted relative to the identified Etherpad base dir: /opt/etherpad-lite
[2022-10-28 15:55:08.474] [INFO] settings - settings loaded from: /opt/etherpad-lite/settings.json
[2022-10-28 15:55:08.475] [INFO] settings - No credentials file found in /opt/etherpad-lite/credentials.json. Ignoring.
[2022-10-28 15:55:08.475] [INFO] settings - Using skin "colibris" in dir: /opt/etherpad-lite/src/static/skins/colibris
[2022-10-28 15:55:08.475] [INFO] settings - Session key file "/opt/etherpad-lite/SESSIONKEY.txt" not found. Creating with random contents.
[2022-10-28 15:55:08.476] [WARN] settings - DirtyDB is used. This is not recommended for production. File location: /opt/etherpad-lite/dirty.db
[2022-10-28 15:55:08.476] [INFO] settings - Random string used for versioning assets: e4c9eaf7
[2022-10-28 15:55:08.678] [INFO] server - Starting Etherpad...
[2022-10-28 15:55:08.693] [INFO] plugins - Running npm to get a list of installed plugins...
[2022-10-28 15:55:08.835] [INFO] plugins - npm --version: 6.14.15
[2022-10-28 15:55:10.255] [INFO] plugins - Loading plugin ep_etherpad-lite...
[2022-10-28 15:55:10.256] [INFO] plugins - Loaded 1 plugins
[2022-10-28 15:55:10.753] [INFO] APIHandler - Api key file "/opt/etherpad-lite/APIKEY.txt" not found.  Creating with random contents.
[2022-10-28 15:55:10.836] [INFO] server - Installed plugins: 
[2022-10-28 15:55:10.844] [INFO] console - Report bugs at https://github.com/ether/etherpad-lite/issues
[2022-10-28 15:55:10.844] [INFO] console - Your Etherpad version is 1.8.18 (4b96ff6)
[2022-10-28 15:55:11.518] [INFO] http - HTTP server listening for connections
[2022-10-28 15:55:11.518] [INFO] console - You can access your Etherpad instance at http://10.1.1.121:9001/
[2022-10-28 15:55:11.518] [INFO] console - The plugin admin page is at http://10.1.1.121:9001/admin/plugins
[2022-10-28 15:55:11.518] [INFO] server - Etherpad is running

 

so i was reading more in https://github.com/ether/etherpad-lite/blob/develop/doc/docker.md and added vars for IP / PORT / ADMIN_Passwort, so all General stuff, but i cannot reach it via browser.

so i tried to test bridge mode and the separate docker network br0, both with same result, unable to reach in browser, which i guess means it is not responding.

 

also tested version 1.18.17 as latest seems to be 1.18.18 at the moment, no improvment

but it is pingable successfully, so it is not a network issue.

 

I am doing something wrong, or is this template broken atm?

 

best regards

Edited by astronax
added screenshots
Link to comment
  • 5 weeks later...

 

On 7/12/2022 at 10:07 PM, xle said:

Hey - I am having trouble getting this to run at all. Running as-is out of the box produces an EACCESS error with regards to the DirtyDB file and does not create any files in the appdata beyond the etherpad directory. Using variables to specify a separate DB does not fix the issue, but causes the log screen to close on open. I am on unRAID 6.10.3

Same issue here too. No solution it seems apart from the 777 - which isnt really a solution.

Link to comment
  • 2 months later...

To create a MariaDB for Etherpad, you need to follow the steps below:

-edit container and add the following variables to etherpad:

 

DB_TYPE=mysql
DB_HOST=SERVER_IP
DB_PORT=3306
DB_NAME=etherpad
DB_USER=dbusername
DB_PASS=mypassword

 

If you encounter the error message

 

Cannot find module './databases/maria_db'

 

it means that the Etherpad application is unable to find the required MariaDB module. To resolve this issue, for some reason you need to change the 'DB_TYPE' to 'mysql' instead, when using mariadb.

 

I hope this helps someone in resolving the issue and creating a successful MariaDB setup for Etherpad.

Link to comment

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.

Guest
Reply to this topic...

×   Pasted as rich text.   Restore formatting

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.