webhippie/unifi repository overview

⁠unifi

These are docker images for UniFi⁠ running on our Ubuntu image⁠.

⁠Versions

For the available versions please look at Docker Hub⁠ or Quay⁠ or check the existing folders within the GitHub repository⁠.

⁠Volumes

• /var/lib/unifi
• /var/log/unifi
• /var/run/unifi

⁠Ports

• 8080
• 8443

⁠Available environment variables

JAVA_HOME = /usr/lib/jvm/java-8-openjdk-$(dpkg --print-architecture)
UNIFI_CORE_ENABLED = false
UNIFI_DATA_DIR = /var/lib/unifi
UNIFI_ENTROPY_GATHER_DEVICE =
UNIFI_EXTRA_OPTS =
UNIFI_HEALTHCHECK_CODE = 200
UNIFI_HEALTHCHECK_URL = https://localhost:${UNIFI_HTTPS_PORT}/status
UNIFI_HTTP_PORT = 8080
UNIFI_HTTPS_PORT = 8443
UNIFI_JVM_EXTRA_OPTS = -XX:+UseParallelGC
UNIFI_JVM_INIT_HEAP_SIZE =
UNIFI_JVM_MAX_HEAP_SIZE = 1024M
UNIFI_LOG_DIR = /var/log/unifi
UNIFI_MONGODB_EXTRAARGS =
UNIFI_MONGODB_NOJOURNAL =
UNIFI_MONGODB_SERVICE_ENABLED = false
UNIFI_RUN_DIR = /var/run/unifi
UNIFI_SKIP_CHOWN = false
UNIFI_SOURCE_DIR = /usr/lib/unifi

Extracted by the command: grep -hE ': "\$\{(.*)\}"' latest/overlay/etc/entrypoint.d/*.sh | sed 's/: "\${//' | sed 's/:="/ = /' | sed 's/"}"$//' | sort | uniq

⁠Inherited environment variables

• webhippie/ubuntu⁠

⁠Contributing

Generally we are following conventional commits⁠ when we apply changes. That way we are able to generate proper changelogs for every release. Please use always pull requests to integrate new functionalities or to fix issues.

For the release process we are following semantic versioning⁠ which clearly indicates if a new version just resolves bugs, includes new features or even includes breaking changes.

After installing the tools via mise install as described above set up the pre-commit hooks so they run automatically on every commit:

prek install --hook-type pre-commit --hook-type commit-msg

If you have changed something on the source you should simply commit following the mentioned conventions:

git checkout -b feat/new-feature
git add --all
git commit -m 'feat: added awesome new feature'
git push --set-upstream origin feat/new-feature

After pushing your changes into the Git repository you should create a pull request on GitHub. If the pull request have been merged and everything built fine it will also create automatically a new release at least once a week.

⁠Authors

• Thomas Boerger⁠

⁠License

MIT

⁠Copyright

Copyright (c) 2019 Thomas Boerger <http://www.webhippie.de>