noctilucago

README

NoctiLuca Server

---

A Reolink Camera Management server written in Go built off of the reolinkapigo. This is the backend to the NoctiLuca frontend.

Sponsorship

Oleaintueri is sponsoring the development and maintenance of these projects within their organisation.

---

This is still untested and heavily in development. 🚧

Join us on Discord

https://discord.gg/8z3fdAmZJP

Get started

Within Docker

docker build . -t noctiluca
// detatch with -d option
docker run -p 8000:8000 noctiluca serve

From Binary

tba

From source

git clone git@github.com:ReolinkCameraAPI/noctiluca-go-server.git
cd noctiluca-go-server
go run . serve

// Or build and run binary
go build -o bin/noctiluca
./noctiluca serve

Configuration

See the example in examples folder or go here

When running the server without any configurations passed, the defaults will kick in for development testing. It is advised to read-up on the configurations to get it working for your use-case.

API Documentation

This system uses swagger to generate the documentation needed from the source code.

To generate new swagger documentation run

swagger generate spec -o swagger.yaml

Serve the html docs

swagger serve swagger.yaml

For a complete matrix of the API, see below table.

resource	GET	POST	PUT	DELETE
camera	X	X	X	X
model	X	X	-	-
user	X	X	X	X
network > Proxy	X	X	X	-

Supported Cameras

Any Reolink camera that has a web UI should work. The other's requiring special Reolink clients do not work and is not supported here.

• RLC-411WS
• RLC-423
• RLC-420-5MP
• RLC-410-5MP
• RLC-520