| 1 | [](https://framagit.org)
|
| 2 |
|
| 3 |  **Framasoft uses GitLab** for the development of its free softwares. Our Github repositories are only mirrors.
|
| 4 | If you want to work with us, **fork us on [framagit.org](https://framagit.org)**. (no registration needed, you can sign in with your Github account)
|
| 5 |
|
| 6 |  **Framasoft utilise GitLab** pour le développement de ses logiciels libres. Nos dépôts Github ne sont que des miroirs.
|
| 7 | Si vous souhaitez travailler avec nous, **forkez-nous sur [framagit.org](https://framagit.org)**. (l'inscription n'est pas nécessaire, vous pouvez vous connecter avec votre compte Github)
|
| 8 | * * *
|
| 9 |
|
| 10 | MyPads
|
| 11 | ============
|
| 12 | **This git repo hosts the MyPads plugin for etherpad**.
|
| 13 |
|
| 14 | ## Description
|
| 15 |
|
| 16 | MyPads is considered as stable.
|
| 17 |
|
| 18 | MyPads manages :
|
| 19 |
|
| 20 | * users and their authentication;
|
| 21 | * groups of pads per user, unlimited, sharable;
|
| 22 | * attached pads, with choice between invite known users to use them, making them private with password or letting them public.
|
| 23 |
|
| 24 | ## Installation
|
| 25 |
|
| 26 | At the moment, MyPads is publicly available on NPM. So you can install it from etherpad administration. You may need a reboot of your etherpad instance after the plugin install.
|
| 27 | WARNING: if you uninstall MyPads, all its data will be definitely *removed*.
|
| 28 |
|
| 29 | ### Manual install
|
| 30 |
|
| 31 | You can install MyPads from source. In order to do that :
|
| 32 |
|
| 33 | * clone this git repository where you want to;
|
| 34 | * go into the directory of your Etherpad instance;
|
| 35 | * type the command `npm install /path/of/your/clone/of/ep_mypads`
|
| 36 | * restart your Etherpad instance and you should see *ep_mypads* listed into your administration back-end
|
| 37 | * homepage is available at http://youretherpad/mypads/index.html
|
| 38 |
|
| 39 | ## Configuration
|
| 40 |
|
| 41 | Configure an admin user in Etherpad's `settings.json` and use those credentials in http://youretherpad/mypads/?/admin
|
| 42 |
|
| 43 | ## Roadmap
|
| 44 |
|
| 45 | It's available through [milestones and tickets](https://git.framasoft.org/framasoft/ep_mypads/issues).
|