Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 0 additions & 11 deletions .github/dependabot.yml

This file was deleted.

23 changes: 23 additions & 0 deletions .github/renovate.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": [
"config:base",
"default:automergeDigest",
"helpers:pinGitHubActionDigestsToSemver"
],
"minimumReleaseAge": "7 days",
"internalChecksFilter": "strict",
"packageRules": [
{
"description": "Automerge GitHub Actions updates, including majors, when checks pass",
"matchManagers": ["github-actions"],
"automerge": true
},
{
"description": "Automerge TypeScript minor and patch updates when checks pass",
"matchPackageNames": ["typescript"],
"matchUpdateTypes": ["minor", "patch", "pin", "digest"],
"automerge": true
}
]
}
12 changes: 11 additions & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ name: Build

on:
pull_request:
push:
branches: [master]

permissions:
contents: read
Expand All @@ -14,14 +16,22 @@ jobs:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- uses: codespell-project/actions-codespell@8f01853be192eb0f849a5c7d721450e7a467c579 # v2.2
with:
check_hidden: true
path: documentation/docs
skip: '*.png,*.ico'
- uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
with:
node-version: 24.x
node-version: 24
cache: yarn
cache-dependency-path: documentation/yarn.lock
- name: Install Dependencies
working-directory: documentation
run: yarn install --frozen-lockfile
- name: Lint Markdown
working-directory: documentation
run: yarn lint
- name: Build website
working-directory: documentation
run: yarn build
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Dependencies
node_modules
yarn.lock

# Production
build
Expand Down
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# UnPoller Dot Com
# unpoller.com

