add configuration section (intro)

This commit is contained in:
cedricve
2021-10-01 09:05:17 +02:00
parent 6997aa4678
commit 1f000e21ef
23 changed files with 1652 additions and 650 deletions

View File

@@ -0,0 +1,41 @@
---
title: "License"
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: 301
toc: true
---
Kerberos Agent is an open source solution that is made available free of charge. The solution and its source code is maintained by the Kerberos.io development team and open source community, and made available through source code, and binaries through a Docker container. Kerberos Agent, and its related binaries, can be used under the MIT license.
## The MIT License (MIT)
Copyright © `2021` `Kerberos.io`
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the “Software”), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Binary file not shown.

After

Width:  |  Height:  |  Size: 496 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 624 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 945 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 616 KiB

View File

@@ -0,0 +1,57 @@
---
title: "Configuration"
description: "Configure Kerberos Hub to your own needs."
lead: "Configure Kerberos Hub to your own needs."
date: 2020-10-06T08:49:31+00:00
lastmod: 2020-10-06T08:49:31+00:00
draft: false
images: []
menu:
hub:
parent: "hub"
weight: 303
toc: true
---
Once you have installed the Kerberos Hub Helm chart, and you confirm to have all microservices properly running you should be able to access the Kerberos Hub login screen and sign in through the default username and password [which was defined during the installation step](https://github.com/kerberos-io/hub#post-installation).
{{< figure src="hub-login.gif" alt="Kerberos Hub login screen after installation." caption="Kerberos Hub login screen after installation." class="stretch">}}
# Accounts
Once you have executed the post installation you should now have a user with the role **owner**. The owner role is the highest privileged role and gives access to all features, functions, Kerberos Agents and related recordings of the specific user. An owner has an overview of all connected Kerberos Agents, and can create sites, groups, alerts, channels, etc. The owner can also delegate specific Kerberos Agents, sites or groups to sub accounts.
## Sub accounts
Sub accounts are created to delegate access to other users, and have a limited scope or access to the different Kerberos Agents and there related recordings and livestreams.
An example of sub account would be a site owner, a store owner, etc. Who only needs access to the livestreams or cameras from the specific site or store.
On top of that a sub account can have a specific role such as **guest** or **editor**. This role will limit the access to specific function and features.
On top of that a sub account can have a specific role such as **guest** or **editor**. This role will limit the access to specific function and features.
You can create a new sub account by navigation to the accounts page and clicking on the `(+ Add Account)` button at the left top.
{{< figure src="hub-add-account.gif" alt="Give another user limited access to Kerberos Hub by creating a sub account." caption="Give another user limited access to Kerberos Hub by creating a sub account." class="stretch">}}
## Sites
While scaling and installing more and more Kerberos Agents, it might become tedious to manage and structure them properly. Due to this reason the concept of sites was created. A site is a logical grouping of a number of Kerberos Agents that are physically installed at the same location.
By creating sites and assigning Kerberos Agents to a specific site, it is easier to monitor specific video streams and there related recordings/events.
Next to that sites also gives an additional advantage in terms of authorization and access control. As described in the accounts paragraph, a sub account can be granted access to only a limited number of sites, and therefore will only be able to view the Kerberos Agents at a specific location.
You can create a new site, by navigating to the sites page and clicking the `(+ Add Site)` button at the left top.
{{< figure src="hub-add-site.gif" alt="Structure your Kerberos Agents by using sites, and introduce Access Control for sub accounts." caption="Structure your Kerberos Agents by using sites, and introduce Access Control for sub accounts." class="stretch">}}
### Groups
Groups are similar to sites, the only difference is that it is more abstract than a site. A group can be for example "Cashdesks", "Entrance gates", "All stores of Belgium", "EMEA sites", etc. A group can be either a collection of sites, what we call then a **site group**, or it can contain a number of cameras from one or more sites, what we call a **group**.
Similar to sites, groups can also be used to give access to specific Kerberos Agents, and introduces a next level of flexibility and access controls. As illustrated before you could have some responsible for all "entrance gates" of all buildings within a specific country. By giving a sub account access to this group, he or she will only see the entrance gates of the different sites and not the other Kerberos Agents belonging to the related sites.
You can create a new group, by navigating to the groups page and clicking the `(+ Add Group)` button at the left top.
{{< figure src="hub-add-group.gif" alt="Structure your Kerberos Agents by using groups, another level of flexibility." caption="Structure your Kerberos Agents by using groups, another level of flexibility." class="stretch">}}

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1011 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.0 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.3 MiB

File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 279 KiB

View File

Before

Width:  |  Height:  |  Size: 246 KiB

After

Width:  |  Height:  |  Size: 246 KiB

View File

@@ -44,11 +44,11 @@ Once a recording is successfully stored in Kerberos Vault, it integrates with th
By using a web browser you can navigate to Kerberos Hub, and review all the recordings made by the Kerberos Agents, the corresponding livestreams and more.
{{< figure src="architecture.svg" alt="Kerberos Hub is composed out of different microservices." caption="Kerberos Hub is composed out of different microservices." class="stretch">}}
{{< figure src="hub-architecture.svg" alt="Kerberos Hub is composed out of different microservices." caption="Kerberos Hub is composed out of different microservices." class="stretch">}}
## Saas or self-hosted
Kerberos Hub is part of the Kerberos Enterprise Suite, and is made available as a SAAS solution for hobbyists (small scale deployments), and self-hosted for enterprise (large scale deployments).
Kerberos Hub is part of the Kerberos Enterprise Suite, and is made available as a SAAS solution for hobbyists (small scale deployments), and self-hosted for enterprises (large scale deployments).
### Software as a service (Saas)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.1 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.3 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.5 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.6 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.9 MiB

View File

@@ -9,7 +9,7 @@ images: []
menu:
hub:
parent: "hub"
weight: 300
weight: 301
toc: true
---
@@ -55,7 +55,7 @@ Next to classifying and predicting objects, the model is also tracing the classi
{{< figure src="hub-ml.gif" alt="The media page gives you an overview of all your recordings." caption="The media page gives you an overview of all your recordings." class="stretch">}}
## Alerts
## Integrations
When a specific event occurred, a notification can be send to one or more channels. A user can compose an event by selecting one or more conditions. Once the event is triggered, a notification is sent to all the enabled channels.
@@ -102,10 +102,7 @@ The high definition livestream is made possible through WebRTC. The full resolut
## Accounts
It is possible to create multiple accounts (also called sub accounts) within your main account. A sub account can be granted access to one or more groups, sites or cameras. The three different roles are:
- Guest: will only see your media recordings. A guest cannot modify, delete or create something.
- Editor: has full access, same permissions as the main account.
It is possible to create multiple accounts (also called sub accounts) within your main account. A sub account can be granted access to one or more groups, sites or cameras.
{{< figure src="hub-accounts.gif" alt="Using accounts you can give external people access." caption="Using accounts you can give external people access." class="stretch">}}

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 246 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 246 KiB

View File

@@ -9,8 +9,33 @@ images: []
menu:
hub:
parent: "hub"
weight: 300
weight: 302
toc: true
---
Kerberos Hub is the single pane of glass for your Kerberos Agents. It comes with a best of breed open source technology stack, a modular design and out-of-the-box scalability. Kerberos Hub allows building and maintaining an ever-growing video streaming and analytics landscape.
No matter how many Kerberos Agents you have running in the field Kerberos Hub will manage it.
## Helm and Kubernetes
Kerberos Hub is composed of a couple of microservices which are all installed in a Kubernetes cluster. Because we are handling with many containers, we can benefit from package managers such as [Helm](https://helm.sh/) to deploy our resources more easily. In the near future we might use the [Kubernetes operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator) as well.
{{< figure src="hub-architecture.svg" alt="Kerberos Hub is composed out of different microservices." caption="Kerberos Hub is composed out of different microservices." class="stretch">}}
## Dependencies
Within the Kerberos Hub architecture we use a couple of third-party, open source, technologies such as:
- MongoDB,
- Kafka,
- Pion Turn / Coturn,
- and Vernemq
## Installation
To install Kerberos Hub, we will redirect you to the official Github repository, [kerberos-io/hub](https://github.com/kerberos-io/hub). This repository includes all the instructions needed to get Kerberos Hub up and running.
## Configuration
When successfully installed the Kerberos Hub Helm chart, it is time to configure the solution to your needs. Learn more about [the configuration here](/hub/configuration).

View File

@@ -1,7 +1,7 @@
---
title: "License"
description: "A series of microservices to bring the scale you are looking for."
lead: "A series of microservices to bring the scale you are looking for."
description: "A license key to consume Kerberos Hub."
lead: "A license key to consume Kerberos Hub."
date: 2020-10-06T08:49:31+00:00
lastmod: 2020-10-06T08:49:31+00:00
draft: false
@@ -9,8 +9,9 @@ images: []
menu:
hub:
parent: "hub"
weight: 300
weight: 305
toc: true
---
Kerberos Hub is licensed through a monthly or yearly subscription. Depending on the

View File

@@ -9,7 +9,7 @@ images: []
menu:
hub:
parent: "hub"
weight: 300
weight: 304
toc: true
---