Skip to content

Commit

Permalink
Merge pull request #3 from netresearch/readme
Browse files Browse the repository at this point in the history
Improve README
  • Loading branch information
TheDevMinerTV authored Jul 13, 2023
2 parents fb8bb91 + 25aeef8 commit 4179160
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,35 @@
# LDAP Selfservice Password Changer

## Running in Docker
LDAP Selfservice Password Changer is a web frontend and JSON RPC API for the password changing part of a LDAP or ActiveDirectory server.

## Running

### Natively

If you want to run this service without a Docker container, you have to build it yourself.

You can configure this via a `.env.local` file or via command options (for more information you can run `./ldap-selfservice-password-changer --help`).

<!-- Multiline comment idea taken from https://stackoverflow.com/a/12797512 -->

```bash
pnpm i
pnpm build

./ldap-selfservice-password-changer \
`# You can also configure these via environment variables,` \
`# please see the .env file for available options.` \
-ldap-server ldaps://dc1.example.com:636 -active-directory \
-readonly-password readonly -readonly-user readonly \
-base-dn DC=example,DC=com
```

### Docker

We have a Docker image available [here](https://github.com/netresearch/ldap-selfservice-password-changer/pkgs/container/ldap-selfservice-password-changer).

You can ignore the warning that the service could not load a `.env` file.

<!-- Multiline comment idea taken from https://stackoverflow.com/a/12797512 -->

```bash
Expand Down

0 comments on commit 4179160

Please sign in to comment.