more tweaks

This commit is contained in:
Cedric Verstraeten
2022-12-17 23:30:09 +01:00
parent b43d80ef9d
commit 10a1d55af0
13 changed files with 287 additions and 56 deletions

View File

@@ -1,7 +1,7 @@
---
title: "First things first"
description: "Kerberos Agent is an efficient video surveillance agent"
lead: "Kerberos Agent is an efficient video surveillance agent"
description: "An agent with a mind for scale"
lead: "An agent with a mind for scale"
date: 2020-10-06T08:49:31+00:00
lastmod: 2020-10-06T08:49:31+00:00
draft: false
@@ -13,10 +13,16 @@ weight: 201
toc: true
---
Kerberos Agent is a cutting edge video surveillance management system made available as Open Source under the MIT License. This means that all the source code is available for you or your company, and you can use, transform and distribute the source code; as long you keep a reference of the original license. Kerberos Agent can be used for commercial usage (which was not the case for v2). Read more about the license here.
The Kerberos Agent is an isolated and scalable video management agent with a strong focus on user experience, scalability, resilience, extension and integration. It is the backbone of the entire Kerberos.io ecosystem, and is used as a foundation for small deployments to production level deployments with thousands of cameras.
Next to the Kerberos Agent, Kerberos.io provides many other tools such as [Kerberos Factory](/factory/first-things-first), [Kerberos Vault](/vault/first-things-first) and [Kerberos Hub](/hub/first-things-first) to provide additional capabilities: bring your own cloud, bring your own storage, central overview, live streaming, machine learning etc.
As [explained before](/prologue/how/), there is no need to install all those components from the start. Usually you just start with a few Kerberos Agents, scale over time, and add additional components to support additional use cases.
## Introduction
Kerberos.io applies the concept of agents. An agent is running next to or on your camera, and is processing a single camera feed. It applies motion based recording and make those recordings available through a user friendly web interface. Kerberos Agent allows you to connect to other cloud services or custom applications. Kerberos Agent is perfect for personal usage and/or is a great tool if you only have a couple of surveillance cameras to be processed.
So by now you'll understand that Kerberos.io [applies the concept of agents](/prologue/how/). An agent is running next to (or on) your camera, and is processing a single camera feed. It applies motion based or continuous recording and make those recordings available through a user friendly web interface. A Kerberos Agent allows you to connect to other cloud services or integrates with custom applications.
![Kerberos Agent overview](kerberos-agent-overview.gif)
![Kerberos Agent overview](kerberos-agent-overview.gif)
We'll provide a more detailed explanation of the Kerberos Agent, but it's important to know that the [Kerberos Agent GitHub repository](https://github.com/kerberos-io/agent) contains the most accurate and latest information. You can find [a brief list of features and functions here](https://github.com/kerberos-io/agent#a-world-of-kerberos-agents).

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.0 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 866 KiB

View File

@@ -0,0 +1,54 @@
---
title: "Getting Started"
description: ""
lead: ""
date: 2020-10-06T08:49:31+00:00
lastmod: 2020-10-06T08:49:31+00:00
draft: false
images: []
menu:
agent:
parent: "agent"
weight: 202
toc: true
---
Once you've installed one ore more Kerberos Agents, you should have access to the Kerberos Agent user interface. The interface allows you to interact with the Kerberos Agent, and more specifically configure the camera stream, setup a cloud connection, watch recordings and live views, etc.
Having a UI in place, it is important to note that Kerberos Agent also ships numerous APIs, that allow you to automate the configuration. The APIs are exposed as, Swagger documentation, and can be used for configuration of Kerberos Agent but also development of custom applications or business logic.
## Login page
Once you open a browser, and navigate to the Kerberos Agent user app (see installation for the URL), you will land on the login page.
{{< figure src="login.gif" alt="After successful installation you should be able to access the login page." caption="After successful installation you should be able to access the login page." class="stretch">}}
The default username and password of the Kerberos Vault app is:
- username: **root**
- password: **root**
> The username and password can be changed [by setting an environment variable](https://github.com/kerberos-io/agent#configure-with-environment-variables).
## Dashboard
On the dashboard page, you'll find a summary of the most relevant information and insights.
{{< figure src="dashboard.gif" alt="All relevant information on a single pane of glass" caption="All relevant information on a single pane of glass" class="stretch">}}
## Media
At the media page you'll find all your past and future recordings. It shows the recordings in a latest to oldest view and allowxs you to filter and browse through your recordings.
{{< figure src="media.gif" alt="All your recordings in a single place." caption="All your recordings in a single place." class="stretch">}}
## Settings
The settings page allows you to modify the Kerberos Agent configuration. While configuring you will find different settings such as:
- general (name, timezone, etc)
- camera (which main stream and/or sub stream)
- streaming
- persistence
{{< figure src="settings.gif" alt="Configure your Kerberos Agent." caption="Configure your Kerberos Agent." class="stretch">}}

Binary file not shown.

After

Width:  |  Height:  |  Size: 1012 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 136 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.4 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 520 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 245 KiB

View File

@@ -1,7 +1,7 @@
---
title: "Installation"
description: "Install a Kerberos Agent where and how you want."
lead: "Install a Kerberos Agent where and how you want."
description: "Run Kerberos Agents everywhere"
lead: "Run Kerberos Agents everywhere"
date: 2020-10-06T08:49:31+00:00
lastmod: 2020-10-06T08:49:31+00:00
draft: false
@@ -13,52 +13,15 @@ weight: 202
toc: true
---
The easiest to get your Kerberos Agent up and running is to use our Docker image on Docker hub. Once you selected a specific tag, run below command, which will open the web interface of your Kerberos agent on port 80. For persisting your configuration and/or recordings attach a volume. For more in depth configuration and installation verify [the Kerberos Agent repo](https://github.com/kerberos-io/agent).
As described before a Kerberos Agent is a container, which can be deployed through various ways and automation tools such as docker, docker compose, kubernetes and the list goes on. To simplify your life we have come with concrete and working examples of deployments to help you speed up your Kerberos.io journey.
### Running as a container
We have documented the different deployment models in the [Kerberos Agent GitHub repository](ttps://github.com/kerberos-io/agent/tree/master/deployments). There you'll learn and find how to deploy using:
We are creating Docker images as part of our CI/CD process. You'll find our Docker images on [Docker hub](https://hub.docker.com/r/kerberos/agent). Pick a specific tag of choice, or use latest. Once done run below command, this will open the web interface of your Kerberos agent on port 80.
docker run -p 80:80 --name mycamera -d kerberos/agent:latest
- [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)
- [Red Hat OpenShift with Ansible](https://github.com/kerberos-io/agent/tree/master/deployments#4-red-hat-ansible-and-openshift)
- [Terraform](https://github.com/kerberos-io/agent/tree/master/deployments#5-terraform)
- [Salt](https://github.com/kerberos-io/agent/tree/master/deployments#6-salt)
Or for a develop build:
docker run -p 80:80 --name mycamera -d kerberos/agent-dev:latest
Feel free to use another port if your host system already has a workload running on `80`. For example `81`.
docker run -p 81:80 --name mycamera -d kerberos/agent-dev:latest
Login with default username and password which are root/root.
### Attach a volume
By default your Kerberos agent will store all its configuration and recordings inside the container. It might be interesting to store both configuration and your recordings outside the container, on your local disk. This helps persisting your storage even after you decide to wipe out your Kerberos agent.
You attach a volume to your container by leveraging the `-v` option. To mount your own configuration file, execute as following:
1. Decide where you would like to store your configuration and recordings; create a new directory for the config file and recordings folder accordingly.
mkdir agent
mkdir agent/config
mkdir agent/recordings
2. Once you have located your desired directory, copy the latest [`config.json`](https://github.com/kerberos-io/agent/blob/master/machinery/data/config/config.json) file into your config directory.
wget https://raw.githubusercontent.com/kerberos-io/agent/master/machinery/data/config/config.json -O agent/config/config.json
3. Run the docker command as following to attach your config directory and recording directory.
docker run -p 80:80 --name mycamera -v $(pwd)/agent/config:/home/agent/data/config -v $(pwd)/agent/recordings:/home/agent/data/recordings -d kerberos/agent:latest
Login with default username and password which are root/root.
### Configure using environment variables
If you prefer to configure Kerberos Agent using environment variables instead of or in addition to mounted config file, you can do that as well. See the [list of available environment variables](https://github.com/kerberos-io/agent#configure-with-environment-variables).
For example, to pre-configure a different username and password, use this docker run command:
docker run -p 80:80 --name mycamera -v $(pwd)/agent/config:/home/agent/data/config -v $(pwd)/agent/recordings:/home/agent/data/recordings -d -e AGENT_USERNAME=user -e AGENT_PASSWORD=secret kerberos/agent:latest
This will let you login using username `user` and password `secret`.
By default your Kerberos Agents will store all its configuration and recordings inside the container. To help you automate and have a more consistent data governance, you can [attach volumes](https://github.com/kerberos-io/agent#configure-and-persist-with-volume-mounts) to configure and persist data of your Kerberos Agents, and/or configure each Kerberos Agent [through environment variables](https://github.com/kerberos-io/agent#configure-with-environment-variables).

View File

@@ -13,7 +13,6 @@ weight: 300
toc: true
---
[![Scale your video landscape with Kerberos Factory
](youtube-factory-kerberosio.png)](http://www.youtube.com/watch?v=ZGV7w8haUCU "Scale your video landscape with Kerberos Factory")
@@ -21,11 +20,11 @@ toc: true
Kerberos Factory brings the Kerberos Agent to another level. The Kerberos Agent can be deployed anywhere you want, it can run as a binary, Docker container and inside a Kubernetes cluster. The latter is where Kerberos Factory shines, it is a UI that allows you to deploy and configure your Kerberos Agents into your Kubernetes cluster more easily.
{{< figure src="kerberos-enterprise-suite.svg" alt="Kerberos Enterprise Suite contains Kerberos Agent, Kerberos Factory, Kerberos Vault and Kerberos Hub." caption="Kerberos Enterprise Suite contains Kerberos Agent, Kerberos Factory, Kerberos Vault and Kerberos Hub." class="stretch">}}
{{< figure src="introduction-enterprise.svg" alt="Kerberos Enterprise Suite contains Kerberos Agent, Kerberos Factory, Kerberos Vault and Kerberos Hub." caption="Kerberos Enterprise Suite contains Kerberos Agent, Kerberos Factory, Kerberos Vault and Kerberos Hub." class="stretch">}}
## Kerberos Factory in a nutshell
Kerberos Factory is a front-end that consumes and interacts with the Kubernetes API. It schedules Kerberos Agents as Kubernetes resource, and more specific `deployments`. For every camera stream a Kerberos Agent is created as a Kubernetes deployment.
Kerberos Factory is a front-end that consumes and interacts with the Kubernetes API. It schedules Kerberos Agents as Kubernetes resource, and more specific `deployments`. For every camera stream a Kerberos Agent is created as a Kubernetes deployment.
Through the front-end an administrator can configure or add more Kerberos Agents to the cluster. The administrator has the ability to interact with the Kerberos Agent through one or more configuration screens, to tune and optimize the Kerberos Agent.

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 164 KiB