Skip to content

Commit

Permalink
Add some docs on ldap development
Browse files Browse the repository at this point in the history
  • Loading branch information
oliverguenther committed Mar 21, 2024
1 parent 38665c5 commit 33fe446
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions docs/development/ldap/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
sidebar_navigation:
title: LDAP development setup
priority: 920
---

# Set up a development LDAP server

**Note:** This guide is targeted only at development with OpenProject. For the LDAP configuration guide, please see this [here](../../system-admin-guide/authentication/ldap-authentication/)


OpenProject comes with a built-in LDAP server for development purposes. This server uses [ladle gem](https://github.com/NUBIC/ladle)
to run an underlying apacheDS server.

This guide will show you how to set it up in your development instance.

## Prerequisites

- A local java/JRE environment installed (openjdk, java installed via homebrew, etc.)
- A development setup of OpenProject (or any other configurable installation)

## Running the LDAP server

You only need to run this rake task to start the server:

```bash
./bin/rails ldap_groups:development:ldap_server
```

It will both output the different users and groups, as well as connection details. Starting this task will ensure
an LDAP connection is created or updated to make sure you can use it right away.

0 comments on commit 33fe446

Please sign in to comment.