Skip to content

Commit

Permalink
Upate Reme to reflect forking repo
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanvanmass committed Mar 12, 2024
1 parent b5c52cf commit a291c92
Showing 1 changed file with 22 additions and 56 deletions.
78 changes: 22 additions & 56 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,17 @@
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read https://github.com/linuxserver/docker-unifi-controller/blob/master/.github/CONTRIBUTING.md -->
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)

[![Blog](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Blog)](https://blog.linuxserver.io "all the things you can do with our containers including How-To guides, opinions and much more!")
[![Discord](https://img.shields.io/discord/354974912613449730.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Discord&logo=discord)](https://discord.gg/YWrKVTn "realtime support / chat with the community and the team.")
[![Discourse](https://img.shields.io/discourse/https/discourse.linuxserver.io/topics.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=discourse)](https://discourse.linuxserver.io "post on our community forum.")
[![Fleet](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Fleet)](https://fleet.linuxserver.io "an online web interface which displays all of our maintained images.")
[![GitHub](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub&logo=github)](https://github.com/linuxserver "view the source for all of our repositories.")
[![Open Collective](https://img.shields.io/opencollective/all/linuxserver.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Supporters&logo=open%20collective)](https://opencollective.com/linuxserver "please consider helping us by either donating or contributing to our budget")

The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring:

* regular and timely application updates
* easy user mappings (PGID, PUID)
* custom base image with s6 overlay
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
* regular security updates

Find us at:

* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
* [Discourse](https://discourse.linuxserver.io) - post on our community forum.
* [Fleet](https://fleet.linuxserver.io) - an online web interface which displays all of our maintained images.
* [GitHub](https://github.com/linuxserver) - view the source for all of our repositories.
* [Open Collective](https://opencollective.com/linuxserver) - please consider helping us by either donating or contributing to our budget

# This image is deprecated. We will not offer support for this image and it will not be updated.

We recommend our unifi-network-application image instead:
https://github.com/linuxserver/docker-unifi-network-application

# [linuxserver/unifi-controller](https://github.com/linuxserver/docker-unifi-controller)

[![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Funifi-controller?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Funifi-controller)
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-unifi-controller.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-unifi-controller)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-unifi-controller.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-unifi-controller/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-unifi-controller/packages)
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-unifi-controller/container_registry)
[![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/unifi-controller)
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/unifi-controller.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/unifi-controller)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/unifi-controller.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/unifi-controller)
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-unifi-controller%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-unifi-controller/job/master/)
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Funifi-controller%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/unifi-controller/latest/index.html)
[![Blog](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=ryanvanmassenhoven.com&message=Blog)](https://www.ryanvanmassenhoven.com "all the things you can do with our containers including How-To guides, opinions and much more!")
[![GitHub](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=ryanvanmass&message=GitHub&logo=github)](https://github.com/ryanvanmass "view the source for all of our repositories.")

The [LinuxServer.io](https://linuxserver.io) team previously maintained this image but recently depricated it in favour of a different implementation. I have choosen to fork there Repo and continue maintaining it.

Find me at:

* [Blog](https://www.ryanvanmassenhoven.com) - all the things you can do with our containers including How-To guides, opinions and much more!
* [GitHub](https://github.com/ryanvanmass) - view the source for all of our repositories.

[![GitHub Stars](https://img.shields.io/github/stars/ryanvanmass/docker-unifi-controller.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-unifi-controller)
[![GitHub Release](https://img.shields.io/github/release/ryanvanmass/docker-unifi-controller.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-unifi-controller/releases)
[![Docker Pulls](https://img.shields.io/docker/pulls/ryanvanmass/unifi-controller.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/unifi-controller)
[![Docker Stars](https://img.shields.io/docker/stars/ryanvanmass/unifi-controller.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/unifi-controller)

The [Unifi-controller](https://www.ubnt.com/enterprise/#unifi) software is a powerful, enterprise wireless software engine ideal for high-density client deployments requiring low latency and high uptime performance.

Expand All @@ -52,14 +21,14 @@ The [Unifi-controller](https://www.ubnt.com/enterprise/#unifi) software is a pow

We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).

Simply pulling `lscr.io/linuxserver/unifi-controller:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
Simply pulling `ryanvanmass/unifi-controller:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

| Architecture | Available | Tag |
| :----: | :----: | ---- |
| x86-64 || amd64-\<version tag\> |
| arm64 | | arm64v8-\<version tag\> |
| arm64 | | arm64v8-\<version tag\> |
| armhf || |

## Version Tags
Expand All @@ -68,14 +37,11 @@ This image provides various versions that are available via tags. Please read th

| Tag | Available | Description |
| :----: | :----: |--- |
| latest | | Stable Unifi Controller releases. |
| mongoless || Stable Unifi Controller releases without mongodb included. |
| latest | | Stable Unifi Controller releases. |
| 8.0.26 || Unifi Controller Version 8.0.26 |

## Application Setup

### From 2024-01-01 this image will be deprecated and it will no longer be updated. Please migrate to our [Unifi Network Application](https://github.com/linuxserver/docker-unifi-network-application) image instead

See: [https://info.linuxserver.io/issues/2023-09-06-unifi-controller](https://info.linuxserver.io/issues/2023-09-06-unifi-controller) for more information.

The webui is at https://ip:8443, setup with the first run wizard.

Expand Down Expand Up @@ -110,7 +76,7 @@ To help you get started creating a container from this image you can either use
version: "2.1"
services:
unifi-controller:
image: lscr.io/linuxserver/unifi-controller:latest
image: ryanvanmass/unifi-controller:latest
container_name: unifi-controller
environment:
- PUID=1000
Expand Down Expand Up @@ -154,7 +120,7 @@ docker run -d \
-p 5514:5514/udp `#optional` \
-v /path/to/data:/config \
--restart unless-stopped \
lscr.io/linuxserver/unifi-controller:latest
ryanvanmass/unifi-controller:latest
```

## Parameters
Expand Down Expand Up @@ -337,7 +303,7 @@ Below are the instructions for updating containers:
If you want to make local modifications to these images for development purposes or just to customize the logic:

```bash
git clone https://github.com/linuxserver/docker-unifi-controller.git
git clone https://github.com/ryanvanmass/docker-unifi-controller.git
cd docker-unifi-controller
docker build \
--no-cache \
Expand All @@ -354,7 +320,7 @@ docker run --rm --privileged multiarch/qemu-user-static:register --reset
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.

## Versions

* **03.10.24:** - Picked Up by RyanVanMass
* **01.01.24:** - Deprecate.
* **05.09.23:** - Add deprecation warning as per [https://info.linuxserver.io/issues/2023-09-06-unifi-controller](https://info.linuxserver.io/issues/2023-09-06-unifi-controller).
* **04.09.23:** - Bump JRE to 17 to support v7.5.
Expand Down

0 comments on commit a291c92

Please sign in to comment.