https://github.com/reolinkcameraapi/noctilucago

A Reolink Camera Management server written in Go. This is the backend to the reolink-manager frontend.
https://github.com/reolinkcameraapi/noctilucago

gin-gonic golang ip-cameras reolink reolink-api reolink-client reolink-manager restful

Last synced: 2 months ago
JSON representation

A Reolink Camera Management server written in Go. This is the backend to the reolink-manager frontend.

• Host: GitHub
• URL: https://github.com/reolinkcameraapi/noctilucago
• Owner: ReolinkCameraAPI
• License: gpl-3.0
• Created: 2020-12-15T13:06:35.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2020-12-28T11:37:36.000Z (about 4 years ago)
• Last Synced: 2024-06-19T11:29:56.885Z (7 months ago)
• Topics: gin-gonic, golang, ip-cameras, reolink, reolink-api, reolink-client, reolink-manager, restful
• Language: Go
• Size: 472 KB
• Stars: 4
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


NoctiLuca Server












---

A Reolink Camera Management server written in Go built off of

the [reolinkapigo](https://github.com/ReolinkCameraAPI/reolinkapigo). This is the backend to the NoctiLuca frontend.

### Sponsorship



[Oleaintueri](https://oleaintueri.com) is sponsoring the development and maintenance of these projects within their

organisation.

---

### This is still untested and heavily in development. :construction:

### 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 [email protected]: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](https://github.com/ReolinkCameraAPI/noctilucago/blob/main/examples/Configuration.md)

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](https://github.com/go-swagger/go-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