# First things first - Kerberos Docs
Open and extensible video surveillance and analytics solution for everyone at any location.

# First things first

Kerberos Opensource and Kerberos Enterprise both store recordings on the local disk. To centralise your data at a single place, additional solutions are available.

#### Kerberos Hub#

One or more Kerberos Enterprise agents, can store their data directly on Kerberos Hub, and benefit from the visualisation layer Kerberos Hub offers. When doing this your recordings will be uploaded inside the Kerberos datacenter (which is a black box for you).

#### Kerberos Vault#

In addition to that you have the option to Bring Your Own Storage (BYOS), using Kerberos Vault. Kerberos Vault allows you to configure the storage providers you want, and allows you to connect to Kerberos Hub in parrallel. These storage provider could live in the cloud such as AWS S3, GCP storage and Azure Blob store, or can be located on premise - at the edge - such as Minio.

Despite the flexible storage capabilities, Kerberos Vault is also an open platform, which can be used to build extensions (mobile apps, web apps, machine learning services, etc) and integrations. It allows you to leverage a scalable and stable system as a strong backbone for your video analytics solutions, machine learning algorithms, and more.

## Kerberos Hub#

Within Kerberos Opensource and Kerberos Enterprise you can upload your recordings to our public Kerberos Hub environment. This means that your data will be hosted and processed (metadata) in our Kerberos Vault (datacenteR). For more information about how Kerberos Hub works can be found here.

Store your recordings in Kerberos Hub

## Kerberos Vault#

If you are using Kerberos Enterprise you have the possibility to bring your own cloud storage or on premise storage. By installing Kerberos Vault you can send your recordings to your own datacenter, private or public cloud. Following providers are supported:

- Google Cloud Platform Storage
- Microsoft Azure Storage
- Amazon Web Services S3
- Minio

When installing Kerberos Vault in the cloud, following architecture can apply. Having your Kerberos Enterprise agents running at the edge, but uploading to Kerberos Vault in the cloud.

Bring your own storage using Kerberos Vault

On the other hand you could also have Kerberos Vault running at the edge, next to your Kubernetes Enterprise agents. This could be useful if you want to do processing or video analytics such as computer vision or machine learning at the edge.

Store your recordings at the edge with Kerberos Vault

### Events#

One of the key differentiators compared to other VMS solutions, is the abilitity to extend and integrate. Next to uploading and persisting data, Kerberos Vault can also trigger events. Each time a recording is send to Kerberos Vault an event can be triggered through one of the following providers.

- Apache Kafka
- Amazon Web Services SQS

Those events can be fetched or subscribed by custom applications. For example, one can create a notifications service, machine learning service or an entire cloud application. Allowing you to leverage the power and scalability of Kerberos Enterprise, and building and focussing on your specific applications, API’s, mobile apps, or whatever you have in mind to build.

Build integrations and create your own workflows using the event capability of Kerberos Vault.

### On-demand upload#

Next to the extension and integration capabilities of Kerberos Vault, it is also possible to synchronise with a central Kerberos Vault. On-Demand upload allows you to synchronise a subset of your recording with an additional Kerberos Vault in the cloud.

Synchronise recordings between multiple Kerberos Vault

A couple of usecases are the following ones:

- Continious recording: having continious recordings stored in your Kerberos Vault on premise, you don’t want to replicate all your recordings to a Kerberos Vault provider in the cloud (to make them public available). Therefore you could implement custom logic, for example based on a machine learning algorithm, to only replicate recordings which matche a specific scenario.

- On-Demand request: Having Kerberos Hub, an end-user could initiate a request for upload. By default no recordings are forwarded from your Kerberos Vault on premise to your Kerberos Vault in the cloud. Only when an end user requests one or more recordings, the upload will start for the requested recordings.

### Open API#

Both Kerberos Enterprise as Kerberos Vault ships with Swagger API’s, which can be used to communicate with the previously mentioned systems. Simply type `/swagger/index.html` after the `api` url, and you will see the Swagger UI popping up. No need to explain the different API’s, use the Swagger and see what is available. See something missing, let us know, and we add it ;).

All capabilities of Kerberos Vault are documented through swagger API’s

## Licensing#

Kerberos Vault is publicly available and requires a license key to operate correctly. Reach out to cedric@kerberos.io for the commercial matters.

Edit this page on GitHub