ep_mypads

Framasoft uses GitLab for the development of its free softwares. Our Github repositories are only mirrors. If you want to work with us, fork us on framagit.org. (no registration needed, you can sign in with your Github account)

Framasoft utilise GitLab pour le développement de ses logiciels libres. Nos dépôts Github ne sont que des miroirs. Si vous souhaitez travailler avec nous, forkez-nous sur framagit.org. (l'inscription n'est pas nécessaire, vous pouvez vous connecter avec votre compte Github)

---

MyPads

This git repo hosts the MyPads plugin for etherpad.

Description

MyPads is considered as stable.

MyPads manages :

• users and their authentication;
• groups of pads per user, unlimited, sharable;
• attached pads, with choice between invite known users to use them, making them private with password or letting them public.

Installation

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. WARNING: if you uninstall MyPads, all its data will be definitely removed.

Manual install

You can install MyPads from source. In order to do that :

• clone this git repository where you want to;
• go into the directory of your Etherpad instance;
• type the command npm install /path/of/your/clone/of/ep_mypads
• restart your Etherpad instance and you should see ep_mypads listed into your administration back-end
• homepage is available at http://youretherpad/mypads/index.html

Configuration

You can configure MyPads for using LDAP authentication. For that, add a ep_mypads section, containing a ldap section, in Etherpad's settings.json file:

"ep_mypads": {
    "ldap": {
        // Your LDAP URL
        "url": "ldaps://ldap.example.org",
        // The LDAP user to bind with
        "bindDN": "uid=ldap,ou=users,dc=example,dc=org",
        // His password
        "bindCredentials": "S3cr3t",
        // Where to search your users
        "searchBase": "ou=users,dc=example,dc=org",
        // A LDAP filter ({{username}} is replaced by user's login)
        "searchFilter": "(uid={{username}})",
        // LDAP properties mapping for MyPads
        "properties": {
            // Which LDAP property will be used as user's login?
            "login": "uid",
            // as user's email
            "email": "mail",
            // as user's firstname
            "firstname": "givenName",
            // as users's lastname
            "lastname": "sn"
        },
        // Default langage for LDAP created users
        "defaultLang": "fr"
    }
}

Beside properties and defaultLang, all the settings in the ldap section are ldapauth-fork (the module used for the LDAP authentication) settings. You can add other settings to it, just go on https://www.npmjs.com/package/ldapauth-fork#ldapauth-config-options to see which.

NB When using the LDAP authentication, registration of new accounts is disabled.

Roadmap

It's available through milestones and tickets.