Etherpad-admin

Etherpad-admin is an interface which lists all the existing pads in an Etherpad-lite installation, allows you to delete pads, create pads and get some informations about the pads. You can also manage templates for new pads : set texts and reuse them for creating pads.

WARNING

There is no authentication, so anyone can delete pads. Remember to set an authentication on the web server (see the nginx example file).

SECOND WARNING

From version 0.03, Etherpad-admin uses the Etherpad Lite API, there is a lot of changes, so, please, read this README carefully.

Dependancies

The dependancies are handled by carton. Install it with cpan or from your distribution's repositories:

sudo cpan Carton

or

sudo apt-get install carton

Once carton is installed, install the dependancies:

carton install

Configuration

You will find a configuration file in the git repository : examples/etherpad_admin.conf.sample. Recopy or rename the one you need in etherpad_admin.conf.

• allowdelete : denies the pads' deletion if equal to 0, allows (anyone !) to delete pads if equal to 1.
• etherpadurl : this is the administrated etherpad's URL.
• etherpadapiurl : Optional if the etherpad api url needs to be different from etherpadurl
• epluser : Optional the epl user if it needs an authentication
• eplpassword : Optional the epl password if it needs an authentication
• apikey : this is the administrated etherpad's secret API key.
• urlprefix : the path you use to access etherpad-admin. For example, if you access it with the http://example.com/etherpad-admin/ URL, urlprefix has to be '/etherpad-admin'. If you access it by the http://padadmin.example.com/ URL, it will be ''.
• hypnotoad : the hypnotoad web server configuration. Please, have a look here : http://mojolicio.us/perldoc/Mojo/Server/Hypnotoad

{
    hypnotoad => {
        user    => 'www-data',
        group   => 'www-data',
        listen  => ['http://127.0.0.1:4242'],
        workers => 2,
    },
    allowdelete  => 0,
    etherpadurl  => 'https://etherpad.example.com',
    apikey       => 'S3cr3tP4ss',
    urlprefix    => '/liste'
};

Run it

Manually:

cd YOUR_INSTALL_DIR
carton exec hypnotoad script/etherpad_admin

With the example init script:

cd YOUR_INSTALL_DIR
sudo cp examples/etherpad-admin.initscript /etc/init.d/etherpad-admin
sudo cp examples/etherpad-admin.default /etc/default/etherpad-admin
sudo vi /etc/default/etherpad-admin
sudo update-rc.d etherpad-admin defaults
sudo service etherpad-admin start

Others projects dependancies

Etherpad-admin uses the Twitter Bootstrap which code is available under the Apache License v2.0 and jQuery which code is available under the MIT License.

License

Etherpad-admin is distributed under the terms of the Apache License v2.0.

Source code

In order to consult and/or get Etherpad-admin's source code, you can go to the github repository.

Misc

You'll find an init script and a nginx configuration file in the examples directory.