diff --git a/README.md b/README.md index 5a4d1b9413947d7fb97d8b597061c58de14c7969..22878cc15f7ae26eee6c4fc1ff5ea07fc94ac3a0 100644 --- a/README.md +++ b/README.md @@ -27,8 +27,8 @@ code is required. ## Installation -The server works with the **otp** database which is shared with the technical site installation. -You must define user **otp** or whatever you decide to call it (and set in the otp_config.php). +The server works with the `otp` database which is shared with the technical site installation. +You must define user `otp` or whatever you decide to call it (and set in the otp_config.php). ### Without Docker @@ -52,12 +52,12 @@ We suggest that you use **--network host** Docker run option which will allow ad resolution based on the host machine and standard port 80 for connections. - You need docker instaled on your host machine -- If you do not want to use **--network host** option then decide which port will be mapped to your Docker image (say 8080) +- If you do not want to use ` --network host ` option then decide which port will be mapped to your Docker image (say 8080) - Download the code from git -- In the **config** directory, copy **config-template.php** to **config.php**; do not modify the settings -- In the **otp_server_config** directory copy **otp_config-template.php** to **otp_confi.php** and modify the settings as needed -- As root run **docker build -t otp_server:latest .** -- As root run **docker run -d --name otp_server --network host --rm otp_server:latest** +- In the ` config ` directory, copy ` config-template.php ` to ` config.php `; do not modify the settings +- In the ` otp_server_config ` directory copy ` otp_config-template.php ` to ` otp_confi.php ` and modify the settings as needed +- As root run ` docker build -t otp_server:latest . ` +- As root run ` docker run -d --name otp_server --network host --rm otp_server:latest ` ### Running the dosker image at boot For systems using systemctl we suggest to install the new service called @@ -84,12 +84,15 @@ WantedBy=multi-user.target From the main technical site run: +``` wget -O otp.out http://otp_server_address/otp_server.php?user=xxx@example.com +``` or +``` curl -o otp.out http://otp_server_address/otp_server.php?user=xxx@example.com - +``` Your otp.out should contain value "-1" which means - the user not found. If this works then you are ready to go.