Skip to content

Latest commit

 

History

History
59 lines (32 loc) · 1.94 KB

README.md

File metadata and controls

59 lines (32 loc) · 1.94 KB
Raw

☎️ EDRN LDAP Sync

This package contains utilities for the dirctory service of the EDRN. There are three console scripts provided:

  • usersync — adds and removes users from the EDRN RDF feed for registered people
  • groupsync — adds and updates funded sites and collaborative groups from the EDRN RDF feeds for sites and committees
  • all-edrn-sync — keeps the All EDRN group up-to-date

🚗 Getting Started

Do something like the following:

$ python3 -m venv venv
$ venv/bin/pip install --quiet --upgrade setuptools pip wheel
$ venv/bin/pip install --editable .

and you should be good to go to run the three scripts mentioned above out of venv/bin.

🎥 Production Use

Just add a crontab entry like the following:

@daily /usr/local/edrn/edrn/ldap-sync-utils/bin/usersync --password PASSWORD --quiet
@daily /usr/local/edrn/edrn/ldap-sync-utils/bin/groupsync --password PASSWORD --quiet
@hourly /usr/local/edrn/edrn/ldap-sync-utils/bin/all-edrn-sync --password PASSWORD --quiet

replacing PASSWORD with the password of the manager account of the EDRN Directory Service.

📀 Software Environment

This is written in Python 3 and requires Python 3.7 or later (but probably not Python 4 or later).

👥 Contributing

You can start by looking at the open issues, forking the project, and submitting a pull request. You can also contact us by email with suggestions.

🔢 Versioning

We use the SemVer philosophy for versioning this software. For versions available, see the releases made on this project.

👩‍🎨 Creators

The principal developer is:

📃 License

The project is licensed under the Apache version 2 license.