This repository contains the files that create https://unpoller.com.
Source for [https://unpoller.com](https://unpoller.com). Built with [Docusaurus 3](https://docusaurus.io/).

The application used is [Docusaurus](https://docusaurus.io).
```console
cd documentation
yarn install
yarn start # local dev server
yarn build # production build
yarn lint # markdownlint-cli2 (same as CI)
codespell docs # brew install codespell
```

Push to `master` deploys to GitHub Pages.
34 changes: 34 additions & 0 deletions documentation/.markdownlint-cli2.jsonc
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"config": {
"MD001": false,
"MD002": false,
"MD004": false,
"MD007": false,
"MD009": false,
"MD010": false,
"MD012": false,
"MD013": { "line_length": 110, "tables": false, "code_blocks": false },
"MD022": false,
"MD025": false,
"MD026": false,
"MD030": false,
"MD031": false,
"MD032": false,
"MD033": false,
"MD034": false,
"MD036": false,
"MD037": false,
"MD040": false,
"MD041": false,
"MD046": false,
"MD049": false,
"MD050": false,
"MD055": false,
"MD059": false,
"MD060": false
},
"ignores": [
"node_modules/**",
"build/**"
]
}
49 changes: 6 additions & 43 deletions documentation/README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,12 @@
# Website
# UnPoller docs

This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.

## Installation
This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.

```console
yarn install
yarn start # local dev server
yarn build # production build
yarn lint # markdownlint-cli2 (same as CI)
```

## Local Development

This command starts a local development server and open up a browser window.
Most changes are reflected live without having to restart the server.
**Use this when developing locally!**

```console
yarn start
```

## Build

This command generates static content into the `build` directory and can be served using any static contents hosting service.

```console
yarn build
```


## Deployment

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

```console
DEPLOYMENT_BRANCH=gh-pages GIT_USER=username USE_SSH=true yarn deploy
```

## MDL Linter

To run the linter locally, I had to do this on my Mac, but `bundler` may work too.

```shell
brew install rbenv ruby-build
rbenv install 2.6.5
# eval "$(rbenv init -)"
rbenv shell 2.6.5
gem install mdl
mdl .
```
Push to `master` deploys to GitHub Pages via GitHub Actions.
3 changes: 0 additions & 3 deletions documentation/babel.config.js

This file was deleted.

8 changes: 0 additions & 8 deletions documentation/docs/.mdlrc

This file was deleted.

3 changes: 0 additions & 3 deletions documentation/docs/.style

This file was deleted.

2 changes: 1 addition & 1 deletion documentation/docs/advanced/webserver.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Using Docker:

```shell
docker pull ghcr.io/unpoller/unpoller
docker -it ghcr.io/unpoller/unpoller -e -
docker run -it ghcr.io/unpoller/unpoller -e -
Enter Password:
$2a$04$yOE5zjJs2Gg0jsGQpE7j2ucKiNndUGEzpX6BsLoKl0hkxBvE81z8.
```
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/dependencies/grafana.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ sudo systemctl status grafana-server
You need [Homebrew](https://brew.sh):

```shell
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```
```shell
brew install grafana
Expand Down
11 changes: 7 additions & 4 deletions documentation/docs/dependencies/influxdb.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Start: `sudo systemctl start influxdb`
You need [Homebrew](https://brew.sh):

```shell
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```

```shell
Expand Down Expand Up @@ -115,13 +115,15 @@ by implementing a retention policy. For example, to hold data for 32 days add th
CREATE RETENTION POLICY retention_policy ON unpoller DURATION 32d REPLICATION 1
```

If you're using InfluxDB 2.x (not recommended at this time), you can set the retention policy by exec-ing into the container:
If you're using InfluxDB 2.x (not recommended at this time), you can set the retention
policy by exec-ing into the container:

```none
docker exec -it unpoller_influxdb_1 /bin/bash
```

Extracting the unpoller bucket ID from the result of the command `/usr/local/bin/influx bucket ls` (in the example below, it's `0af2f3c9840627f6`):
Extracting the unpoller bucket ID from the result of the command
`/usr/local/bin/influx bucket ls` (in the example below, it's `0af2f3c9840627f6`):

```none
root@515481c98cb9:/# /usr/local/bin/influx bucket ls
Expand All @@ -131,7 +133,8 @@ ID Name Retention Shard group duration Organization ID Schema Type
0af2f3c9840627f6 unpoller infinite 168h0m0s 5b8f04254daaddb6 implicit
```

And then updating the retention policy with the command `/usr/local/bin/influx bucket update -i 0af2f3c9840627f6 -r 32d`, susbtituting your bucket ID:
And then updating the retention policy with
`/usr/local/bin/influx bucket update -i 0af2f3c9840627f6 -r 32d`, substituting your bucket ID:

```none
root@515481c98cb9:/# /usr/local/bin/influx bucket update -i 0af2f3c9840627f6 -r 32d
Expand Down
5 changes: 2 additions & 3 deletions documentation/docs/dependencies/loki.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,10 @@ The timeout is `10s`, adjust it if you get timeout errors.

## Examples

The `docker-compose` example below (using Loki and Prometheus) was kindly provided by a community member.
The Loki Docker logging driver if you don't have it installed.
The Docker Compose example below (using Loki and Prometheus) was kindly provided by a community member.
Install the Loki Docker logging driver if you don't have it.

```yaml
version: '3.0'
services:
unpoller:
container_name: unpoller
Expand Down
8 changes: 4 additions & 4 deletions documentation/docs/help/common.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Below are some common solutions and possible symptoms.
The number one cause of empty dashboards is an old version of InfluxDB.
Make sure you are on version 1.7.x or 1.8.x. **Use of 1.6.x will cause empty dashboards.**

If your DPI dashboards are empty `DPI` is like still disabled.
If your DPI dashboards are empty, DPI is likely still disabled.
It must be enabled in both the poller config and in your UniFi controller. Two spots.

### Check the port used to connect to the controller
Expand All @@ -23,9 +23,9 @@ old firmware) and `443` (or just omitted) if you are using a unifios device (UDM
UniFi Poller has great logs that help when troubleshooting.
If you're seeking help please enable debug mode and copy/paste some of your logs.
All of this data helps figure out what's going on.
Debug mode can be enable in up.conf or by passing the env variable UP_POLLER_DEBUG=true.
Debug mode can be enabled in up.conf or by passing the env variable `UP_POLLER_DEBUG=true`.

Grafana, Prometheus and InfluxDB also have logs files, but they're probably less useful.
Grafana, Prometheus and InfluxDB also have log files, but they're probably less useful.
You can still check them for errors.

If you are a Docker user then check out [Dozzle](https://dozzle.dev/)
Expand Down Expand Up @@ -59,7 +59,7 @@ If you're getting errors like this:
[ERROR] infdb.Write(bp): {"error":"partial write: field type conflict: input field "tx_power" on measurement "uap_radios" is type integer, already exists as type float dropped="}
```

This usually indicates a bug was fixed and the resulting fixed has caused an incompatibility
This usually indicates a bug was fixed and the resulting fix has caused an incompatibility
with your existing InfluxDB database. This could also indicate you've found a new bug.
Please open an issue if you are running the latest version and dropping the database
did not solve the error. There are generally two fixes:
Expand Down
8 changes: 2 additions & 6 deletions documentation/docs/help/docker_faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,11 @@ you've been overly warned.

You can install a specific version by specifying a version like this:
```shell
docker pull ghcr.io/unpoller/unpoller:latest
```
or minor version like this:
```shell
docker pull ghcr.io/unpoller/unpoller:latest
docker pull ghcr.io/unpoller/unpoller:v5.1.0
```
or a major version like this:
```shell
docker pull ghcr.io/unpoller/unpoller:latest
docker pull ghcr.io/unpoller/unpoller:v5
```

**How can I build from source?**
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/help/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ Discord server.
Or [this](https://community.ui.com/questions/UniFi-Poller-Store-UniFi-Controller-Metrics-in-Prometheus-or-InfluxDB/58a0ea34-d2b3-41cd-93bb-d95d3896d1a1)
thread on the UI community.

Alternatively, raise an [issue](https://github.com/unpoller/unpoller/issues) on Github.
Alternatively, raise an [issue](https://github.com/unpoller/unpoller/issues) on GitHub.
15 changes: 10 additions & 5 deletions documentation/docs/help/manualbuild.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
---
id: manualbuild
title: Manual Build
---

## Manual package

Recommend reading the note at the bottom if you're using a mac.
Read the note at the bottom if you're using a Mac.

1. Install [Go](https://golang.org/doc/install)
1. Install [GoReleaser](https://goreleaser.com/install/)
Expand All @@ -17,17 +22,17 @@ Recommend reading the note at the bottom if you're using a mac.

### Manual Build Notes

If you're building linux packages on a mac you can run `brew install rpmbuild gnu-tar`
If you're building Linux packages on a Mac you can run `brew install rpmbuild gnu-tar`
to get the additional tools you need. That means you're going to need Homebrew.
And if you're going to install Homebrew, or already have, you can simply
do something like this to get your Go environment up and build the packages:

```shell
brew install rpmbuild gnu-tar go goreleaser/tap/goreleaser
mkdir ~/go/{src,mod}
mkdir -p ~/go/{src,mod}
export GOPATH=~/go
cd ~go/src
cd ~/go/src
git clone https://github.com/unpoller/unpoller.git
cd unpoller
make rpm deb
```
```
8 changes: 4 additions & 4 deletions documentation/docs/install/cloudkey.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: CloudKey
## Introduction

Two methods are available for installation on a CloudKey, CloudKey Gen2 or CloudKey G2+.
The method depends on whether the device is running `unifos` or not.
The method depends on whether the device is running UnifiOS or not.

:::note
These solutions are community-supplied and have a limited user base.
Expand Down Expand Up @@ -41,7 +41,7 @@ apt-get update
apt-get install -y influxdb influxdb-client
```

Add user to influx; [from here](https://v2.docs.influxdata.com/v2.0/users/create-user/):
Add user to InfluxDB; [from here](https://docs.influxdata.com/influxdb/v1/tools/influx-cli/):

```shell
influx -host localhost -port 8086
Expand All @@ -53,7 +53,7 @@ GRANT ALL ON unpoller TO unifipoller

:::note
For InfluxDB on a CloudKey it is _highly_ advisable to add a retention policy to
prevent the database from growing in uncontrollably.
prevent the database from growing uncontrollably.
:::

#### Install Unpoller
Expand All @@ -67,7 +67,7 @@ Install the Go Lift package repo and Unpoller with this command:
curl -s https://golift.io/repo.sh | sudo bash -s - unpoller
```

### Current Firmware: `unifios`
### Current Firmware: UnifiOS

There is an existing suite for installing `podman` containers to run on `unifios` -
see [here](https://github.com/boostchicken/udm-utilities). At the time of writing we are not
Expand Down
Loading