Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Docker usage docs #34

Merged
merged 1 commit into from
Jan 30, 2025
Merged

Update Docker usage docs #34

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 13 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,35 +41,39 @@ A working example can be found in `./examples/wire-server`.
## use via docker

If you have gotten here as a
[wire-server](https://github.com/wireapp/wire-server) administrator
and want to use this to populate your teams, you can use the docker
image we're building from this repo (append version with `:` if you
want to pin it):
[wire-server](https://github.com/wireapp/wire-server) administrator and want to
use this to populate your teams, you can use the docker image we're building
from this repo. As we do not guarantee full backwards-compatibility (there may
be breaking changes e.g. regarding CLI options), please always provide the
image's tag.

```sh
docker pull quay.io/wire/ldap-scim-bridge
docker pull quay.io/wire/ldap-scim-bridge:$IMAGE_TAG
```

You need to create a config file that contains your setup. If in doubt, you can start with [this example](./examples/wire-server/conf1.yaml), or [this one](./examples/wire-server/conf2.yaml). Name the file `config.yaml` and place it into `/config-path`. Let's say you want to work on release 0.5. (You can check if there is a `:latest`, but at the time of writing this paragraph, we still have to add that.)
Usually, `IMAGE_TAG` should be the latest release name without the `v`-prefix.
E.g. for `v0.10.3` the `IMAGE_TAG` is `0.10.3`.

You need to create a config file that contains your setup. If in doubt, you can start with [this example](./examples/wire-server/conf1.yaml), or [this one](./examples/wire-server/conf2.yaml). Name the file `config.yaml` and place it into `/config-path`.

```sh
docker run -it --network=host \
--mount type=bind,src=/config-path,target=/mnt \
quay.io/wire/ldap-scim-bridge \
quay.io/wire/ldap-scim-bridge:$IMAGE_TAG \
ldap-scim-bridge /mnt/config.yaml
```

This should work fine for Windows if you make sure the file path under `src` points to the right place. You may need to you `\` instead of `/`.

The connection to wire is not encrypted. This tool is made for running inside the trusted network the backend is running in. If you need to protect this connection you can use an off-the-shelf tls tunnel or vpn solution.
The connection to Wire is not encrypted. This tool is made for running inside the trusted network the backend is running in. If you need to protect this connection you can use an off-the-shelf TLS tunnel or VPN solution.

The connection to the LDAP source is TLS-encrypted. If you need to add trusted certificates to the store in `/etc/ssl/certs/`, you can just mount it:

```sh
docker run -it --network=host \
--mount type=bind,src=/config-path,target=/mnt \
--mount type=bind,src=/etc/ssl/certs,target=/etc/ssl/certs \
quay.io/wire/ldap-scim-bridge \
quay.io/wire/ldap-scim-bridge:$IMAGE_TAG \
ldap-scim-bridge /mnt/config.yaml
```

Expand Down