Skip to content


Repository files navigation


Go Report Card

Script to interact with Redbrick LDAP.

  • query ldap for user info to generate apache template conf for user vhosts.
  • Search for users in ldap
  • Create a new Redbrick user
  • Renew a user
  • convert a users usertype
  • edit user info
  • reset a user's password and shell
  • disable and renable a user account
  • remove and lock unpaid accounts
  • produce ldap stats


go get

Installation with Docker

There is a docker-compose.yml for rb-ldap. Before running this file, you should make sure to change the paths to the ldap secrets, you can do this in the docker-compose.yml itself, under volumes.

The docker-compose file can be run using:

docker-compose run --rm rb-ldap

If you want to use it this way, we really recommend you create a function, it's much easier. A function such as the following can be placed in your ~/.bashrc:

rb_ldap() {
    /path/to/docker-compose -f /path/to/your/docker-compose/file/docker-compose.yml run --rm rb-ldap "${@:1}"

After that running source ~/.bashrc should be sufficient to use rb-ldap in this way.


In any case of installation, rb-ldap can be run by invoking:


Run rb-ldap -h to get a list of flags and commands.

$ rb-ldap --help
   rb-ldap - Command line interface for Redbrick LDAP

   rb-ldap [global options] command [command options] [arguments...]


   Cian Butler <>

     add, a            Add user to ldap
     disable, disuser  Disable a Users ldap account
     generate, g       generate list for uservhost macro
     renable, reuser   Renable a Users ldap account
     renew, r          renew a LDAP user
     reset             reset a users password
     reset-shell       reset a users shell
     search, s         Search ldap for user
     update, u, edit   Update a user in ldap
     help, h           Shows a list of commands or help for one command

   Batch Commands:
     alert-unpaid    Alert all unpaid users that their accounts will be disabled
     delete-unpaid   Delete all unpaid users accounts that are outside their grace period
     disable-unpaid  Diable all unpaid users accounts
     new-year        Decrement Years Paid of all users to 1

   --user value, -u value  ldap user, used for authentication (default: "cn=root,ou=ldap,o=redbrick")
   --dcu-user value        Active Directory user for DCU, used for authentication (default: "CN=rblookup,OU=Service Accounts,DC=ad,DC=dcu,DC=ie")
   --host value            ldap host to query (default: "ldap.internal")
   --dcu-host value        DCU Active Directory host to query (default: "")
   --port value, -p value  Port for ldap host (default: 389)
   --dcu-port value        Port for DCU Active Directory host (default: 389)
   --password value        password for the ldap server [/etc/ldap.secret]
   --dcu-password value    password for the DCU ldap server [/etc/dcu_ldap.secret]
   --smtp value            smtp server to send email with []
   --dry-run               output to console rather then file
   --help, -h              show help
   --version, -v           print the version


The conf from rb-ldag g will be output to the current dir.


Application for interaction and account manipulation of ldap







No packages published

Contributors 4