add documentation for static binary

This commit is contained in:
Cedric Verstraeten
2023-02-01 20:21:37 +01:00
parent a3006f3b9f
commit be0277432b
2 changed files with 15 additions and 0 deletions

View File

@@ -6,6 +6,7 @@ Due to it's nature, of acting as a micro service, there are many different ways
We will discuss following deployment models.
- [0. Static binary](#0-static-binary)
- [1. Docker](#1-docker)
- [2. Docker Compose](#2-docker-compose)
- [3. Kubernetes](#3-kubernetes)
@@ -14,6 +15,19 @@ We will discuss following deployment models.
- [6. Terraform](#6-terraform)
- [7. Salt](#7-salt)
## 0. Static binary
Kerberos Agents are now also shipped as static binaries. Within the Docker image build, we are extracting the Kerberos Agent binary and are [uploading them to the releases page](https://github.com/kerberos-io/agent/releases) in the repository. By opening a release you'll find a `.tar` with the relevant files.
- `main`: this is the Kerberos Agent binary.
- `data`: the folder containing the recorded video, configuration, etc.
- `mp4fragment`: a binary to transform MP4s to Fragmented MP4s.
- `www`: the Kerberos Agent ui (compiled React app).
You can run the binary as following on port `8080`:
main run cameraname 8080
## 1. Docker
Leveraging `docker` is probably one of the easiest way to run and test the Kerberos Agent. Thanks to it's multi-architecture images you could run it on almost every machine. The `docker` approach is perfect for running one or two cameras in a (single machine) home deployment, a POC to verify its capabilities, or testing if your old/new IP camera is operational with our Kerberos Agent.