Flesh out Wiki?

[Drel]

Hi Ryan,

Thanks so much for creating and maintaining this image for so many years. I'd been using an older version on a Raspberry Pi 4, since the migration to 64 bit left me a little orphaned. Just yesterday, I grabbed a new microSD card, installed Ubuntu Server, and set the system up from scratch again for the first time in a long while. The wiki was very helpful, but there are some gaps, particularly for a user that's new to docker / docker compose.

1. The Wiki has the user create compose.yml and unifi.service files in /opt/unifi, but since the volumes are declared as names rather than paths in the compose.yml, the volumes are created in /var/lib/docker/volumes/ rather than /opt/unifi. Is this intentional? I had a bit of a struggle tracking the volumes down, but found them after getting my container id with docker ps and then running docker inspect -f '{{ .Mounts }}' <container id>.

2. I also found that I was receiving permission errors on Ubuntu Server when trying to view the logs after starting the service ("docker compose logs -f"). I'm trying to remember how I resolved this; I believe I added my user to the docker group and restarted. I also found that viewing the docker compose logs was just returning me to the command line immediately with no output, even with the -f argument. Another restart seemed to fix this, and finally I saw the output I was expecting:

$ docker compose logs -f
unifi  | init complete...
unifi  | Loading /usr/lib/unifi/data/system_env

3. The Wiki covers installing docker and associated plugins, as well as creating a docker compose file and a service definition, then starting the service. You've started UniFi Controller service, but now what? I suggest an entry on "Accessing UniFi Controller" right after "Run it!". This doesn't have to say much, but maybe something like, "If using host networking, point a browser to https://:8443/. You may initially see a 404 if you have just started the unifi service, the web interface may take several minutes to start up depending on the speed of the host. Refresh your browser window periodically until you see the UniFi Controller UI." Or maybe this can just go in the existing Run It section. Another note about the self signed cert might be useful in case the user isn't able to view the page.

4. Another entry that would be useful would be, "Maintaining / Updating the UniFi Docker Image". Otherwise the user will not keep up with new versions as they are released by you. They may see messages about newer versions of UniFi Controller in the web interface and be confused about how to update. This section should lead the user through pulling the docker image, bringing the container down, and then starting it again.

Thank you again, I hope that you find that the suggestions above are useful!