jan-henrik/overleaf-ldap
1
0
Fork 0
Code Issues Pull requests Releases Packages 1 Activity Actions

docs(README): Move Environment variables above build args

Browse source 
Signed-off-by: Sebastian Hasler <sebastian.hasler@stuvus.uni-stuttgart.de>
This commit is contained in:
Sebastian Hasler 2021-05-08 01:03:45 +02:00
parent 60156e3aa4
commit a33a11bfae
1 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -13,6 +13,13 @@ as follows.
docker build --build-arg BASE=docker.io/sharelatex/sharelatex:2.6.1 -t docker-overleaf-ldap . docker build --build-arg BASE=docker.io/sharelatex/sharelatex:2.6.1 -t docker-overleaf-ldap .
``` ```
## Environment variables
Two environment variables are used at runtime to configure the bind user:
- `LDAP_BIND_USER`: Bind-DN, i.e., DN of the bind user.
- `LDAP_BIND_PW`: Password of the bind user.
## Build arguments ## Build arguments
The following arguments can be passed via `--build-args`. The following arguments can be passed via `--build-args`.
@ -22,12 +29,6 @@ The following arguments can be passed via `--build-args`.
| `BASE` | `docker.io/sharelatex/sharelatex` | Can be set to any Overleaf image tag. See [here](https://hub.docker.com/r/sharelatex/sharelatex/tags?page=1&ordering=last_updated) for a list of tags. | | `BASE` | `docker.io/sharelatex/sharelatex` | Can be set to any Overleaf image tag. See [here](https://hub.docker.com/r/sharelatex/sharelatex/tags?page=1&ordering=last_updated) for a list of tags. |
| `LDAP_PLUGIN_URL` | `https://codeload.github.com/smhaller/ldap-overleaf-sl/tar.gz/master` | URL to download ldap-overleaf-sl from. | | `LDAP_PLUGIN_URL` | `https://codeload.github.com/smhaller/ldap-overleaf-sl/tar.gz/master` | URL to download ldap-overleaf-sl from. |
## Environment variables
Two environment variables are used to configure the bind user:
- `LDAP_BIND_USER`: Bind-DN, i.e., DN of the bind user.
- `LDAP_BIND_PW`: Password of the bind user.
## GitLab CI ## GitLab CI
The `environment` file is used to specify some environment variables for the GitLab CI: The `environment` file is used to specify some environment variables for the GitLab CI: