mirrors/overleaf-toolkit
1
0
Fork 0
mirror of https://github.com/overleaf/toolkit.git synced 2025-04-19 15:28:06 +02:00
Code Activity

Added LDAP and SAML instructions and example instructions (#30)

Browse source
This commit is contained in:
Miguel Serrano 2021-01-05 12:18:12 +01:00 • committed by GitHub
parent 530fed2fee
commit 89c1a0de3f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 81 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/README.md
View file

@ -34,6 +34,8 @@ documentation on the [Overleaf Wiki](https://github.com/overleaf/overleaf/wiki)
- [Getting Server Pro](./getting-server-pro.md)
- [Sandboxed Compiles](./sandboxed-compiles.md)
- [LDAP integration](./ldap.md)
- [SAML integration](./saml.md)
## Upgrades

36
doc/ldap.md Normal file
View file

@ -0,0 +1,36 @@
# LDAP
Available in Overleaf Server Pro is the ability to use a LDAP server to manage users. It is also possible to use with Active Directory systems.
LDAP is configured in the Toolkit via [`variables.env`](./configuration.md).
The [Developer wiki](https://github.com/overleaf/overleaf/wiki/Server-Pro:-LDAP-Config) contains further documentation on the available Environment Variables and other configuration elements.
## Example
At Overleaf, we test the LDAP integration against a [test openldap server](https://github.com/rroemhild/docker-test-openldap). The following is an example of a working configuration:
```
# added to variables.env
SHARELATEX_TEMPLATES_USER_ID=578773160210479700917ee5
SHARELATEX_NEW_PROJECT_TEMPLATE_LINKS=[ {"name":"All Templates","url":"/templates/all"}, {"name":"All Categories","url":"/templates"}, {"name":"reports","url":"/templates/reports"}, {"name":"External","url":"https://somewhere.com/templates/reports"} ]
SHARELATEX_LDAP_URL=ldap://ldap:389
SHARELATEX_LDAP_SEARCH_BASE=ou=people,dc=planetexpress,dc=com
SHARELATEX_LDAP_SEARCH_FILTER=(uid={{username}})
SHARELATEX_LDAP_BIND_DN=cn=admin,dc=planetexpress,dc=com
SHARELATEX_LDAP_BIND_CREDENTIALS=GoodNewsEveryone
SHARELATEX_LDAP_EMAIL_ATT=mail
SHARELATEX_LDAP_NAME_ATT=cn
SHARELATEX_LDAP_LAST_NAME_ATT=sn
SHARELATEX_LDAP_UPDATE_USER_DETAILS_ON_LOGIN=true
```
The `openldap` needs to run in the same network as the `sharelatex` container (which by default would be `overleaf_default`), so we'll proceed with the following steps:
- Run `docker network create overleaf_default` (will possibly fail due to a `network with name overleaf_default already exists` error, that's ok).
- Start `openldap` container with `docker run --network=overleaf_default --name=ldap rroemhild/test-openldap`
- Edit `variables.env` to add the LDAP Environment Variables as listed above.
- Restart Server Pro
You should be able to login using `fry` as both username and password.

43
doc/saml.md Normal file
View file

@ -0,0 +1,43 @@
# Overleaf SAML
Available in Overleaf Server Pro is the ability to use a SAML server to manage users.
SAML is configured in the Toolkit via [`variables.env`](./configuration.md).
The [Developer wiki](https://github.com/overleaf/overleaf/wiki/Server-Pro:-SAML-Config) contains further documentation on the available Environment Variables and other configuration elements.
## Example
At Overleaf, we test the SAML integration against a SAML test server. The following is an example of a working configuration:
```
# added to variables.env
SHARELATEX_SAML_ENTRYPOINT=http://localhost:8081/simplesaml/saml2/idp/SSOService.php
SHARELATEX_SAML_CALLBACK_URL=http://saml/saml/callback
SHARELATEX_SAML_ISSUER=sharelatex-test-saml
SHARELATEX_SAML_IDENTITY_SERVICE_NAME=SAML Test Server
SHARELATEX_SAML_EMAIL_FIELD=email
SHARELATEX_SAML_FIRST_NAME_FIELD=givenName
SHARELATEX_SAML_LAST_NAME_FIELD=sn
SHARELATEX_SAML_UPDATE_USER_DETAILS_ON_LOGIN=true
```
The `sharelatex/saml-test` image needs to run in the same network as the `sharelatex` container (which by default would be `overleaf_default`), so we'll proceed with the following steps:
- Run `docker network create overleaf_default` (will possibly fail due to a `network with name overleaf_default already exists` error, that's ok).
- Start `saml-test` container with some environment parameters:
```
docker run --network=overleaf_default --name=saml \
--publish='8081:80' \
--env SAML_BASE_URL_PATH='http://localhost:8081/simplesaml/' \
--env SAML_TEST_SP_ENTITY_ID='sharelatex-test-saml' \
--env SAML_TEST_SP_LOCATION='http://localhost/saml/callback' \
sharelatex/saml-test
```
- Edit `variables.env` to add the SAML Environment Variables as listed above.
- Restart Server Pro.
You should be able to login using `sally` as username and `sall123` as password.