# Quick Start Guide
To get started using docker you can use the command below as a reference. The application runs on port
4545 so whichever port you choose needs to be redirected to
4545. You also need to provide a
uri including protocol and port, and
sitename for the Unifi server.
A full list of enviroment variables can be found here
docker run -d \ -p 80:4545 \ -e USERNAME=ubnt \ -e PASSWORD=password \ -e URI=https://unifi.jamiewood.io \ -e SITENAME=default \ -e SECRET=secretString \ -e AUTH=none \ -e REDIRECTURL=https://google.com \ woodjme/unifi-hotspot
Once started navigate to the path
guest/s/$SITENAME/ to test splash page.
You then need to configure the unifi portal to look at this container. To do this go to the
Unifi Control panel ->
Guest Control ->
Enable Guest Control ->
External Portal Server -> Add the
IP Address or
DNS Name of your server / container host.
Display a basic authentication page requiring the users name and email address to continue.
Allows you to bring your own authentication page by mounting
custom.html inside the container. Rememeber that users cannot load external assets until you are authorised so you must bundle these in the
custom.html page. ParcelJS (opens new window) can help with this.
# Bind Mounts
# Custom Auth Page
# Environment Variables
| || ||your unifi controller username|
| || ||your unifi controller password|
| || ||your unifi controller uri|
| || ||the sitename in your unifi controller|
| || ||a secret for the express user session|
| || ||the auth page you want to display|
| || ||the page to redirect to after auth|