Browse Source

Merge branch 'main' of https://git.in-ulm.de/ulpeters/totp-auth into main

toastie89 7 months ago
parent
commit
b76a95a25a
1 changed files with 10 additions and 2 deletions
  1. 10 2
      README.md

+ 10 - 2
README.md

@@ -1,8 +1,16 @@
 # Simple totp subrequest authentication
 
 ## Setup
-- Run `new-secret.sh` to create a `.env` file with a random secret and a text file `secret.qr` with the corresponding qr-code for your TOTP mobile app.
-- Adapt the sample configuration `vdi.example.com_location` and copy it to `vhost.d` of your [reverse-proxy](https://github.com/nginx-proxy/nginx-proxy)
+```
+# build the container image
+docker compose build
+
+# Popoulate .env file with an random secret
+# corresponding qr-code for your TOTP mobile app and a text file called secret.qr`
+./new-secret.sh
+
+# Adapt the sample configuration `vdi.example.com_location` and copy it to `vhost.d` of your [reverse-proxy](https://github.com/nginx-proxy/nginx-proxy)
+```
 
 ## Credits:
   - Based on [newhouseb/nginxwebauthn](https://github.com/newhouseb/nginxwebauthn)