kris/unifi
kris/unifi
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Simple setup for self-hosting a UniFi Network Server inside a container
1 Commit 1 Branch 0 Tags 24 KiB
JavaScript 100%
main
Go to file
Kris Lamoureux 03c9d835dc
Add basic Unifi Network Application deployment 
- Write initial docker-compose.yml for Unifi containers
- Create a template for initializing MongoDB databases
- Add README with setup instructions for the initial environment
2024-06-29 21:22:52 -04:00
.gitignore Add basic Unifi Network Application deployment 2024-06-29 21:22:52 -04:00
docker-compose.yml Add basic Unifi Network Application deployment 2024-06-29 21:22:52 -04:00
example-init-mongo.js Add basic Unifi Network Application deployment 2024-06-29 21:22:52 -04:00
LICENSE Add basic Unifi Network Application deployment 2024-06-29 21:22:52 -04:00
README.md Add basic Unifi Network Application deployment 2024-06-29 21:22:52 -04:00

README.md

UniFi Network Server Deployment

This project provides a simple setup for self-hosting a UniFi Network Server inside a container to manage Ubiquiti networking gear. It leverages the community-managed linuxserver.io container to save time and engineering effort.

Requirements

  • Docker / Docker Compose
  • pwgen (optional, for password generation)

Compatibility

Starting with version 8.1 of UniFi Network Application, MongoDB versions 3.6 through 7.0 are supported.

Quick Start

Follow these steps to get your UniFi Network Server up and running.

  1. Clone this repository and navigate to the project directory

  2. Copy the example MongoDB initialization script

    cp example-init-mongo.js init-mongo.js

  3. Change the default password to a random string

    sed -i "s/changeme/$(pwgen -s 32 1)/g" init-mongo.js

Note: This command requires pwgen. If you don't have it installed, you can manually edit the file and replace "changeme" with a strong password of your choice.

  1. Set the following environment variables in the .env file
  • UNIFI_VERSION: The desired UniFi Network Application version
  • MONGO_VERSION: The desired MongoDB version
  • MONGO_PASS: The password you set in step 3
  1. Start the containers using Docker Compose: 
    docker-compose up -d

Version Selection

UniFi Network Application

It's recommended to install the latest UniFi version, preferably by specifying the version number. You can omit the -lsXX suffix if desired.

MongoDB

It's highly recommended to use a specific version tag for MongoDB since there are no automatic upgrades between major versions.

Note: Modern MongoDB relies on AVX support. You might encounter issues with pre-Tiger Lake Celeron and Pentium CPUs on versions after 4.4. For non-AVX systems, you can use version 4.4.

Additional Information

For more details and configuration options, please refer to the linuxserver/docker-unifi-network-application documentation.

License

This project is free software under the Zero-Clause BSD.