From be0277432bc9a2ad0172925a65d900f601aeb881 Mon Sep 17 00:00:00 2001 From: Cedric Verstraeten Date: Wed, 1 Feb 2023 20:21:37 +0100 Subject: [PATCH] add documentation for static binary --- README.md | 1 + deployments/README.md | 14 ++++++++++++++ 2 files changed, 15 insertions(+) diff --git a/README.md b/README.md index 6f81b63..051eafe 100644 --- a/README.md +++ b/README.md @@ -110,6 +110,7 @@ As described before a Kerberos Agent is a container, which can be deployed throu We have documented the different deployment models [in the `deployments` directory](https://github.com/kerberos-io/agent/tree/master/deployments) of this repository. There you'll learn and find how to deploy using: +- [Static binary](https://github.com/kerberos-io/agent/tree/master/deployments#0-static-binary) - [Docker](https://github.com/kerberos-io/agent/tree/master/deployments#1-docker) - [Docker Compose](https://github.com/kerberos-io/agent/tree/master/deployments#2-docker-compose) - [Kubernetes](https://github.com/kerberos-io/agent/tree/master/deployments#3-kubernetes) diff --git a/deployments/README.md b/deployments/README.md index 05fef1a..a8066e3 100644 --- a/deployments/README.md +++ b/deployments/README.md @@ -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.