From a9f78ceab695428ee9e2ec7003392d36c90ae02c Mon Sep 17 00:00:00 2001 From: Mark <mark@openappstack.net> Date: Fri, 6 Dec 2019 17:40:37 +0100 Subject: [PATCH] Improve instructions --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1db0130..5da8e71 100644 --- a/README.md +++ b/README.md @@ -20,10 +20,21 @@ After your server is running, refer to `https://sso.<YOUR.DOMAIN>/.well-known/op # Testing In order to run tests locally, you can start the environment via `docker-compose`. -To make the test setup work on your machine, install docker and docker-compose and edit -the `docker-compose.yml` file. Make sure all of the URLS listed in the environment of the hydra -service are accessible by your agent (usually your browser) and the application that will act -as an oAuth / OpenID Connect client (for example nextcloud). +Install docker-compose via `pip install docker-compose` after you [insalled +docker](https://docs.docker.com/v17.12/install/) on your machine. +Running `docker-compose up --build` after that builds and starts all containers. +The default configuration works if you are running the setup on your local +machine. You need to change the following values in the docker-compose.yml file in case +you run the containers on a remote machine: + +``` + environment: + - URLS_SELF_ISSUER=http://YOUR_SERVER_FQDN:4444/ + - URLS_CONSENT=http://YOUR_SERVER_FQDN:5001/ + - URLS_LOGIN=http://YOUR_SERVER_FQDN:5000/ + - URLS_LOGOUT=http://YOUR_SERVER_FQDN:5000/logout + - URLS_POST_LOGOUT_REDIRECT=http://YOUR_SERVER_FQDN:5000/ +``` Notice that you need to create users and applications before being able to login. You can use the scripts located in `user-panel/utils` to create users for testing. -- GitLab