etherpad
ETHERPAD
< DRAFT >

The self-hosted realtime, collaborative pads. Also, powering this site via 🔗E2H.

Revisions:
    20190709 stub
    20191001 touch
    20200510 touch
    20200906 pre-pub, push to draft

Ties to:
    🔗E2H




BASIC RESOURCES

* https://etherpad.org/

* https://blog.etherpad.org/
the blog !

* https://etherpad.org/doc/v1.7.5/
Documentation (prob not the latest version!)

* http://etherpad.idea.informer.com/
public feature requests ...

* https://github.com/ether/etherpad-lite/wiki
wiki documentation

* ###
mailing list





MISSING INFO

(as of 20190709, to my knowledge ...)

:
    * a decent installation instruction for etherpad

that includes:
        * has mysql with utfmb4
        * has ssl (let's encrypt)
        * has restarter
        * [...]


    * regular troublehshooting resources


    * sanity check for instance


    * how to effectively collaborate on pads?

Like 🔗workflow-ethering !






*** INFO


INSTALLATION


    EXISTING DOCS

official:
    * https://github.com/ether/etherpad-lite/wiki/How-to-use-Etherpad-Lite-with-MySQL (BAD, SHOULD WORK TO CHANGE)
    * [...]

new / tocheck:
    ___________________ look good!
    * https://lab.uberspace.de/guide_etherpad.html
    * https://wiki.evolix.org/HowtoEtherpad
    ___________________ NO
    * https://vanad.is/how-to-host-etherpad.html (no utf8mb4 mysql certainty)
    ___________________ ???
    * https://stackoverflow.com/questions/46075120/how-to-debug-invalid-data-in-mysql-utf8mb4-column-in-etherpad-lite-database?rq=1
    * https://www.openattic.org/posts/how-to-install-etherpad-on-debian-jessie/
    * [...]



    New own docs ...

See dcht00🔗##### !
#tomerge !!!!!!





BACKUP + RESTORE

(EXISTING DOCS) ... meh:
    * https://github.com/ether/etherpad-lite/wiki/Backing-up-and-Restoring-Etherpad-Lite-Pads
    * [...]








*** POST !!!



BUGS

!!!!!! finish and report these


________________ 20200510

* selecting styles does not work (start to write - they deselet):
    * (they only for selecting and styling existing text)
    * beginning of line they don't even set (buttons not visible)
    * after that, they do, but 


* default new UI contrast:
    * (example @ https://video.etherpad.org theme)
    * not enough contrast on style buttons
    * default text is too bright, needs to be darker


* WEIRD CURSOR BEHAVIOURS on wrapped line:
    * from below going up - does not end up on end
    * gets stuck (but only on first character!)
    * [...]


* no stable link to latest version of documentation:
    I suggest it would be good to point https://etherpad.org/doc either to:
    a) an index of docs <--
    b) or the last version of them


* 100% cpu, then FAILURE (via timeouts) on moving bigger pads:
    My instance has ___ mb mysql DB.
    Pad in question has ___ edits (seen with most bigger pads).
    Command (via Curl) fails after ___ seconds.
    Log (on "DEBUG" says) ___
    ________________
    (more below!)


* you have space indented lines:
    (like this ... select whole line + copy + position to start of line + paste)
    it pastes, then gets merged on end of line


* you're on a tabulator indented line & line above it is empty:
    press backspace.
    instead of deleting the indentation, it deletes the empty line above it.
    (this makes it difficult to clean random indents)


* loading delay in timeslider view, without any indication:
    on long documents, it takes maybe a minute (or more?) to load the revisions
    until then, the playback is rolling. but it's all foo.
    A) freeze playback until it's loaded
    B) indicate progress of loading
    C) ???


