105 lines
2.4 KiB
Markdown
105 lines
2.4 KiB
Markdown
etherdump
|
|
=========
|
|
|
|
Tool to publish [etherpad](http://etherpad.org/) pages to files.
|
|
|
|
|
|
Requirements
|
|
-------------
|
|
* python3
|
|
* html5lib
|
|
* requests (settext)
|
|
* python-dateutil, jinja2 (index subcommand)
|
|
|
|
Installation
|
|
-------------
|
|
|
|
pip install python-dateutil jinja2 html5lib
|
|
python setup.py install
|
|
|
|
Example
|
|
---------------
|
|
mkdir mydump
|
|
cd myddump
|
|
etherdump init
|
|
|
|
The program then interactively asks some questions:
|
|
|
|
Please type the URL of the etherpad:
|
|
http://automatist.local:9001/
|
|
The APIKEY is the contents of the file APIKEY.txt in the etherpad folder
|
|
Please paste the APIKEY:
|
|
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
|
|
|
The settings are placed in a file called .etherdump/settings.json and are used (by default) by future commands.
|
|
|
|
|
|
|
|
subcommands
|
|
----------
|
|
|
|
* init
|
|
* pull
|
|
* list
|
|
* listauthors
|
|
* gettext
|
|
* settext
|
|
* gethtml
|
|
* creatediffhtml
|
|
* revisionscount
|
|
* index
|
|
* deletepad
|
|
|
|
To get help on a subcommand:
|
|
|
|
etherdump revisionscount --help
|
|
|
|
|
|
Usage / cookbook
|
|
========================
|
|
|
|
Using etherdump to migrate from one etherpad instance to another
|
|
------------------------------------------------------------------
|
|
|
|
mkdir instance1 && cd instance1
|
|
etherdump init
|
|
etherdump pull --html --meta
|
|
|
|
(cd ..)
|
|
mkdir instance2 && cd instance2
|
|
etherdump init
|
|
etherdump pushhtml --basepath ../instance1 ../instance1/p/*.meta.json
|
|
|
|
Warning, this command indescriminantly clobbers pads in instance2 with the HTML of the dumped versions from instance1.
|
|
|
|
Note: this technique can be used to "reset" the database of a pad by recreating pads (without their history or editor info/colors) in a fresh database.
|
|
|
|
|
|
|
|
|
|
|
|
Change log / notes
|
|
=======================
|
|
|
|
Originally designed for use at: [constant](http://etherdump.constantvzw.org/).
|
|
|
|
|
|
17 Oct 2016
|
|
-----------------------------------------------
|
|
Preparations for [Machine Research](https://machineresearch.wordpress.com/) [2](http://constantvzw.org/site/Machine-Research,2646.html)
|
|
|
|
|
|
6 Oct 2017
|
|
----------------------
|
|
Feature request from PW: When deleting a previously public document, generate a page / pages with an explanation (along the lines of "This document was previously public but has been marked .... maybe give links to search").
|
|
|
|
3 Nov 2017
|
|
---------------
|
|
machineresearch seems to be __NOPUBLISH__ but still exists (also in recentchanges)
|
|
|
|
Jan 2018
|
|
-------------
|
|
Updated files to work with python3 (probably this has broken python2).
|
|
|
|
|