Skip to content

Commit

Permalink
Clean up README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Carlgo11 committed Aug 4, 2020
1 parent e600d3c commit 99cd8b8
Showing 1 changed file with 28 additions and 3 deletions.
31 changes: 28 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# UniFi Guest Portal
[![CC-BY-4.0](https://img.shields.io/github/license/carlgo11/guest-portal?style=for-the-badge)](LICENSE)
[![Docker](https://img.shields.io/docker/image-size/carlgo11/guest-portal?style=for-the-badge)](https://hub.docker.com/r/carlgo11/guest-portal/)

## Usage

Expand All @@ -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.
Expand Down

0 comments on commit 99cd8b8

Please sign in to comment.