* connection failures (with lost content) happen all the time:
    * reconnect, i haven't seen working once ... it's a sign the thing will fail.
    * how to have an updated status if still connected?:
        A) maintain "lest ping" timer, if not reached, have a yellow light somewhere. make this optional.
    * how to not lose content?
    what could be done about this?:
        A) work with local storage:
            * "base" version updates ought to be applied to 
            * when reconnected, did anything change? nope? apply!
        B) [...]


* try copying in something from gnome terminal, as "Copy as HTML" (with right click):
    at least for some inpiuts (while testing with E2H_PSTE) it breaks etherpad when pasting ... :
        1) view is fucked
        2) you can still type but it's all fucked
    it seems it's because it all wraps into a <pre> window! and this isn't stripped
    ---------------
    NOT EASY TO REPRODUCE ?


* copying in a tab-space, it default to 8 characters:
    i propose:
        * defaulting to 4
        * making it a setting


* ... also tabulation should be (optionally, at least) spaces based:
    tab + shift-tab should work to a pre-defined spacing level


* listallpads API should include time (and maybe revision no):
    https://etherpad.org/doc/v1.7.5/#index_listallpads
    -----------
    A) all include this info (for backwards compatibility, add opt-in flag)
    B) listallpads changed after T
    [...]


* very big pads fail to export .etherpad
(give "proxy error")
----------
workaround:
    it works as a localhost export!
    this means it's a proxy timeout problem!
so:
    find if this is documented yet
    and where to change it (in a sensible way)


* fail to "import" very big .etherpad files (30MB)
maybe same (timeouts) problem?

check debug log!

<------------------------------------- (new) BUGS






FEATURE REQUESTS

* merge two pads & preserve history!:
    1) on existing pod
    2) etherpad export from pod 1 → import to pod 2
    ______________
    how:
        v1) just append it at end (while preserving timestamps). then the people can manually merge.
        v2) do more fancy stuff


<------------------------------------- (new) FEATURES







*** PAD


bug: rename of bigger pads fails

(20190710, and oldie)
in a really weird way?
just crashes instance?

case "huje" 20190710:
    * first failed + crashed instance:
        nothing in WARN-level logs !
    * second time ...:
        """
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<html><head>
<title>502 Proxy Error</title>
</head><body>
<h1>Proxy Error</h1>
<p>The proxy server received an invalid
response from an upstream server.<br />
The proxy server could not handle the request <em><a href="/api/1.2.13/movePad">GET&nbsp;/api/1.2.13/movePad</a></em>.<p>
Reason: <strong>Error reading from remote server</strong></p></p>
<hr>
<address>Apache/2.4.29 (Ubuntu) Server at pad.totalism.org Port 443</address>
</body></html>
        """
    * ... but i went to source e2h and it was not there
    * ... and destination was and nothing broke !
    * so WTF





CHECK THESE PLUGINS !!!!!!

20191203

def:
    * https://www.npmjs.com/package/ep_mypads :
        users and permissions
        what FRAMA uses !!!
    * https://www.npmjs.com/package/ep_htaccess_auth :
        maybe simple permissions ?

cool:
    * https://www.npmjs.com/package/ep_insert_text :
        WOW - autocomplete from ext source!
    * https://www.npmjs.com/package/ep_author_neat :
        colour author names ???
        with CSS - usefull for Q&A, #templates, etc
    * https://www.npmjs.com/package/ep_export_authors :
        ... another same one !!!

interesting:
    * https://www.npmjs.com/package/ep_sociallinks
    * https://www.npmjs.com/package/ep_text_statistics

huuuuuuh:
    * https://www.npmjs.com/package/ep_element
    * https://www.npmjs.com/package/ep_reference



!!! #tomerge my resources from "###linux" 
    #tomerge and publish !!!!!!


!!! publish this site, by linking it to...
:
    * etherpad wiki
    * etherpad mailing list
    * stackoverflow
    * [...]


<---------------------------------- ((new))





(Site generated by E2H, an "Etherpad hypermedia" project by @dcht00). Creative Commons License
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.


Edit Site

Edit CSS