Commit f63794ea authored by Luc Didry's avatar Luc Didry

Update README.md

parent b6c91e6f
#Etherpad-admin
# Etherpad-admin
Etherpad-admin is an interface which lists all the existing pads in an [Etherpad-lite](https://github.com/ether/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.
![Screenshot](https://raw.github.com/ldidry/etherpad-admin/master/demo.png)
##WARNING
## 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
## 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
## Dependancies
The dependancies are handled by `carton`. Install it with `cpan` or from your distribution's repositories:
```shell
sudo cpan Carton
......@@ -27,7 +27,7 @@ Once `carton` is installed, install the dependancies:
carton install
```
##Configuration
## 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.
......@@ -56,7 +56,7 @@ Recopy or rename the one you need in `etherpad_admin.conf`.
};
```
##Run it
## Run it
Manually:
```
cd YOUR_INSTALL_DIR
......@@ -73,14 +73,14 @@ sudo update-rc.d etherpad-admin defaults
sudo service etherpad-admin start
```
##Others projects dependancies
## Others projects dependancies
Etherpad-admin uses the [Twitter Bootstrap](http://twitter.github.com/bootstrap/) which code is available under the [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0) and jQuery which code is available under the [MIT License](http://github.com/jquery/jquery/blob/master/MIT-LICENSE.txt).
##License
## License
Etherpad-admin is distributed under the terms of the [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0).
##Source code
## Source code
In order to consult and/or get Etherpad-admin's source code, you can go to the [github repository](http://github.com/ldidry/etherpad-admin).
##Misc
## Misc
You'll find an init script and a nginx configuration file in the examples directory.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment