diff --git a/README.md b/README.md index 8463cab..aeb137f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ # UniFi Guest Portal +[](LICENSE) +[](https://hub.docker.com/r/carlgo11/guest-portal/) ## Usage @@ -12,16 +14,39 @@ Optionally, add some background images: docker run -p 80:80 -v $(pwd)/bg.webp:/opt/www/img/bg.webp -v $(pwd)/bg.jpg:/opt/www/img/bg.jpg carlgo11/guest-portal ``` -## Environment variables +### Environment variables |Name|Default|Description|Example| |----|-------|-----------|-------| -|UNIFI_USER| |UniFi Hotspot username|api +|UNIFI_USER| |UniFi Hotspot username|guest-portal |UNIFI_PASSWORD| |UniFi Hotspot password|password -|UNIFI_URL| |UniFi Controller IP/URL & port|https://192.168.1.2:8443 +|UNIFI_URL| |UniFi Controller IP/URL & port|<https://192.168.1.2:8443> |UNIFI_SITE|default|UniFi Site|default |UNIFI_VERSION| |Controller version|5.13.32 +### Docker Compose + +Here's a template docker-compose.yml file: + +```YAML +version: '3.1' +services: + guest-portal: + image: carlgo11/guest-portal + ports: + - 8080:80 + environment: + - UNIFI_USER=guest-portal + - UNIFI_PASSWORD=abc123 + - UNIFI_URL=https://192.168.1.2:8443 + - UNIFI_SITE=default + - UNIFI_VERSION=5.13.32 + volumes: + - ./bg.jpg:/opt/www/img/bg.jpg + - ./bg.webp:/opt/www/img/bg.webp + restart: on-failure +``` + ## License This work is licensed under the Creative Commons Attribution 4.0 International License.