From 9b9ffb41eaa446e787e714e444a6ed092107dcf6 Mon Sep 17 00:00:00 2001 From: cedricve Date: Tue, 6 Jul 2021 17:50:11 +0000 Subject: [PATCH] deploy: 17ff73ae650633b42413894c17121a2cd0a91758 --- 404.html | 6 +++--- categories/index.html | 6 ++++++ categories/index.xml | 1 + contributors/index.html | 6 +++--- contributors/index.xml | 2 +- enterprise/first-things-first/index.html | 10 +++++----- enterprise/get-started/index.html | 8 ++++---- enterprise/index.html | 8 ++++---- enterprise/index.xml | 12 ++++++------ enterprise/installation-cloud/index.html | 12 ++++++------ enterprise/installation-edge/index.html | 12 ++++++------ enterprise/installation/index.html | 10 +++++----- enterprise/releases/index.html | 8 ++++---- help/index.html | 6 +++--- help/index.xml | 2 +- hub/first-things-first/index.html | 10 +++++----- hub/index.html | 8 ++++---- hub/index.xml | 2 +- index.html | 8 ++++---- ...ef2b635a64248e2cf3a7a023136087ed4050162608.js | 2 +- ...fe039a5078c71ae4d000486d26f9b920cc7db474da.js | 1 + ...1fe88c2f0e2715a21f936047d0d0b85dc48cb864b9.js | 1 - opensource/contribute/index.html | 10 +++++----- opensource/first-things-first/index.html | 10 +++++----- opensource/get-started/index.html | 8 ++++---- opensource/index.html | 8 ++++---- opensource/index.xml | 16 ++++++++-------- opensource/installation-advanced/index.html | 10 +++++----- opensource/installation/index.html | 12 ++++++------ opensource/license/index.html | 10 +++++----- opensource/machinery/index.html | 10 +++++----- opensource/releases/index.html | 8 ++++---- opensource/upgrade/index.html | 10 +++++----- opensource/web/index.html | 10 +++++----- opensourcev3/announcement/index.html | 8 ++++---- opensourcev3/index.html | 8 ++++---- opensourcev3/index.xml | 2 +- prologue/deployments/index.html | 8 ++++---- prologue/glossary/index.html | 8 ++++---- prologue/how/index.html | 8 ++++---- prologue/index.html | 8 ++++---- prologue/index.xml | 6 +++--- robots.txt | 2 +- sitemap.xml | 2 +- tags/index.html | 6 ++++++ tags/index.xml | 1 + vault/first-things-first/index.html | 12 ++++++------ vault/get-started/index.html | 12 ++++++------ vault/index.html | 8 ++++---- vault/index.xml | 16 ++++++++-------- vault/installation-cloud/index.html | 12 ++++++------ vault/installation-edge/index.html | 12 ++++++------ vault/installation/index.html | 10 +++++----- vault/providers/index.html | 12 ++++++------ vault/recycle/index.html | 12 ++++++------ vault/releases/releases/index.html | 10 +++++----- 56 files changed, 230 insertions(+), 216 deletions(-) create mode 100644 categories/index.html create mode 100644 categories/index.xml rename index.min.043f7b7308409ac3e67679315a41fd9fac3fd39f80a7f5ac82dd92857185f29b11e21997d5723c9fc448098a72292664dc3016ded635b4475220cdbd4bdda613.js => index.min.71e05784bf5441c378e8824d18e4b5a057f28cde2bd06f927216eb278586f7ea7d96309df4600474b3b928ef2b635a64248e2cf3a7a023136087ed4050162608.js (99%) create mode 100644 js/highlight.min.13bf6b39f28cd07b0780c0c154bf050bad1e7b73231c15e43b993504cca3fa814222ded3c525f429528451fe039a5078c71ae4d000486d26f9b920cc7db474da.js delete mode 100644 js/highlight.min.8cdbefd08ec63ef25f4b2510ae50c13b3d9ed43e25a15ddb55f14c33130e68cf8be3131ccf2d087c49f5f21fe88c2f0e2715a21f936047d0d0b85dc48cb864b9.js create mode 100644 tags/index.html create mode 100644 tags/index.xml diff --git a/404.html b/404.html index 2b949cc..a310985 100644 --- a/404.html +++ b/404.html @@ -1,6 +1,6 @@ -404 Page not found - Kerberos Docs
- +404 Page not found - Kerberos Docs
+ Kerberos Docs

Page not found :(

The page you are looking for doesn't exist or has been moved.

\ No newline at end of file +Kerberos.io
    • \ No newline at end of file diff --git a/categories/index.html b/categories/index.html new file mode 100644 index 0000000..7199279 --- /dev/null +++ b/categories/index.html @@ -0,0 +1,6 @@ +Categories - Kerberos Docs
    + +Kerberos Docs +

    Categories

    \ No newline at end of file diff --git a/categories/index.xml b/categories/index.xml new file mode 100644 index 0000000..ad4d486 --- /dev/null +++ b/categories/index.xml @@ -0,0 +1 @@ +Categories onhttps://doc.kerberos.io/categories/Recent content in Categories onHugo -- gohugo.ioen-US \ No newline at end of file diff --git a/contributors/index.html b/contributors/index.html index e401779..a8e4ff1 100644 --- a/contributors/index.html +++ b/contributors/index.html @@ -1,6 +1,6 @@ -Contributors - Kerberos Docs
    - +Contributors - Kerberos Docs
    + Kerberos Docs

    Contributors

    \ No newline at end of file +Kerberos.io
    • \ No newline at end of file diff --git a/contributors/index.xml b/contributors/index.xml index 8c2ac08..f8e5970 100644 --- a/contributors/index.xml +++ b/contributors/index.xml @@ -1 +1 @@ -Contributors onhttps://staging.doc.kerberos.live/contributors/Recent content in Contributors onHugo -- gohugo.ioen-US \ No newline at end of file +Contributors onhttps://doc.kerberos.io/contributors/Recent content in Contributors onHugo -- gohugo.ioen-US \ No newline at end of file diff --git a/enterprise/first-things-first/index.html b/enterprise/first-things-first/index.html index 543e0eb..13ac69f 100644 --- a/enterprise/first-things-first/index.html +++ b/enterprise/first-things-first/index.html @@ -1,8 +1,8 @@ -First things first - Kerberos Docs
    - +First things first - Kerberos Docs
    + Kerberos Docs

    First things first

    A revolutionary design to scale your video analytics and video surveillance landscape.

    Over the years Kerberos evolved into a mature and stable solution. Lots of people and companies started to adopt the system, and requested enhancements. Despite the fact that Kerberos Open Source is stable and feature rich, every +

    First things first

    A revolutionary design to scale your video analytics and video surveillance landscape.

    Over the years Kerberos evolved into a mature and stable solution. Lots of people and companies started to adopt the system, and requested enhancements. Despite the fact that Kerberos Open Source is stable and feature rich, every solution has its limitations, especially if you aim to scale it.

    That being said, Kerberos Open Source is perfect when monitoring a limited set of surveillance cameras, but it doesn’t scale well if you plan to monitor dozens or hundreds of surveillance cameras. Although Kerberos Open Source ships -as a Docker image, it has no high availability or fail over functionality.

    Independently we’ve seen many vendors developing their own custom VMS solutions, usually tightly coupled to there proprietary surveillance hardware, which are delivered to enterprise customers as closed software solutions with limited API’s and/or messaging capabilities.

    Due to these reasons we have developed Kerberos Enterprise, Kerberos Storage and Kerberos Cloud, which is an open scalable solution stack, suitable for your ever growing video surveillance landscape, but having extensibility and integration built-in from the ground up.

    The major key differentiators compared to to other solutions are:

    • Scalability with Kubernetes,
    • Open API’s with well documented Swagger API’s,
    • Host anywhere, in the cloud or on premise,
    • Integration and extension, allowing to build custom apps, ML services and more.

    Kubernetes

    To provide our customer with the high availability and fail over requirements they have, Kerberos Enterprise was built on top of Kubernetes (k8s). This container orchestrator allows us to scale a video surveillance landscape horizontally, and deliver a never-seen high available video surveillance system.

    When you start having bigger deployments it's recommended to go with a Kubernetes approach.

    When you start having bigger deployments it’s recommended to go with a Kubernetes approach.

    Kerberos Enterprise is installed inside a Kubernetes cluster. It will create pods/deployments for every surveillance camera you want to monitor. Kubernetes will scale and distrubute these pods across your nodes (VM’s/Baremetal machines).

    Nodes inside your cluster can fail or crash, Kubernetes will make sure the Kerberos pods running on the failed nodes will be deployed to healthy node. This, to make sure the monitoring of your video surveillance cameras continues seamlessly.

    By having the power to add nodes to your cluster, you can anticipate to the ever growing need of your surveillance cameras. With the Kubernetes tools you can monitor your cluster and get into the details.

    Cloud or on premise

    You install Kerberos Enterprise inside a Kubernetes cluster, but there are no limitations where this cluster will be actually running. This means that whatever security policy you have within your company, you can run it where you want: on-premise, public cloud, private cloud, etc.

    As previous mentioned you could process them in a Kubernetes cluster in the cloud.

    As previous mentioned you could process them in a Kubernetes cluster in the cloud.

    Licensing

    Kerberos Enterprise is publicly available and does not require a license key to operate correctly. Everyone can install the Kerberos Enterprise component free of charge.

    Edit this page on GitHub

    Get Started →
    \ No newline at end of file +as a Docker image, it has no high availability or fail over functionality.

    Independently we’ve seen many vendors developing their own custom VMS solutions, usually tightly coupled to there proprietary surveillance hardware, which are delivered to enterprise customers as closed software solutions with limited API’s and/or messaging capabilities.

    Due to these reasons we have developed Kerberos Enterprise, Kerberos Storage and Kerberos Cloud, which is an open scalable solution stack, suitable for your ever growing video surveillance landscape, but having extensibility and integration built-in from the ground up.

    The major key differentiators compared to to other solutions are:

    • Scalability with Kubernetes,
    • Open API’s with well documented Swagger API’s,
    • Host anywhere, in the cloud or on premise,
    • Integration and extension, allowing to build custom apps, ML services and more.

    Kubernetes

    To provide our customer with the high availability and fail over requirements they have, Kerberos Enterprise was built on top of Kubernetes (k8s). This container orchestrator allows us to scale a video surveillance landscape horizontally, and deliver a never-seen high available video surveillance system.

    When you start having bigger deployments it's recommended to go with a Kubernetes approach.

    When you start having bigger deployments it’s recommended to go with a Kubernetes approach.

    Kerberos Enterprise is installed inside a Kubernetes cluster. It will create pods/deployments for every surveillance camera you want to monitor. Kubernetes will scale and distrubute these pods across your nodes (VM’s/Baremetal machines).

    Nodes inside your cluster can fail or crash, Kubernetes will make sure the Kerberos pods running on the failed nodes will be deployed to healthy node. This, to make sure the monitoring of your video surveillance cameras continues seamlessly.

    By having the power to add nodes to your cluster, you can anticipate to the ever growing need of your surveillance cameras. With the Kubernetes tools you can monitor your cluster and get into the details.

    Cloud or on premise

    You install Kerberos Enterprise inside a Kubernetes cluster, but there are no limitations where this cluster will be actually running. This means that whatever security policy you have within your company, you can run it where you want: on-premise, public cloud, private cloud, etc.

    As previous mentioned you could process them in a Kubernetes cluster in the cloud.

    As previous mentioned you could process them in a Kubernetes cluster in the cloud.

    Licensing

    Kerberos Enterprise is publicly available and does not require a license key to operate correctly. Everyone can install the Kerberos Enterprise component free of charge.

    Edit this page on GitHub

    Get Started →
    \ No newline at end of file diff --git a/enterprise/get-started/index.html b/enterprise/get-started/index.html index 8d3c012..8386297 100644 --- a/enterprise/get-started/index.html +++ b/enterprise/get-started/index.html @@ -1,6 +1,6 @@ -Get Started - Kerberos Docs
    - +Get Started - Kerberos Docs
    + Kerberos Docs

    Get Started

    What to expect from the Kerberos Enterprise agent.

    Once you’ve installed Kerberos Enterprise, you will have the Kerberos Enterprise Factory webapp running inside your cluster. This web application allows you to administrate your Kerberos Enterprise agents as deployments/pods. It comes a bunch of other features as well, read on.

    Important to note is that this web app is relying on the Golang Kubernetes SDK, so that means from an administration point of view, you could simply use the well known kubectl command. The webapp just add (a lot of) functionalities on top of the Kubernetes API, which are specific to Kerberos Enterprise agents.

    Login page

    Once you open a browser, and navigate to the Factory web application (see installation for the url), you will land on the login page.

    Login into the Kerberos Enterprise agent interface.

    Login into the Kerberos Enterprise agent interface.

    The default username password of the Factory web applications is:

    • username: root
    • password: kerberos

    The username and password can be changed in the deployment.yaml file.

    Overview

    On the overview page you will find an intuitive overview of the different pages and functionalities. On the left menu you will see two sections: Docker and Kubernetes. Kerberos Enterprise can both run in Docker (single-host) and Kubernetes (cluster) mode, however the recommended way is of course Kubernetes.

    When working with Kubernetes, Kerberos Enterprise agents are deployed as a deployment. When working with Docker, Kerberos Enterprise agents are deployed as traditional Docker containers.

    Review your Docker or Kubernetes agents.

    Review your Docker or Kubernetes agents.

    Kubernetes

    On the left menu you will find the Kubernetes section. In this section 3 sub menu’s are available:

    • Nodes: a list of all the nodes in your cluster.
    • Deployments: a list of all the Kerberos Enterprise agents running in your cluster.
    • Pods: all the pods running in your cluster.

    Nodes

    The nodes section lists all the available nodes inside your Kubernetes cluster. It shows a limited amount of information such as the version, the number of Docker images installed on the node, and some basic hardware information.

    Get an entire list of nodes which are connected to your Kubernetes cluster.

    Get an entire list of nodes which are connected to your Kubernetes cluster.

    Deployments

    The deployments section will list all the Kerberos Enterprise agents (running as deployments) that you have deployed inside your cluster. This page gives you access to deploy new Kerberos Enterprise agents one by one or in bulk. Next to that you can easily upgrade Kerberos Enterprise agents to a newer version, reboot them, view logging and update the configuration options of the Kerberos Enterprise agent.

    Get a list of all your Kerberos Enterprise agents.

    Get a list of all your Kerberos Enterprise agents.

    Adding a new deployment

    There are two options to add a new deployment, single deployments and bulk deployment.

    Get a list of all your Kerberos Enterprise agents.

    Get a list of all your Kerberos Enterprise agents.

    • single deployment

    By specifying a name for your deployment, and it’s corresponding RTSP url, a new deployment will be created for you, and deployed to one of your installed nodes.

    • in bulk deployment.

    By importing an Excel file, deployments can be created in bulk.

    By specifying the name and corresponding RTSP url in multiple rows, you can deploy your deployments in bulk.

    Add a Kerberos Enterprise agent through a deployment.

    Add a Kerberos Enterprise agent through a deployment.

    Configuring a deployment

    Once you have a running deployment, you should see a green circle next to the deployment, indicating that it is succesfully running. At any time you can configure your deployments by clicking on the icon. This will open a popup, allowing you to change some settings.

    Once you created the Kerberos Enterprise agent, you can configure the agent.

    Once you created the Kerberos Enterprise agent, you can configure the agent.

    Following settings can be changed:

    • One or more regions of interest,
    • Time based conditions,
    • Pre- and postrecording
    • Continious recording
    • Linking to Kerberos Hub or Kerberos Vault

    Global configuration

    Configuration can be specified on a Kerberos Enterprise agent level, this means that you update the configuration of a specific deployment. However can also be specified at a higher level. This higher level is what we call the global configuration.

    By specifying configurations at a higher level, any Kerberos Enterprise agents will inherit from that configuration, improving the overall maintenance and management of your Kerberos Enterprise agents.

    You can specify the configurations on a global level, so all agents will inherit from that.

    You can specify the configurations on a global level, so all agents will inherit from that.

    Upgrade or reboot a Kerberos Enterprise agent

    At Kerberos.io we have fast development cycles, which means that new versions will be released every day, week or month. To make sure you can upgrade or downgrade your Kerberos Enterprise agent easily, an upgrade feature is built-in. When pressing the upgrade button, you will be able to select the version to which you would like to upgrade or downgrade. Once submitted, a zero downtime upgrade will take place. Kubernetes will download the new release, create a new pod, and destroy the old one.

    At any moment you can reboot your Kerberos Enterprise agent. When pressing the reboot button, next to your deployment, Kubernetes will destroy the pod of your deployment, and schedule a new one. This comes in handy, when you noticed one of your Kerberos Enterprise agents is in a stale state.

    You can specify the configurations on a global level, so all agents will inherit from that.

    You can specify the configurations on a global level, so all agents will inherit from that.

    Pods

    When creating a Kerberos Enterprise agent, Kubernetes will create a deployment and schedule a pod. This pod will be managed by your deployment, and deployed as a Docker container to one of your available nodes. Once a pod dies/ crashes, or whatever unexpected scenario, the deployment will make sure it is deployed again to a different (or the same) node. This makes sure the Kerberos Enterprise agent is in a healthy state at all times.

    When creating a deployment, a Kubernetes pod has created and assigned to a node.

    When creating a deployment, a Kubernetes pod has created and assigned to a node.

    Storage and video management

    Kerberos Enterprise allows you to scale your video landscape horizontally, using the concept of Kubernetes, and brings a strong backbone for stability and performance. It allows you to avoid reinventing the wheel, and get stuck in the numerious challenges of making an intelligent VMS yourself (we worked on this for 2 years with experienced engineers).

    Kerberos Enterprise stores its recordings locally for a short amount of time. This means that long-term storage is not included in the solution. On top of that it also does not have a visual component, which allows you te review dashboards or recordings. To overcome these two challenges, long-term storage with extensibility/integration capabilities and visualisation features, following solutions were developed Kerberos Vault and Kerberos Hub.

    Kerberos Vault

    Kerberos Vault is a solution which makes it able to store recordings from Kerberos Enterprise agents (accross different clusters) at a central place, on the storage provider you want. You can store your recordings in the cloud (AWS S3, Google Cloud Storage, Azure Blob storage) or on premise (Minio).

    On the other hand it’s an open platform, as it allows you build extensions and integrations (web apps, mobile apps, machine learning services much more). Kerberos Vault ships with the ability of real-time messaging (Kafka) and a REST API (documented as Swaggger).

    Kerberos Vault allows you to centralise your recordings and build integrations.

    Kerberos Vault allows you to centralise your recordings and build integrations.

    To connect one or more Kerberos Enterprise agents to your Kerberos Vault instance, you should open the configuration option and navigate to the cloud tab. When selected you need to fill-in the credentials from your Kerberos Vault account.

    • Storage URI: this is the API endpoint of your Kerberos Vault instance. Usually this is in the following format: http(s)://api.yourdomain.com/storage. Where api.yourdomain.com should match your Kerberos Vault API endpoint.

    • Provider: the name of the provider, which you created on the Kerberos Vault providers page, to which you want to send your recordings to.

    • Directory: this is the subdirectory in which your files will be stored. At the time of writing this should also equal your Kerberos Hub username, if you plan to upload to Kerberos Hub.

    • Access Key: this should match the access key of one of your Kerberos Vault accounts.

    • Secret Access Key: this should match the secret access key of one of your Kerberos Vault accounts.

    Using Kerberos Vault you can bring your own storage, and store the recordings of your agents in your own storage provider.

    Using Kerberos Vault you can bring your own storage, and store the recordings of your agents in your own storage provider.

    Kerberos Hub

    For the visualisation part Kerberos Hub comes into the picture. Kerberos Hub is a web app, backed up with a number of microservices, that shows dashboards, live streams, filter recordings and much more. Learn more about the features and functions here.

    You have two choices when using Kerberos Hub, either you send your recordings from your Kerberos Enterprise agents directly to Kerberos Hub, or you send your recordings to Kerberos Vault, and connect Kerberos Vault to Kerberos Hub. About the latter more is explained on the Kerberos Vault page.

    Select the Kerberos Hub option, and copy-paste the credentials from your Kerberos Hub subscription.

    By linking your Enterprise agent to Kerberos Hub, your recordings and livestreams will become available online.

    By linking your Enterprise agent to Kerberos Hub, your recordings and livestreams will become available online.

    • Region: this is the region where your recordings will be stored. Only eu-west-1 for now (will change, on the roadmap).

    • Bucket: the name of the Kerberos Hub bucket. Only kerberosaccept for now (will change, on the roadmap).

    • Directory: this is your personal directory, and matches your Kerberos Hub username.

    • Public Key: this should match the public key of your Kerberos Hub subscription.

    • Secret Access Key: this should match the private key of your Kerberos Hub subscription.

    Edit this page on GitHub

    ← First things first
    Installation →
    \ No newline at end of file +

    Get Started

    What to expect from the Kerberos Enterprise agent.

    Once you’ve installed Kerberos Enterprise, you will have the Kerberos Enterprise Factory webapp running inside your cluster. This web application allows you to administrate your Kerberos Enterprise agents as deployments/pods. It comes a bunch of other features as well, read on.

    Important to note is that this web app is relying on the Golang Kubernetes SDK, so that means from an administration point of view, you could simply use the well known kubectl command. The webapp just add (a lot of) functionalities on top of the Kubernetes API, which are specific to Kerberos Enterprise agents.

    Login page

    Once you open a browser, and navigate to the Factory web application (see installation for the url), you will land on the login page.

    Login into the Kerberos Enterprise agent interface.

    Login into the Kerberos Enterprise agent interface.

    The default username password of the Factory web applications is:

    • username: root
    • password: kerberos

    The username and password can be changed in the deployment.yaml file.

    Overview

    On the overview page you will find an intuitive overview of the different pages and functionalities. On the left menu you will see two sections: Docker and Kubernetes. Kerberos Enterprise can both run in Docker (single-host) and Kubernetes (cluster) mode, however the recommended way is of course Kubernetes.

    When working with Kubernetes, Kerberos Enterprise agents are deployed as a deployment. When working with Docker, Kerberos Enterprise agents are deployed as traditional Docker containers.

    Review your Docker or Kubernetes agents.

    Review your Docker or Kubernetes agents.

    Kubernetes

    On the left menu you will find the Kubernetes section. In this section 3 sub menu’s are available:

    • Nodes: a list of all the nodes in your cluster.
    • Deployments: a list of all the Kerberos Enterprise agents running in your cluster.
    • Pods: all the pods running in your cluster.

    Nodes

    The nodes section lists all the available nodes inside your Kubernetes cluster. It shows a limited amount of information such as the version, the number of Docker images installed on the node, and some basic hardware information.

    Get an entire list of nodes which are connected to your Kubernetes cluster.

    Get an entire list of nodes which are connected to your Kubernetes cluster.

    Deployments

    The deployments section will list all the Kerberos Enterprise agents (running as deployments) that you have deployed inside your cluster. This page gives you access to deploy new Kerberos Enterprise agents one by one or in bulk. Next to that you can easily upgrade Kerberos Enterprise agents to a newer version, reboot them, view logging and update the configuration options of the Kerberos Enterprise agent.

    Get a list of all your Kerberos Enterprise agents.

    Get a list of all your Kerberos Enterprise agents.

    Adding a new deployment

    There are two options to add a new deployment, single deployments and bulk deployment.

    Get a list of all your Kerberos Enterprise agents.

    Get a list of all your Kerberos Enterprise agents.

    • single deployment

    By specifying a name for your deployment, and it’s corresponding RTSP url, a new deployment will be created for you, and deployed to one of your installed nodes.

    • in bulk deployment.

    By importing an Excel file, deployments can be created in bulk.

    By specifying the name and corresponding RTSP url in multiple rows, you can deploy your deployments in bulk.

    Add a Kerberos Enterprise agent through a deployment.

    Add a Kerberos Enterprise agent through a deployment.

    Configuring a deployment

    Once you have a running deployment, you should see a green circle next to the deployment, indicating that it is succesfully running. At any time you can configure your deployments by clicking on the icon. This will open a popup, allowing you to change some settings.

    Once you created the Kerberos Enterprise agent, you can configure the agent.

    Once you created the Kerberos Enterprise agent, you can configure the agent.

    Following settings can be changed:

    • One or more regions of interest,
    • Time based conditions,
    • Pre- and postrecording
    • Continious recording
    • Linking to Kerberos Hub or Kerberos Vault

    Global configuration

    Configuration can be specified on a Kerberos Enterprise agent level, this means that you update the configuration of a specific deployment. However can also be specified at a higher level. This higher level is what we call the global configuration.

    By specifying configurations at a higher level, any Kerberos Enterprise agents will inherit from that configuration, improving the overall maintenance and management of your Kerberos Enterprise agents.

    You can specify the configurations on a global level, so all agents will inherit from that.

    You can specify the configurations on a global level, so all agents will inherit from that.

    Upgrade or reboot a Kerberos Enterprise agent

    At Kerberos.io we have fast development cycles, which means that new versions will be released every day, week or month. To make sure you can upgrade or downgrade your Kerberos Enterprise agent easily, an upgrade feature is built-in. When pressing the upgrade button, you will be able to select the version to which you would like to upgrade or downgrade. Once submitted, a zero downtime upgrade will take place. Kubernetes will download the new release, create a new pod, and destroy the old one.

    At any moment you can reboot your Kerberos Enterprise agent. When pressing the reboot button, next to your deployment, Kubernetes will destroy the pod of your deployment, and schedule a new one. This comes in handy, when you noticed one of your Kerberos Enterprise agents is in a stale state.

    You can specify the configurations on a global level, so all agents will inherit from that.

    You can specify the configurations on a global level, so all agents will inherit from that.

    Pods

    When creating a Kerberos Enterprise agent, Kubernetes will create a deployment and schedule a pod. This pod will be managed by your deployment, and deployed as a Docker container to one of your available nodes. Once a pod dies/ crashes, or whatever unexpected scenario, the deployment will make sure it is deployed again to a different (or the same) node. This makes sure the Kerberos Enterprise agent is in a healthy state at all times.

    When creating a deployment, a Kubernetes pod has created and assigned to a node.

    When creating a deployment, a Kubernetes pod has created and assigned to a node.

    Storage and video management

    Kerberos Enterprise allows you to scale your video landscape horizontally, using the concept of Kubernetes, and brings a strong backbone for stability and performance. It allows you to avoid reinventing the wheel, and get stuck in the numerious challenges of making an intelligent VMS yourself (we worked on this for 2 years with experienced engineers).

    Kerberos Enterprise stores its recordings locally for a short amount of time. This means that long-term storage is not included in the solution. On top of that it also does not have a visual component, which allows you te review dashboards or recordings. To overcome these two challenges, long-term storage with extensibility/integration capabilities and visualisation features, following solutions were developed Kerberos Vault and Kerberos Hub.

    Kerberos Vault

    Kerberos Vault is a solution which makes it able to store recordings from Kerberos Enterprise agents (accross different clusters) at a central place, on the storage provider you want. You can store your recordings in the cloud (AWS S3, Google Cloud Storage, Azure Blob storage) or on premise (Minio).

    On the other hand it’s an open platform, as it allows you build extensions and integrations (web apps, mobile apps, machine learning services much more). Kerberos Vault ships with the ability of real-time messaging (Kafka) and a REST API (documented as Swaggger).

    Kerberos Vault allows you to centralise your recordings and build integrations.

    Kerberos Vault allows you to centralise your recordings and build integrations.

    To connect one or more Kerberos Enterprise agents to your Kerberos Vault instance, you should open the configuration option and navigate to the cloud tab. When selected you need to fill-in the credentials from your Kerberos Vault account.

    • Storage URI: this is the API endpoint of your Kerberos Vault instance. Usually this is in the following format: http(s)://api.yourdomain.com/storage. Where api.yourdomain.com should match your Kerberos Vault API endpoint.

    • Provider: the name of the provider, which you created on the Kerberos Vault providers page, to which you want to send your recordings to.

    • Directory: this is the subdirectory in which your files will be stored. At the time of writing this should also equal your Kerberos Hub username, if you plan to upload to Kerberos Hub.

    • Access Key: this should match the access key of one of your Kerberos Vault accounts.

    • Secret Access Key: this should match the secret access key of one of your Kerberos Vault accounts.

    Using Kerberos Vault you can bring your own storage, and store the recordings of your agents in your own storage provider.

    Using Kerberos Vault you can bring your own storage, and store the recordings of your agents in your own storage provider.

    Kerberos Hub

    For the visualisation part Kerberos Hub comes into the picture. Kerberos Hub is a web app, backed up with a number of microservices, that shows dashboards, live streams, filter recordings and much more. Learn more about the features and functions here.

    You have two choices when using Kerberos Hub, either you send your recordings from your Kerberos Enterprise agents directly to Kerberos Hub, or you send your recordings to Kerberos Vault, and connect Kerberos Vault to Kerberos Hub. About the latter more is explained on the Kerberos Vault page.

    Select the Kerberos Hub option, and copy-paste the credentials from your Kerberos Hub subscription.

    By linking your Enterprise agent to Kerberos Hub, your recordings and livestreams will become available online.

    By linking your Enterprise agent to Kerberos Hub, your recordings and livestreams will become available online.

    • Region: this is the region where your recordings will be stored. Only eu-west-1 for now (will change, on the roadmap).

    • Bucket: the name of the Kerberos Hub bucket. Only kerberosaccept for now (will change, on the roadmap).

    • Directory: this is your personal directory, and matches your Kerberos Hub username.

    • Public Key: this should match the public key of your Kerberos Hub subscription.

    • Secret Access Key: this should match the private key of your Kerberos Hub subscription.

    Edit this page on GitHub

    ← First things first
    Installation →
    \ No newline at end of file diff --git a/enterprise/index.html b/enterprise/index.html index 7dc1607..ba5e8e5 100644 --- a/enterprise/index.html +++ b/enterprise/index.html @@ -1,6 +1,6 @@ -Enterprise - Kerberos Docs
    - +Enterprise - Kerberos Docs
    + Kerberos Docs
    \ No newline at end of file +
    \ No newline at end of file diff --git a/enterprise/index.xml b/enterprise/index.xml index d85994a..b179d57 100644 --- a/enterprise/index.xml +++ b/enterprise/index.xml @@ -1,8 +1,8 @@ -Enterprise onhttps://staging.doc.kerberos.live/enterprise/Recent content in Enterprise onHugo -- gohugo.ioen-USTue, 06 Oct 2020 08:49:15 +0000First things firsthttps://staging.doc.kerberos.live/enterprise/first-things-first/Tue, 06 Oct 2020 08:49:31 +0000https://staging.doc.kerberos.live/enterprise/first-things-first/Over the years Kerberos evolved into a mature and stable solution. Lots of people and companies started to adopt the system, and requested enhancements. Despite the fact that Kerberos Open Source is stable and feature rich, every solution has its limitations, especially if you aim to scale it. -That being said, Kerberos Open Source is perfect when monitoring a limited set of surveillance cameras, but it doesn’t scale well if you plan to monitor dozens or hundreds of surveillance cameras.Get Startedhttps://staging.doc.kerberos.live/enterprise/get-started/Tue, 06 Oct 2020 08:49:31 +0000https://staging.doc.kerberos.live/enterprise/get-started/Once you’ve installed Kerberos Enterprise, you will have the Kerberos Enterprise Factory webapp running inside your cluster. This web application allows you to administrate your Kerberos Enterprise agents as deployments/pods. It comes a bunch of other features as well, read on. -Important to note is that this web app is relying on the Golang Kubernetes SDK, so that means from an administration point of view, you could simply use the well known kubectl command.Installationhttps://staging.doc.kerberos.live/enterprise/installation/Tue, 06 Oct 2020 08:49:31 +0000https://staging.doc.kerberos.live/enterprise/installation/Kerberos Enterprise can be installed where Kubernetes can be installed. This means that it can run at the Edge - Baremetal -, in the cloud - VMs - or at Kubernetes service providers - SAAS - such as GCP, Azure, AWS, DigitalOcean, and the list goes on. -Although you might except Kubernetes at the Edge or Kubernetes in the cloud, there are no differences, well sorry to say there are. As Kubernetes service providers implemented features such as LoadBalancers, Persistent Volumes, and others, they have automated and integrated a huge portion of the Kubernetes stack with their related PAAS services.Cloud Installationhttps://staging.doc.kerberos.live/enterprise/installation-cloud/Tue, 06 Oct 2020 08:49:31 +0000https://staging.doc.kerberos.live/enterprise/installation-cloud/Start by installing a Kubernetes cluster. This can be done on one of the hyperscalers (AWS, GCP or Azure), cloud providers (Digital Ocean, Scaleway, etc) or on-premise in your own private network. -Installation Before setting up Kerberos Enterprise, some configuration needs to happen. First thing that we need to do is setting up the RBAC permissions (Role Based Access Control). We need to enable this to be able to query specific endpoints from the Kubernetes API.Edge Installationhttps://staging.doc.kerberos.live/enterprise/installation-edge/Tue, 06 Oct 2020 08:49:31 +0000https://staging.doc.kerberos.live/enterprise/installation-edge/Welcome to the Kerberos Enterprise Edge installation. This is the way to go if you want to install Kerberos Enterprise on your Baremetal infrastructure or inside your Private Cloud. +Enterprise onhttps://doc.kerberos.io/enterprise/Recent content in Enterprise onHugo -- gohugo.ioen-USTue, 06 Oct 2020 08:49:15 +0000First things firsthttps://doc.kerberos.io/enterprise/first-things-first/Tue, 06 Oct 2020 08:49:31 +0000https://doc.kerberos.io/enterprise/first-things-first/Over the years Kerberos evolved into a mature and stable solution. Lots of people and companies started to adopt the system, and requested enhancements. Despite the fact that Kerberos Open Source is stable and feature rich, every solution has its limitations, especially if you aim to scale it. +That being said, Kerberos Open Source is perfect when monitoring a limited set of surveillance cameras, but it doesn’t scale well if you plan to monitor dozens or hundreds of surveillance cameras.Get Startedhttps://doc.kerberos.io/enterprise/get-started/Tue, 06 Oct 2020 08:49:31 +0000https://doc.kerberos.io/enterprise/get-started/Once you’ve installed Kerberos Enterprise, you will have the Kerberos Enterprise Factory webapp running inside your cluster. This web application allows you to administrate your Kerberos Enterprise agents as deployments/pods. It comes a bunch of other features as well, read on. +Important to note is that this web app is relying on the Golang Kubernetes SDK, so that means from an administration point of view, you could simply use the well known kubectl command.Installationhttps://doc.kerberos.io/enterprise/installation/Tue, 06 Oct 2020 08:49:31 +0000https://doc.kerberos.io/enterprise/installation/Kerberos Enterprise can be installed where Kubernetes can be installed. This means that it can run at the Edge - Baremetal -, in the cloud - VMs - or at Kubernetes service providers - SAAS - such as GCP, Azure, AWS, DigitalOcean, and the list goes on. +Although you might except Kubernetes at the Edge or Kubernetes in the cloud, there are no differences, well sorry to say there are. As Kubernetes service providers implemented features such as LoadBalancers, Persistent Volumes, and others, they have automated and integrated a huge portion of the Kubernetes stack with their related PAAS services.Cloud Installationhttps://doc.kerberos.io/enterprise/installation-cloud/Tue, 06 Oct 2020 08:49:31 +0000https://doc.kerberos.io/enterprise/installation-cloud/Start by installing a Kubernetes cluster. This can be done on one of the hyperscalers (AWS, GCP or Azure), cloud providers (Digital Ocean, Scaleway, etc) or on-premise in your own private network. +Installation Before setting up Kerberos Enterprise, some configuration needs to happen. First thing that we need to do is setting up the RBAC permissions (Role Based Access Control). We need to enable this to be able to query specific endpoints from the Kubernetes API.Edge Installationhttps://doc.kerberos.io/enterprise/installation-edge/Tue, 06 Oct 2020 08:49:31 +0000https://doc.kerberos.io/enterprise/installation-edge/Welcome to the Kerberos Enterprise Edge installation. This is the way to go if you want to install Kerberos Enterprise on your Baremetal infrastructure or inside your Private Cloud. When you start having bigger deployments it’s recommended to go with a Kubernetes approach. Before we can actual start installing the different deployments in our cluster, we need to make sure we have one available. -Prerequisites Docker If you have a fresh Linux installation, make sure you have Docker installed.Releaseshttps://staging.doc.kerberos.live/enterprise/releases/Tue, 06 Oct 2020 08:49:31 +0000https://staging.doc.kerberos.live/enterprise/releases/1.0.0 Factory React application using the Kubernetes and Docker Golang SDK. Possibility to add deployments one by one or in bulk (Excel). Configure machinery deployments: select a region of interest, specify recording time (pre, andd post recording), specify time interval. Global configuration page, where you specify your cloud credentials at a single place. \ No newline at end of file +Prerequisites Docker If you have a fresh Linux installation, make sure you have Docker installed.Releaseshttps://doc.kerberos.io/enterprise/releases/Tue, 06 Oct 2020 08:49:31 +0000https://doc.kerberos.io/enterprise/releases/1.0.0 Factory React application using the Kubernetes and Docker Golang SDK. Possibility to add deployments one by one or in bulk (Excel). Configure machinery deployments: select a region of interest, specify recording time (pre, andd post recording), specify time interval. Global configuration page, where you specify your cloud credentials at a single place. \ No newline at end of file diff --git a/enterprise/installation-cloud/index.html b/enterprise/installation-cloud/index.html index 6a81e1a..e949649 100644 --- a/enterprise/installation-cloud/index.html +++ b/enterprise/installation-cloud/index.html @@ -1,10 +1,10 @@ -Cloud Installation - Kerberos DocsCloud Installation - Kerberos Docs
    - + Installation Before setting up Kerberos Enterprise, some configuration needs to happen. First thing that we need to do is setting up the RBAC permissions (Role Based Access Control). We need to enable this to be able to query specific endpoints from the Kubernetes API.">
    + Kerberos Docs

    Cloud Installation

    Start by installing a Kubernetes cluster. This can be done on one of the hyperscalers (AWS, GCP or Azure), +

    Cloud Installation

    Start by installing a Kubernetes cluster. This can be done on one of the hyperscalers (AWS, GCP or Azure), cloud providers (Digital Ocean, Scaleway, etc) or on-premise in your own private network.

    Installation

    Before setting up Kerberos Enterprise, some configuration needs to happen. First thing that we need to do is setting up the RBAC permissions (Role Based Access Control). We need to enable this to be able to query specific endpoints from the Kubernetes API. By default these endpoints are locked, so we need to unlock them.

    First clone the configrations from our Github repo.

    git clone https://github.com/kerberos-io/enterprise

    A best practice is to create a separate namespace for your enterprise deployment.

    kubectl create namespace kerberos

    Next go into the directory and execute the first Kubernetes configuration file clusterrole.yaml.

    kubectl create -n kerberos -f ./enterprise/yaml/factory/clusterrole.yaml
@@ -71,5 +71,5 @@ NAME                              READY   STATUS    RESTARTS   AGE
 factory-6f5c877d7c-hf77p          1/1     Running   0          2d11h
 mongodb-758d5c5ddd-qsfq9          1/1     Running   0          5m31s
 traefik-7d566ccc47-mwslb          1/1     Running   0          4d12h
-

    Access the system

    Once everything is configured correctly your cluster and DNS, you should be able to setup the Factory application. By navigating to the Factory domain factory.domain.com in your browser you will see the Factory login page showing up.

    Once successfully installed Kerberos Enterprise, it will show you the login page.

    Once successfully installed Kerberos Enterprise, it will show you the login page.

    Edit this page on GitHub

    ← Installation
    Edge Installation →
    \ No newline at end of file +

    Access the system

    Once everything is configured correctly your cluster and DNS, you should be able to setup the Factory application. By navigating to the Factory domain factory.domain.com in your browser you will see the Factory login page showing up.

    Once successfully installed Kerberos Enterprise, it will show you the login page.

    Once successfully installed Kerberos Enterprise, it will show you the login page.

    Edit this page on GitHub

    ← Installation
    Edge Installation →
    \ No newline at end of file diff --git a/enterprise/installation-edge/index.html b/enterprise/installation-edge/index.html index 4943b94..5c45eab 100644 --- a/enterprise/installation-edge/index.html +++ b/enterprise/installation-edge/index.html @@ -1,14 +1,14 @@ -Edge Installation - Kerberos DocsEdge Installation - Kerberos Docs
    - +Prerequisites Docker If you have a fresh Linux installation, make sure you have Docker installed.">
    + Kerberos Docs

    Edge Installation

    Welcome to the Kerberos Enterprise Edge installation. This is the way to go if you want to install Kerberos Enterprise on your Baremetal infrastructure or inside your Private Cloud.

    When you start having bigger deployments it's recommended to go with a Kubernetes approach.

    When you start having bigger deployments it’s recommended to go with a Kubernetes approach.

    Before we can actual start installing the different deployments in our cluster, we need to make sure we have one available.

    Prerequisites

    Docker

    If you have a fresh Linux installation, make sure you have Docker installed. If not the case, this is how you can install it on a Ubuntu OSS.

    apt install docker.io -y
+

    Edge Installation

    Welcome to the Kerberos Enterprise Edge installation. This is the way to go if you want to install Kerberos Enterprise on your Baremetal infrastructure or inside your Private Cloud.

    When you start having bigger deployments it's recommended to go with a Kubernetes approach.

    When you start having bigger deployments it’s recommended to go with a Kubernetes approach.

    Before we can actual start installing the different deployments in our cluster, we need to make sure we have one available.

    Prerequisites

    Docker

    If you have a fresh Linux installation, make sure you have Docker installed. If not the case, this is how you can install it on a Ubuntu OSS.

    apt install docker.io -y

    Kubernetes

    After Docker being installed go ahead and install the different Kubernetes servicess and tools.

    apt update -y
 apt install apt-transport-https curl -y
 curl -s https://packages.cloud.google.com/apt/doc/apt-key.gpg | apt-key add
@@ -115,5 +115,5 @@ NAME                              READY   STATUS    RESTARTS   AGE
 factory-6f5c877d7c-hf77p          1/1     Running   0          2d11h
 mongodb-758d5c5ddd-qsfq9          1/1     Running   0          5m31s
 traefik-7d566ccc47-mwslb          1/1     Running   0          4d12h
-

    Access the system

    Once everything is configured correctly your cluster and DNS, you should be able to setup the Factory application. By navigating to the Factory domain factory.domain.com in your browser you will see the Factory login page showing up.

    Once successfully installed Kerberos Enterprise, it will show you the login page.

    Once successfully installed Kerberos Enterprise, it will show you the login page.

    Edit this page on GitHub

    ← Cloud Installation
    Releases →
    \ No newline at end of file +

    Access the system

    Once everything is configured correctly your cluster and DNS, you should be able to setup the Factory application. By navigating to the Factory domain factory.domain.com in your browser you will see the Factory login page showing up.

    Once successfully installed Kerberos Enterprise, it will show you the login page.

    Once successfully installed Kerberos Enterprise, it will show you the login page.

    Edit this page on GitHub

    ← Cloud Installation
    Releases →
    \ No newline at end of file diff --git a/enterprise/installation/index.html b/enterprise/installation/index.html index 14e2a25..c29ada1 100644 --- a/enterprise/installation/index.html +++ b/enterprise/installation/index.html @@ -1,8 +1,8 @@ -Installation - Kerberos DocsInstallation - Kerberos Docs
    - +Although you might except Kubernetes at the Edge or Kubernetes in the cloud, there are no differences, well sorry to say there are. As Kubernetes service providers implemented features such as LoadBalancers, Persistent Volumes, and others, they have automated and integrated a huge portion of the Kubernetes stack with their related PAAS services.">
    + Kerberos Docs

    Installation

    Kerberos Enterprise can be installed where Kubernetes can be installed. This means that it can run at the Edge - Baremetal -, in the cloud - VMs - or at Kubernetes service providers - SAAS - such as GCP, Azure, AWS, DigitalOcean, and the list goes on.

    Although you might except Kubernetes at the Edge or Kubernetes in the cloud, there are no differences, well sorry to say there are. As Kubernetes service providers implemented features such as LoadBalancers, Persistent Volumes, and others, they have automated and integrated a huge portion of the Kubernetes stack with their related PAAS services. To be more concrete if you are running a Kubernetes Cluster on GCP, you will use the LoadBalancing and Storage services from GCP.

    Kerberos Enterprise can be installed everywhere your Kubernetes cluster can be installed.

    Kerberos Enterprise can be installed everywhere your Kubernetes cluster can be installed.

    Compared to Kubernetes at the Edge, there are no predefined LoadBalancers, Storage capabilities, and more. This means more administration work for you, but - with great power comes great responsibility - so no worries. In the end there are alternative functionalties available, for features which you find out-of-the-box at the Kubernetes service providers, you just have to spend more time on configuring and installing those services/pods/deployments yourself.

    Installation on a Kubernetes Service Provider

    Installing Kerberos Enterprise on a Kubernetes Service Provider (Azure, GCP, AWS) is straight forward, as you can create a Kubernetes cluster in a few clicks, get access to public Load Balancers, storage and more. Running Kerberos Enterprise in such a cluster is just a matter of copy-pasting some configuration (yaml) files, and executing some kubectl apply commands.

    As previous mentioned you could process them in a Kubernetes cluster in the cloud.

    As previous mentioned you could process them in a Kubernetes cluster in the cloud.

    Install Kerberos Enterprise on a Kubernetes Service Provider by following this step-by-step installation guide.

    Installation in Private Cloud or Baremetal

    No need to install Kerberos Enterprise on a Kubernetes Service Provider, you could install it on your own Kubernetes cluster in your private cloud, or even better inside your own premise. The closer you bring Kerberos Enterprise to your surveillance infrastructure, the more benefits you will experience (low latency, low bandwidth, etc).

    When you start having bigger deployments it's recommended to go with a Kubernetes approach.

    When you start having bigger deployments it’s recommended to go with a Kubernetes approach.

    In contradiction to the Kubernetes Service Provider, you will have some work todo. Setting up Kubernetes Cluster, play with MetalLB, Persistent Volumes and claims. Don’t be scared, it’s pretty ssttraight forward as well. You can’t simple expect a: click, click, 💥 approach.

    Install Kerberos Enterprise on a Private cloud or Baremetal by following this step-by-step installation guide.

    Edit this page on GitHub

    ← Get Started
    Cloud Installation →
    \ No newline at end of file +

    Installation

    Kerberos Enterprise can be installed where Kubernetes can be installed. This means that it can run at the Edge - Baremetal -, in the cloud - VMs - or at Kubernetes service providers - SAAS - such as GCP, Azure, AWS, DigitalOcean, and the list goes on.

    Although you might except Kubernetes at the Edge or Kubernetes in the cloud, there are no differences, well sorry to say there are. As Kubernetes service providers implemented features such as LoadBalancers, Persistent Volumes, and others, they have automated and integrated a huge portion of the Kubernetes stack with their related PAAS services. To be more concrete if you are running a Kubernetes Cluster on GCP, you will use the LoadBalancing and Storage services from GCP.

    Kerberos Enterprise can be installed everywhere your Kubernetes cluster can be installed.

    Kerberos Enterprise can be installed everywhere your Kubernetes cluster can be installed.

    Compared to Kubernetes at the Edge, there are no predefined LoadBalancers, Storage capabilities, and more. This means more administration work for you, but - with great power comes great responsibility - so no worries. In the end there are alternative functionalties available, for features which you find out-of-the-box at the Kubernetes service providers, you just have to spend more time on configuring and installing those services/pods/deployments yourself.

    Installation on a Kubernetes Service Provider

    Installing Kerberos Enterprise on a Kubernetes Service Provider (Azure, GCP, AWS) is straight forward, as you can create a Kubernetes cluster in a few clicks, get access to public Load Balancers, storage and more. Running Kerberos Enterprise in such a cluster is just a matter of copy-pasting some configuration (yaml) files, and executing some kubectl apply commands.

    As previous mentioned you could process them in a Kubernetes cluster in the cloud.

    As previous mentioned you could process them in a Kubernetes cluster in the cloud.

    Install Kerberos Enterprise on a Kubernetes Service Provider by following this step-by-step installation guide.

    Installation in Private Cloud or Baremetal

    No need to install Kerberos Enterprise on a Kubernetes Service Provider, you could install it on your own Kubernetes cluster in your private cloud, or even better inside your own premise. The closer you bring Kerberos Enterprise to your surveillance infrastructure, the more benefits you will experience (low latency, low bandwidth, etc).

    When you start having bigger deployments it's recommended to go with a Kubernetes approach.

    When you start having bigger deployments it’s recommended to go with a Kubernetes approach.

    In contradiction to the Kubernetes Service Provider, you will have some work todo. Setting up Kubernetes Cluster, play with MetalLB, Persistent Volumes and claims. Don’t be scared, it’s pretty ssttraight forward as well. You can’t simple expect a: click, click, 💥 approach.

    Install Kerberos Enterprise on a Private cloud or Baremetal by following this step-by-step installation guide.

    Edit this page on GitHub

    ← Get Started
    Cloud Installation →
    \ No newline at end of file diff --git a/enterprise/releases/index.html b/enterprise/releases/index.html index 276e78f..e411a8e 100644 --- a/enterprise/releases/index.html +++ b/enterprise/releases/index.html @@ -1,6 +1,6 @@ -Releases - Kerberos Docs
    - +Releases - Kerberos Docs
    + Kerberos Docs

    Releases

    1.0.0

    Factory

    • React application using the Kubernetes and Docker Golang SDK.
    • Possibility to add deployments one by one or in bulk (Excel).
    • Configure machinery deployments: select a region of interest, specify recording time (pre, andd post recording), specify time interval.
    • Global configuration page, where you specify your cloud credentials at a single place.

    Edit this page on GitHub

    ← Edge Installation
    \ No newline at end of file +

    Releases

    1.0.0

    Factory

    • React application using the Kubernetes and Docker Golang SDK.
    • Possibility to add deployments one by one or in bulk (Excel).
    • Configure machinery deployments: select a region of interest, specify recording time (pre, andd post recording), specify time interval.
    • Global configuration page, where you specify your cloud credentials at a single place.

    Edit this page on GitHub

    ← Edge Installation
    \ No newline at end of file diff --git a/help/index.html b/help/index.html index 14c8a89..eb190be 100644 --- a/help/index.html +++ b/help/index.html @@ -1,6 +1,6 @@ -Help - Kerberos Docs
    - +Help - Kerberos Docs
    + Kerberos Docs

    Help

    \ No newline at end of file +Kerberos.io
    • \ No newline at end of file diff --git a/help/index.xml b/help/index.xml index 3767933..876b1de 100644 --- a/help/index.xml +++ b/help/index.xml @@ -1 +1 @@ -Help onhttps://staging.doc.kerberos.live/help/Recent content in Help onHugo -- gohugo.ioen-USTue, 06 Oct 2020 08:49:15 +0000 \ No newline at end of file +Help onhttps://doc.kerberos.io/help/Recent content in Help onHugo -- gohugo.ioen-USTue, 06 Oct 2020 08:49:15 +0000 \ No newline at end of file diff --git a/hub/first-things-first/index.html b/hub/first-things-first/index.html index fb1fb4d..fa56254 100644 --- a/hub/first-things-first/index.html +++ b/hub/first-things-first/index.html @@ -1,7 +1,7 @@ -First things first - Kerberos Docs
    - +First things first - Kerberos Docs
    + Kerberos Docs

    First things first

    A scalable interface to manage all your agents and sites through a single pane of glass.

    When installing a Kerberos agent inside your local network, it’s possible to review your activity by using the agent’s web interface. By nature, you will not be able to access the web interface from the cloud (outside your local network). On top of that, the Kerberos agent doesn’t come with a consolidated overview. This means that you will need to open multiple web interfaces, one for each connected surveillance camera.

    To simplify and resolve all of these challenges, Kerberos Hub was developed.

    Kerberos Hub is a cloud solution which allows you to have a single overview of all the media recordings generated by your surveillance cameras. It’s not a solution for processing your surveillance cameras in the cloud. For processing of your surveillance cameras, a Kerberos agent is used.

    A brief list of the key features of Kerberos Hub are:

    • Secured storage
    • Consolidated overview
    • Advanced searching
    • Machine learning
    • Alerts
    • Live streaming
    • Accounts
    • Logging

    Checkout the demo environment to see and feel the Kerberos Hub solution yourself.

    Architecture

    A simplified architecture is found below. In this architecture the Kerberos agents are installed on-premise, next to the surveillance cameras. Once one of the agents recorded something it will send the recording to our Kerberos Vault, using the credentials you’ve defined inside the agent.

    As soon as the recording is succesfully received several engines will be executed, that will further process the recording and extract metadata from it (classification, origin of the surveillance camera, etc). A lot of processing is happening behind the scenes (by what we call microservices).

    By using a browser you can navigate to Kerberos Hub, and review all the recordings made by the Kerberos agents. On top of that you will receive more context about the recordings, get notifications, view a livestream and much more.

    Kerberos Hub is composed out of of different microservices.

    Kerberos Hub is composed out of of different microservices.

    Public or Private edition

    They are two different versions of using and deploying Kerberos Hub, we have the public and private dition. What’s the difference?

    The Public edition of Kerberos Hub, is running all its services in what we often call the public cloud; and to be more specific on AWS and GCP. The Public cloud is mainly built for people who want to have a low cost and small scale VMS in the cloud. It’s easy to (un)subscribe to the system, and you can connect your Kerberos agents in a matter of seconds.

    On the other hand we also have the private edition, which is available for enterprises. In contrary to the public edition, a customer can deploy the entire Kerberos Hub platform (with all its microservices) where it wants (on-premise or cloud). Both public and private edition are built on Kubernetes, this means that you will need to -have a Kubernetes cluster available at the location you which to install Kerberos Hub.

    For more information about the licensing of Kerberos Hub private edition, please get in touch with cedric@verstraeten.io. The licensing model of Kerberos Hub public edition can be found online.

    Features

    So you might wonder, what’s actually inside the platform? Please find a concrete list of functionalities below, this should give you more insights about how it looks like and what the capabilities are.

    Secured storage

    Kerberos Hub allows you to store your data in the cloud, and make it available using a secured web interface. This is how it works.

    Once you’ve installed a Kerberos agent, and created an account on Kerberos Hub, you will be able to connect both systems together. By entering credentials received from Kerberos Hub, into your Kerberos agent, your media recordings will be send to our cloud storage.

    You can link one or more Kerberos agents to your Kerberos Hub account.

    After linking your media recorded by a Kerberos agent will be send to our secure cloud storage, Kerberos Vault. By default our own Kerberos Vault service is used, however you can install your own Kerberos Vault and link it to our public cloud. By doing this all the recordings are stored in your own datacenter of choice, and only metadata is stored inside Kerberos Hub.

    You connect your agents to Kerberos Hub, through Kerberos Vault.

    You connect your agents to Kerberos Hub, through Kerberos Vault.

    Once stored your media recordings will be processed by different functions and algorithms to send alerts, apply machine learning and much more.

    Kerberos Hub is much more than a storage service, you get intelligent capabilities as well. Read on to discover more.

    Consolidated overview

    Kerberos Hub will group your media recordings (coming from one or more Kerberos agents) into time bundles. We do this to simplify the searching of a specific event. Less data is shown at once, and when needed you can drill down a level deeper to see more details.

    The media page gives you an overview of all your recordings.

    The media page gives you an overview of all your recordings.

    In a sneak peek you will see how many media recordings were generated during a certain time period, and which Kerberos agents were involved. For example, this might give you an indication of a particular event (more about in the machine learning section).

    Security

    Once you’re inside your Kerberos Hub account, you will see all the available media recordings of your Kerberos agents in a single interface. So how does this work?

    When you open Kerberos Hub we will generate temporary and private links for every media recording within your account. This link includes a random and unique hash, and is only available for a couple of minutes. So this means that your recording cannot be shared afterwards, or the risk someone else accessing that link is minimised.

    Advanced searching

    Next to showing all your recordings in one overview, we also give you the capabilities to search for a recording more easily. For example you can search for recordings within a specific time boundary, recordings generated by a specific Kerberos agent, recordings which are marked as important, classified recordings such as pedestrians or animals, and more.

    Detailed searching across different sites and cameras. Using smart search to look for specific objects.

    Detailed searching across different sites and cameras. Using smart search to look for specific objects.

    Machine learning

    With Kerberos Hub you will get far more than just a nice interface for finding back your recordings. When a recording is uploaded to Kerberos Hub, we will execute all kind of algorithms. One of these algorithms is classification. This algorithm is used to classify/recognise all the objects inside your recording. Any human, vehicle or animal in the recording will be labeled.

    Next to classifying, the algorithm is also tracing the classified objects. By doing this we can label the recording with the object of interest. For example at the image below you see the traject of a pedestrian walking by (710 pixels).

    When running your recordings on our Kerberos Hub, it will be processed by our ML service.

    When running your recordings on our Kerberos Hub, it will be processed by our ML service.

    You can filter and drill down into specific media where a classification was detected.

    You can filter and drill down into specific media where a classification was detected.

    Alerts

    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.

    Alerts

    Kerberos Hub supports different types of alerts:

    • Detections: send a notification if a recording was received from a specific Kerberos agent, within a time range, with a specific classification, etc.
    • Devices: when one of your Kerberos agents stopped working, a notification can be send.
    • High upload: when a lot of recordings are generated within a specific period of time, a notification can be send.
    Configure specific scenarios to trigger alerts.

    Configure specific scenarios to trigger alerts.

    Channels

    Kerberos Hub supports different types of channels, towards notifications can be send:

    • Browser: notifications inside the browser (if the used browser supports this).
    • E-mail: a personal email can be send.
    • Slack: send a message to a slack channel.
    • Alexa: send a notification to Alexa skill (Notify Me).
    • Telegram: send a message to a Telegram channel.
    • Pushbullet: send a message to a Pushbullet channel.
    • Pushover: send a message to a Pushover channel.
    • Webhook: trigger a webhook (POST).
    • IFTTT: send a message to IFTTT.
    • SMS: send a text message to a mobile number.
    Channels allow you to communicate to external services.

    Channels allow you to communicate to external services.

    Livestreaming

    Kerberos Hub allows you to live stream from your Kerberos agents to your Kerberos Hub account.

    For Kerberos Open Source a low resolution livestream is made available, this will allow you to see what is happening in front of your surveillance camera in real-time. The stream is shared over MQTT (TCPS) and visualised in the Kerberos Hub webinterface using secure websockets (WSS). No port forwarding needs to be enabled.

    A Kerberos agent will give you access to the livestream, and a HD stream when using the enterprise agent.

    A Kerberos agent will give you access to the livestream, and a HD stream when using the enterprise agent.

    For Kerberos Enterprise a HD livestream is made available. The full resolution and FPS is send through a concept called WebRTC. This WebRTC technology, is used my all major conferencing tools such as Zoom, Teams, etc.

    Accounts

    It’s possible to create multiple accounts (also called subaccounts) within your main account. Their are two different roles:

    • 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.
    Using accounts you can give external people access.

    Using accounts you can give external people access.

    Edit this page on GitHub

    \ No newline at end of file +

    First things first

    A scalable interface to manage all your agents and sites through a single pane of glass.

    When installing a Kerberos agent inside your local network, it’s possible to review your activity by using the agent’s web interface. By nature, you will not be able to access the web interface from the cloud (outside your local network). On top of that, the Kerberos agent doesn’t come with a consolidated overview. This means that you will need to open multiple web interfaces, one for each connected surveillance camera.

    To simplify and resolve all of these challenges, Kerberos Hub was developed.

    Kerberos Hub is a cloud solution which allows you to have a single overview of all the media recordings generated by your surveillance cameras. It’s not a solution for processing your surveillance cameras in the cloud. For processing of your surveillance cameras, a Kerberos agent is used.

    A brief list of the key features of Kerberos Hub are:

    • Secured storage
    • Consolidated overview
    • Advanced searching
    • Machine learning
    • Alerts
    • Live streaming
    • Accounts
    • Logging

    Checkout the demo environment to see and feel the Kerberos Hub solution yourself.

    Architecture

    A simplified architecture is found below. In this architecture the Kerberos agents are installed on-premise, next to the surveillance cameras. Once one of the agents recorded something it will send the recording to our Kerberos Vault, using the credentials you’ve defined inside the agent.

    As soon as the recording is succesfully received several engines will be executed, that will further process the recording and extract metadata from it (classification, origin of the surveillance camera, etc). A lot of processing is happening behind the scenes (by what we call microservices).

    By using a browser you can navigate to Kerberos Hub, and review all the recordings made by the Kerberos agents. On top of that you will receive more context about the recordings, get notifications, view a livestream and much more.

    Kerberos Hub is composed out of of different microservices.

    Kerberos Hub is composed out of of different microservices.

    Public or Private edition

    They are two different versions of using and deploying Kerberos Hub, we have the public and private dition. What’s the difference?

    The Public edition of Kerberos Hub, is running all its services in what we often call the public cloud; and to be more specific on AWS and GCP. The Public cloud is mainly built for people who want to have a low cost and small scale VMS in the cloud. It’s easy to (un)subscribe to the system, and you can connect your Kerberos agents in a matter of seconds.

    On the other hand we also have the private edition, which is available for enterprises. In contrary to the public edition, a customer can deploy the entire Kerberos Hub platform (with all its microservices) where it wants (on-premise or cloud). Both public and private edition are built on Kubernetes, this means that you will need to +have a Kubernetes cluster available at the location you which to install Kerberos Hub.

    For more information about the licensing of Kerberos Hub private edition, please get in touch with cedric@verstraeten.io. The licensing model of Kerberos Hub public edition can be found online.

    Features

    So you might wonder, what’s actually inside the platform? Please find a concrete list of functionalities below, this should give you more insights about how it looks like and what the capabilities are.

    Secured storage

    Kerberos Hub allows you to store your data in the cloud, and make it available using a secured web interface. This is how it works.

    Once you’ve installed a Kerberos agent, and created an account on Kerberos Hub, you will be able to connect both systems together. By entering credentials received from Kerberos Hub, into your Kerberos agent, your media recordings will be send to our cloud storage.

    You can link one or more Kerberos agents to your Kerberos Hub account.

    After linking your media recorded by a Kerberos agent will be send to our secure cloud storage, Kerberos Vault. By default our own Kerberos Vault service is used, however you can install your own Kerberos Vault and link it to our public cloud. By doing this all the recordings are stored in your own datacenter of choice, and only metadata is stored inside Kerberos Hub.

    You connect your agents to Kerberos Hub, through Kerberos Vault.

    You connect your agents to Kerberos Hub, through Kerberos Vault.

    Once stored your media recordings will be processed by different functions and algorithms to send alerts, apply machine learning and much more.

    Kerberos Hub is much more than a storage service, you get intelligent capabilities as well. Read on to discover more.

    Consolidated overview

    Kerberos Hub will group your media recordings (coming from one or more Kerberos agents) into time bundles. We do this to simplify the searching of a specific event. Less data is shown at once, and when needed you can drill down a level deeper to see more details.

    The media page gives you an overview of all your recordings.

    The media page gives you an overview of all your recordings.

    In a sneak peek you will see how many media recordings were generated during a certain time period, and which Kerberos agents were involved. For example, this might give you an indication of a particular event (more about in the machine learning section).

    Security

    Once you’re inside your Kerberos Hub account, you will see all the available media recordings of your Kerberos agents in a single interface. So how does this work?

    When you open Kerberos Hub we will generate temporary and private links for every media recording within your account. This link includes a random and unique hash, and is only available for a couple of minutes. So this means that your recording cannot be shared afterwards, or the risk someone else accessing that link is minimised.

    Advanced searching

    Next to showing all your recordings in one overview, we also give you the capabilities to search for a recording more easily. For example you can search for recordings within a specific time boundary, recordings generated by a specific Kerberos agent, recordings which are marked as important, classified recordings such as pedestrians or animals, and more.

    Detailed searching across different sites and cameras. Using smart search to look for specific objects.

    Detailed searching across different sites and cameras. Using smart search to look for specific objects.

    Machine learning

    With Kerberos Hub you will get far more than just a nice interface for finding back your recordings. When a recording is uploaded to Kerberos Hub, we will execute all kind of algorithms. One of these algorithms is classification. This algorithm is used to classify/recognise all the objects inside your recording. Any human, vehicle or animal in the recording will be labeled.

    Next to classifying, the algorithm is also tracing the classified objects. By doing this we can label the recording with the object of interest. For example at the image below you see the traject of a pedestrian walking by (710 pixels).

    When running your recordings on our Kerberos Hub, it will be processed by our ML service.

    When running your recordings on our Kerberos Hub, it will be processed by our ML service.

    You can filter and drill down into specific media where a classification was detected.

    You can filter and drill down into specific media where a classification was detected.

    Alerts

    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.

    Alerts

    Kerberos Hub supports different types of alerts:

    • Detections: send a notification if a recording was received from a specific Kerberos agent, within a time range, with a specific classification, etc.
    • Devices: when one of your Kerberos agents stopped working, a notification can be send.
    • High upload: when a lot of recordings are generated within a specific period of time, a notification can be send.
    Configure specific scenarios to trigger alerts.

    Configure specific scenarios to trigger alerts.

    Channels

    Kerberos Hub supports different types of channels, towards notifications can be send:

    • Browser: notifications inside the browser (if the used browser supports this).
    • E-mail: a personal email can be send.
    • Slack: send a message to a slack channel.
    • Alexa: send a notification to Alexa skill (Notify Me).
    • Telegram: send a message to a Telegram channel.
    • Pushbullet: send a message to a Pushbullet channel.
    • Pushover: send a message to a Pushover channel.
    • Webhook: trigger a webhook (POST).
    • IFTTT: send a message to IFTTT.
    • SMS: send a text message to a mobile number.
    Channels allow you to communicate to external services.

    Channels allow you to communicate to external services.

    Livestreaming

    Kerberos Hub allows you to live stream from your Kerberos agents to your Kerberos Hub account.

    For Kerberos Open Source a low resolution livestream is made available, this will allow you to see what is happening in front of your surveillance camera in real-time. The stream is shared over MQTT (TCPS) and visualised in the Kerberos Hub webinterface using secure websockets (WSS). No port forwarding needs to be enabled.

    A Kerberos agent will give you access to the livestream, and a HD stream when using the enterprise agent.

    A Kerberos agent will give you access to the livestream, and a HD stream when using the enterprise agent.

    For Kerberos Enterprise a HD livestream is made available. The full resolution and FPS is send through a concept called WebRTC. This WebRTC technology, is used my all major conferencing tools such as Zoom, Teams, etc.

    Accounts

    It’s possible to create multiple accounts (also called subaccounts) within your main account. Their are two different roles:

    • 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.
    Using accounts you can give external people access.

    Using accounts you can give external people access.

    Edit this page on GitHub

    \ No newline at end of file diff --git a/hub/index.html b/hub/index.html index cd03c13..9d3ada8 100644 --- a/hub/index.html +++ b/hub/index.html @@ -1,6 +1,6 @@ -Enterprise - Kerberos Docs
    - +Enterprise - Kerberos Docs
    + Kerberos Docs
    \ No newline at end of file +
    \ No newline at end of file diff --git a/hub/index.xml b/hub/index.xml index e243696..5a5b58f 100644 --- a/hub/index.xml +++ b/hub/index.xml @@ -1 +1 @@ -Enterprise onhttps://staging.doc.kerberos.live/hub/Recent content in Enterprise onHugo -- gohugo.ioen-USTue, 06 Oct 2020 08:49:15 +0000First things firsthttps://staging.doc.kerberos.live/hub/first-things-first/Tue, 06 Oct 2020 08:49:31 +0000https://staging.doc.kerberos.live/hub/first-things-first/When installing a Kerberos agent inside your local network, it’s possible to review your activity by using the agent’s web interface. By nature, you will not be able to access the web interface from the cloud (outside your local network). On top of that, the Kerberos agent doesn’t come with a consolidated overview. This means that you will need to open multiple web interfaces, one for each connected surveillance camera. \ No newline at end of file +Enterprise onhttps://doc.kerberos.io/hub/Recent content in Enterprise onHugo -- gohugo.ioen-USTue, 06 Oct 2020 08:49:15 +0000First things firsthttps://doc.kerberos.io/hub/first-things-first/Tue, 06 Oct 2020 08:49:31 +0000https://doc.kerberos.io/hub/first-things-first/When installing a Kerberos agent inside your local network, it’s possible to review your activity by using the agent’s web interface. By nature, you will not be able to access the web interface from the cloud (outside your local network). On top of that, the Kerberos agent doesn’t come with a consolidated overview. This means that you will need to open multiple web interfaces, one for each connected surveillance camera. \ No newline at end of file diff --git a/index.html b/index.html index 6c243be..fb971e7 100644 --- a/index.html +++ b/index.html @@ -1,6 +1,6 @@ -Kerberos Docs - Video surveillance for everyone
    - +Kerberos Docs - Video surveillance for everyone
    + Kerberos Docs

    Introduction

    And so it began. The ecosystem of Kerberos.io

    The Kerberos.io project, pronounced as /kuh buh ruhs dot ai o/, is a video surveillance solution, which was initiated back in 2014. Over the years it has evolved into a trusted, stable and feature-rich video surveillance system. To set the expectations, watch the video below to understand what it can and can’t do. If you want to install Kerberos.io, it’s recommended to have a look at the architectures page to find the best solution for your usecase.

    The name: Kerberos.io

    Many people are confused, and don’t understand why this project is called Kerberos.io. If you’ve been in the IT world for a while you will notice that Kerberos is already used for the authentication protocol Kerberos.

    We believe that the name Kerberos.io makes sense for this project as well, with a strong emphasize on the suffix .io, which stands for input and output devices (e.g. any type of camera). Kerberos.io can be seen as a kind of security protocol driven by hardware devices such as surveillance cameras. To make writing easier we will from now on, refer to Kerberos instead of Kerberos.io.

    Why Kerberos

    As burglary is very common, we believe that video surveillance is a trivial tool in our daily lifes which helps us to feel a bit more secure. Responding to this need, a lot of companies have started developing their own video surveillance software in the past few years.

    Nowadays we have a myriad of expensive cameras, recorders, and software solutions which are mainly outdated and difficult to install and use. Kerberos goal is to solve these problems and to provide every human being or enterprise in this world to have their own ecological, affordable, easy-to-use and innovative surveillance solution.

    What is Kerberos

    Kerberos is a video surveillance solution, that uses computer vision algorithms to detect changes, and that can trigger actions (notifications, api, etc). It comes in two flavors, Kerberos Open Source and Kerberos Enterprise. Kerberos can be deployed to any ARM device, Linux OS, Docker, Balenca Cloud, or cluster such as Kubernetes.

    Kerberos Agent

    When you install Kerberos Open Source or Kerberos Enterprise we will refer to it as the Kerberos agent. A Kerberos agent, is a software solution that processes the video stream of a single surveillance camera, makes and visualises recordings and takes actions (for example sending notifications).

    Edit this page on GitHub

    \ No newline at end of file +

    Introduction

    And so it began. The ecosystem of Kerberos.io

    The Kerberos.io project, pronounced as /kuh buh ruhs dot ai o/, is a video surveillance solution, which was initiated back in 2014. Over the years it has evolved into a trusted, stable and feature-rich video surveillance system. To set the expectations, watch the video below to understand what it can and can’t do. If you want to install Kerberos.io, it’s recommended to have a look at the architectures page to find the best solution for your usecase.

    The name: Kerberos.io

    Many people are confused, and don’t understand why this project is called Kerberos.io. If you’ve been in the IT world for a while you will notice that Kerberos is already used for the authentication protocol Kerberos.

    We believe that the name Kerberos.io makes sense for this project as well, with a strong emphasize on the suffix .io, which stands for input and output devices (e.g. any type of camera). Kerberos.io can be seen as a kind of security protocol driven by hardware devices such as surveillance cameras. To make writing easier we will from now on, refer to Kerberos instead of Kerberos.io.

    Why Kerberos

    As burglary is very common, we believe that video surveillance is a trivial tool in our daily lifes which helps us to feel a bit more secure. Responding to this need, a lot of companies have started developing their own video surveillance software in the past few years.

    Nowadays we have a myriad of expensive cameras, recorders, and software solutions which are mainly outdated and difficult to install and use. Kerberos goal is to solve these problems and to provide every human being or enterprise in this world to have their own ecological, affordable, easy-to-use and innovative surveillance solution.

    What is Kerberos

    Kerberos is a video surveillance solution, that uses computer vision algorithms to detect changes, and that can trigger actions (notifications, api, etc). It comes in two flavors, Kerberos Open Source and Kerberos Enterprise. Kerberos can be deployed to any ARM device, Linux OS, Docker, Balenca Cloud, or cluster such as Kubernetes.

    Kerberos Agent

    When you install Kerberos Open Source or Kerberos Enterprise we will refer to it as the Kerberos agent. A Kerberos agent, is a software solution that processes the video stream of a single surveillance camera, makes and visualises recordings and takes actions (for example sending notifications).

    Edit this page on GitHub

    \ No newline at end of file diff --git a/index.min.043f7b7308409ac3e67679315a41fd9fac3fd39f80a7f5ac82dd92857185f29b11e21997d5723c9fc448098a72292664dc3016ded635b4475220cdbd4bdda613.js b/index.min.71e05784bf5441c378e8824d18e4b5a057f28cde2bd06f927216eb278586f7ea7d96309df4600474b3b928ef2b635a64248e2cf3a7a023136087ed4050162608.js similarity index 99% rename from index.min.043f7b7308409ac3e67679315a41fd9fac3fd39f80a7f5ac82dd92857185f29b11e21997d5723c9fc448098a72292664dc3016ded635b4475220cdbd4bdda613.js rename to index.min.71e05784bf5441c378e8824d18e4b5a057f28cde2bd06f927216eb278586f7ea7d96309df4600474b3b928ef2b635a64248e2cf3a7a023136087ed4050162608.js index 2b86276..573ee85 100644 --- a/index.min.043f7b7308409ac3e67679315a41fd9fac3fd39f80a7f5ac82dd92857185f29b11e21997d5723c9fc448098a72292664dc3016ded635b4475220cdbd4bdda613.js +++ b/index.min.71e05784bf5441c378e8824d18e4b5a057f28cde2bd06f927216eb278586f7ea7d96309df4600474b3b928ef2b635a64248e2cf3a7a023136087ed4050162608.js @@ -1 +1 @@ -var suggestions=document.getElementById('suggestions'),userinput=document.getElementById('userinput');document.addEventListener('keydown',inputFocus);function inputFocus(a){a.keyCode===191&&(a.preventDefault(),userinput.focus()),a.keyCode===27&&(userinput.blur(),suggestions.classList.add('d-none'))}document.addEventListener('click',function(a){var b=suggestions.contains(a.target);b||suggestions.classList.add('d-none')}),document.addEventListener('keydown',suggestionFocus);function suggestionFocus(b){const d=suggestions.querySelectorAll('a'),e=[...d],a=e.indexOf(document.activeElement);let c=0;b.keyCode===38?(b.preventDefault(),c=a>0?a-1:0,d[c].focus()):b.keyCode===40&&(b.preventDefault(),c=a+1',a=c.querySelector('a'),t=c.querySelector('span:first-child'),d=c.querySelector('span:nth-child(2)'),a.href=b.href,t.textContent=b.title,d.textContent=b.description,suggestions.appendChild(c)});f.length>i;)suggestions.removeChild(f[h])}function f(){while(suggestions.lastChild)suggestions.removeChild(suggestions.lastChild);return!1}})() \ No newline at end of file +var suggestions=document.getElementById('suggestions'),userinput=document.getElementById('userinput');document.addEventListener('keydown',inputFocus);function inputFocus(a){a.keyCode===191&&(a.preventDefault(),userinput.focus()),a.keyCode===27&&(userinput.blur(),suggestions.classList.add('d-none'))}document.addEventListener('click',function(a){var b=suggestions.contains(a.target);b||suggestions.classList.add('d-none')}),document.addEventListener('keydown',suggestionFocus);function suggestionFocus(b){const d=suggestions.querySelectorAll('a'),e=[...d],a=e.indexOf(document.activeElement);let c=0;b.keyCode===38?(b.preventDefault(),c=a>0?a-1:0,d[c].focus()):b.keyCode===40&&(b.preventDefault(),c=a+1',a=c.querySelector('a'),t=c.querySelector('span:first-child'),d=c.querySelector('span:nth-child(2)'),a.href=b.href,t.textContent=b.title,d.textContent=b.description,suggestions.appendChild(c)});f.length>i;)suggestions.removeChild(f[h])}function f(){while(suggestions.lastChild)suggestions.removeChild(suggestions.lastChild);return!1}})() \ No newline at end of file diff --git a/js/highlight.min.13bf6b39f28cd07b0780c0c154bf050bad1e7b73231c15e43b993504cca3fa814222ded3c525f429528451fe039a5078c71ae4d000486d26f9b920cc7db474da.js b/js/highlight.min.13bf6b39f28cd07b0780c0c154bf050bad1e7b73231c15e43b993504cca3fa814222ded3c525f429528451fe039a5078c71ae4d000486d26f9b920cc7db474da.js new file mode 100644 index 0000000..5382d8d --- /dev/null +++ b/js/highlight.min.13bf6b39f28cd07b0780c0c154bf050bad1e7b73231c15e43b993504cca3fa814222ded3c525f429528451fe039a5078c71ae4d000486d26f9b920cc7db474da.js @@ -0,0 +1 @@ +(()=>{var f=Object.create,d=Object.defineProperty,x=Object.getPrototypeOf,s=Object.prototype.hasOwnProperty,j=Object.getOwnPropertyNames,h=Object.getOwnPropertyDescriptor,g=a=>d(a,"__esModule",{value:!0}),b=(b,a)=>()=>(a||b((a={exports:{}}).exports,a),a.exports),i=(b,a,c)=>{if(a&&typeof a=="object"||typeof a=="function")for(let e of j(a))!s.call(b,e)&&e!=="default"&&d(b,e,{get:()=>a[e],enumerable:!(c=h(a,e))||c.enumerable});return b},c=a=>i(g(d(a!=null?f(x(a)):{},"default",a&&a.__esModule&&"default"in a?{get:()=>a.default,enumerable:!0}:{value:a,enumerable:!0})),a),k=b((aw,au)=>{var t,Y,q,V,m,U,l,H,C,A,w,i,k,y,v,B,z,d,E,F,o,g,I,J,K,L,M,N,O,P,Q,R,S,T,f,_,$,ab,Z,p,h,r,a,j,n,x,D,W;function u(a){return a instanceof Map?a.clear=a.delete=a.set=function(){throw new Error("map is read-only")}:a instanceof Set&&(a.add=a.clear=a.delete=function(){throw new Error("set is read-only")}),Object.freeze(a),Object.getOwnPropertyNames(a).forEach(function(c){var b=a[c];typeof b=="object"&&!Object.isFrozen(b)&&u(b)}),a}t=u,Y=u,t.default=Y,q=class{constructor(a){a.data===void 0&&(a.data={}),this.data=a.data,this.isMatchIgnored=!1}ignoreMatch(){this.isMatchIgnored=!0}};function c(a){return a.replace(/&/g,"&").replace(//g,">").replace(/"/g,""").replace(/'/g,"'")}function b(b,...c){const a=Object.create(null);for(const c in b)a[c]=b[c];return c.forEach(function(b){for(const c in b)a[c]=b[c]}),a}V="",m=a=>!!a.kind,U=class{constructor(a,b){this.buffer="",this.classPrefix=b.classPrefix,a.walk(this)}addText(a){this.buffer+=c(a)}openNode(a){if(!m(a))return;let b=a.kind;a.sublanguage||(b=`${this.classPrefix}${b}`),this.span(b)}closeNode(a){if(!m(a))return;this.buffer+=V}value(){return this.buffer}span(a){this.buffer+=``}},l=class{constructor(){this.rootNode={children:[]},this.stack=[this.rootNode]}get top(){return this.stack[this.stack.length-1]}get root(){return this.rootNode}add(a){this.top.children.push(a)}openNode(b){const a={kind:b,children:[]};this.add(a),this.stack.push(a)}closeNode(){return this.stack.length>1?this.stack.pop():void 0}closeAllNodes(){while(this.closeNode());}toJSON(){return JSON.stringify(this.rootNode,null,4)}walk(a){return this.constructor._walk(a,this.rootNode)}static _walk(b,a){return typeof a=="string"?b.addText(a):a.children&&(b.openNode(a),a.children.forEach(a=>this._walk(b,a)),b.closeNode(a)),b}static _collapse(a){if(typeof a=="string")return;if(!a.children)return;a.children.every(a=>typeof a=="string")?a.children=[a.children.join("")]:a.children.forEach(a=>{l._collapse(a)})}},H=class extends l{constructor(a){super(),this.options=a}addKeyword(a,b){if(a==="")return;this.openNode(b),this.addText(a),this.closeNode()}addText(a){if(a==="")return;this.add(a)}addSublanguage(b,c){const a=b.root;a.kind=c,a.sublanguage=!0,this.add(a)}toHTML(){const a=new U(this,this.options);return a.value()}finalize(){return!0}};function at(a){return new RegExp(a.replace(/[-/\\^$*+?.()|[\]{}]/g,"\\$&"),"m")}function e(a){return a?typeof a=="string"?a:a.source:null}function ar(...a){const b=a.map(a=>e(a)).join("");return b}function aq(...a){const b="("+a.map(a=>e(a)).join("|")+")";return b}function ap(a){return new RegExp(a.toString()+"|").exec("").length-1}function ac(a,c){const b=a&&a.exec(c);return b&&b.index===0}C=/\[(?:[^\\\]]|\\.)*\]|\(\??|\\([1-9][0-9]*)|\\./;function ao(b,c="|"){let a=0;return b.map(d=>{a+=1;const f=a;let b=e(d),c="";while(b.length>0){const d=C.exec(b);if(!d){c+=b;break}c+=b.substring(0,d.index),b=b.substring(d.index+d[0].length),d[0][0]==="\\"&&d[1]?c+="\\"+String(Number(d[1])+f):(c+=d[0],d[0]==="("&&a++)}return c}).map(a=>`(${a})`).join(c)}A=/\b\B/,w="[a-zA-Z]\\w*",i="[a-zA-Z_]\\w*",k="\\b\\d+(\\.\\d+)?",y="(-?)(\\b0[xX][a-fA-F0-9]+|(\\b\\d+(\\.\\d*)?|\\.\\d+)([eE][-+]?\\d+)?)",v="\\b(0b[01]+)",B="!|!=|!==|%|%=|&|&&|&=|\\*|\\*=|\\+|\\+=|,|-|-=|/=|/|:|;|<<|<<=|<=|<|===|==|=|>>>=|>>=|>=|>>>|>>|>|\\?|\\[|\\{|\\(|\\^|\\^=|\\||\\|=|\\|\\||~",z=(a={})=>{const c=/^#![ ]*\//;return a.binary&&(a.begin=ar(c,/.*\b/,a.binary,/\b.*/)),b({className:"meta",begin:c,end:/$/,relevance:0,"on:begin":(a,b)=>{a.index!==0&&b.ignoreMatch()}},a)},d={begin:"\\\\[\\s\\S]",relevance:0},E={className:"string",begin:"'",end:"'",illegal:"\\n",contains:[d]},F={className:"string",begin:'"',end:'"',illegal:"\\n",contains:[d]},o={begin:/\b(a|an|the|are|I'm|isn't|don't|doesn't|won't|but|just|should|pretty|simply|enough|gonna|going|wtf|so|such|will|you|your|they|like|more)\b/},g=function(c,d,e={}){const a=b({className:"comment",begin:c,end:d,contains:[]},e);return a.contains.push(o),a.contains.push({className:"doctag",begin:"(?:TODO|FIXME|NOTE|BUG|OPTIMIZE|HACK|XXX):",relevance:0}),a},I=g("//","$"),J=g("/\\*","\\*/"),K=g("#","$"),L={className:"number",begin:k,relevance:0},M={className:"number",begin:y,relevance:0},N={className:"number",begin:v,relevance:0},O={className:"number",begin:k+"(%|em|ex|ch|rem|vw|vh|vmin|vmax|cm|mm|in|pt|pc|px|deg|grad|rad|turn|s|ms|Hz|kHz|dpi|dpcm|dppx)?",relevance:0},P={begin:/(?=\/[^/\n]*\/)/,contains:[{className:"regexp",begin:/\//,end:/\/[gimuy]*/,illegal:/\n/,contains:[d,{begin:/\[/,end:/\]/,relevance:0,contains:[d]}]}]},Q={className:"title",begin:w,relevance:0},R={className:"title",begin:i,relevance:0},S={begin:"\\.\\s*"+i,relevance:0},T=function(a){return Object.assign(a,{"on:begin":(a,b)=>{b.data._beginMatch=a[1]},"on:end":(b,a)=>{a.data._beginMatch!==b[1]&&a.ignoreMatch()}})},f=Object.freeze({__proto__:null,MATCH_NOTHING_RE:A,IDENT_RE:w,UNDERSCORE_IDENT_RE:i,NUMBER_RE:k,C_NUMBER_RE:y,BINARY_NUMBER_RE:v,RE_STARTERS_RE:B,SHEBANG:z,BACKSLASH_ESCAPE:d,APOS_STRING_MODE:E,QUOTE_STRING_MODE:F,PHRASAL_WORDS_MODE:o,COMMENT:g,C_LINE_COMMENT_MODE:I,C_BLOCK_COMMENT_MODE:J,HASH_COMMENT_MODE:K,NUMBER_MODE:L,C_NUMBER_MODE:M,BINARY_NUMBER_MODE:N,CSS_NUMBER_MODE:O,REGEXP_MODE:P,TITLE_MODE:Q,UNDERSCORE_TITLE_MODE:R,METHOD_GUARD:S,END_SAME_AS_BEGIN:T});function an(a,b){const c=a.input[a.index-1];c==="."&&b.ignoreMatch()}function am(a,b){if(!b)return;if(!a.beginKeywords)return;a.begin="\\b("+a.beginKeywords.split(" ").join("|")+")(?!\\.)(?=\\b|\\s)",a.__beforeBegin=an,a.keywords=a.keywords||a.beginKeywords,delete a.beginKeywords,a.relevance===void 0&&(a.relevance=0)}function al(a,b){if(!Array.isArray(a.illegal))return;a.illegal=aq(...a.illegal)}function ak(a,b){if(!a.match)return;if(a.begin||a.end)throw new Error("begin & end are not supported with match");a.begin=a.match,delete a.match}function aj(a,b){a.relevance===void 0&&(a.relevance=1)}_=["of","and","for","in","not","or","if","then","parent","list","value"],$="keyword";function aa(a,c,d=$){const b={};return typeof a=="string"?e(d,a.split(" ")):Array.isArray(a)?e(d,a):Object.keys(a).forEach(function(d){Object.assign(b,aa(a[d],c,d))}),b;function e(d,a){c&&(a=a.map(a=>a.toLowerCase())),a.forEach(function(c){const a=c.split("|");b[a[0]]=[d,ag(a[0],a[1])]})}}function ag(b,a){return a?Number(a):ae(b)?0:1}function ae(a){return _.includes(a.toLowerCase())}function ad(a,{plugins:i}){function c(b,c){return new RegExp(e(b),"m"+(a.case_insensitive?"i":"")+(c?"g":""))}class f{constructor(){this.matchIndexes={},this.regexes=[],this.matchAt=1,this.position=0}addRule(b,a){a.position=this.position++,this.matchIndexes[this.matchAt]=a,this.regexes.push([a,b]),this.matchAt+=ap(b)+1}compile(){this.regexes.length===0&&(this.exec=()=>null);const a=this.regexes.map(a=>a[1]);this.matcherRe=c(ao(a),!0),this.lastIndex=0}exec(c){this.matcherRe.lastIndex=this.lastIndex;const a=this.matcherRe.exec(c);if(!a)return null;const b=a.findIndex((a,b)=>b>0&&a!==void 0),d=this.matchIndexes[b];return a.splice(0,b),Object.assign(a,d)}}class g{constructor(){this.rules=[],this.multiRegexes=[],this.count=0,this.lastIndex=0,this.regexIndex=0}getMatcher(a){if(this.multiRegexes[a])return this.multiRegexes[a];const b=new f;return this.rules.slice(a).forEach(([a,c])=>b.addRule(a,c)),b.compile(),this.multiRegexes[a]=b,b}resumingScanAtSamePosition(){return this.regexIndex!==0}considerAll(){this.regexIndex=0}addRule(b,a){this.rules.push([b,a]),a.type==="begin"&&this.count++}exec(b){const c=this.getMatcher(this.regexIndex);c.lastIndex=this.lastIndex;let a=c.exec(b);if(this.resumingScanAtSamePosition())if(a&&a.index===this.lastIndex);else{const c=this.getMatcher(0);c.lastIndex=this.lastIndex+1,a=c.exec(b)}return a&&(this.regexIndex+=a.position+1,this.regexIndex===this.count&&this.considerAll()),a}}function h(a){const b=new g;return a.contains.forEach(a=>b.addRule(a.begin,{rule:a,type:"begin"})),a.terminatorEnd&&b.addRule(a.terminatorEnd,{type:"end"}),a.illegal&&b.addRule(a.illegal,{type:"illegal"}),b}function d(b,g){const f=b;if(b.isCompiled)return f;[ak].forEach(a=>a(b,g)),a.compilerExtensions.forEach(a=>a(b,g)),b.__beforeBegin=null,[am,al,aj].forEach(a=>a(b,g)),b.isCompiled=!0;let i=null;if(typeof b.keywords=="object"&&(i=b.keywords.$pattern,delete b.keywords.$pattern),b.keywords&&(b.keywords=aa(b.keywords,a.case_insensitive)),b.lexemes&&i)throw new Error("ERR: Prefer `keywords.$pattern` to `mode.lexemes`, BOTH are not allowed. (see mode reference) ");return i=i||b.lexemes||/\w+/,f.keywordPatternRe=c(i,!0),g&&(b.begin||(b.begin=/\B|\b/),f.beginRe=c(b.begin),b.endSameAsBegin&&(b.end=b.begin),!b.end&&!b.endsWithParent&&(b.end=/\B|\b/),b.end&&(f.endRe=c(b.end)),f.terminatorEnd=e(b.end)||"",b.endsWithParent&&g.terminatorEnd&&(f.terminatorEnd+=(b.end?"|":"")+g.terminatorEnd)),b.illegal&&(f.illegalRe=c(b.illegal)),b.contains||(b.contains=[]),b.contains=[].concat(...b.contains.map(function(a){return af(a==="self"?b:a)})),b.contains.forEach(function(a){d(a,f)}),b.starts&&d(b.starts,g),f.matcher=h(f),f}if(a.compilerExtensions||(a.compilerExtensions=[]),a.contains&&a.contains.includes("self"))throw new Error("ERR: contains `self` is not supported at the top-level of a language. See documentation.");return a.classNameAliases=b(a.classNameAliases||{}),d(a)}function G(a){return!!a&&(a.endsWithParent||G(a.starts))}function af(a){return a.variants&&!a.cachedVariants&&(a.cachedVariants=a.variants.map(function(c){return b(a,{variants:null},c)})),a.cachedVariants?a.cachedVariants:G(a)?b(a,{starts:a.starts?b(a.starts):null}):Object.isFrozen(a)?b(a):a}ab="10.7.2";function ah(a){return Boolean(a||a==="")}function ai(a){const b={props:["language","code","autodetect"],data:function(){return{detectedLanguage:"",unknownLanguage:!1}},computed:{className(){return this.unknownLanguage?"":"hljs "+this.detectedLanguage},highlighted(){if(!this.autoDetect&&!a.getLanguage(this.language))return console.warn(`The language "${this.language}" you specified could not be found.`),this.unknownLanguage=!0,c(this.code);let b={};return this.autoDetect?(b=a.highlightAuto(this.code),this.detectedLanguage=b.language):(b=a.highlight(this.language,this.code,this.ignoreIllegals),this.detectedLanguage=this.language),b.value},autoDetect(){return!this.language||ah(this.autodetect)},ignoreIllegals(){return!0}},render(a){return a("pre",{},[a("code",{class:this.className,domProps:{innerHTML:this.highlighted}})])}},d={install(a){a.component("highlightjs",b)}};return{Component:b,VuePlugin:d}}Z={"after:highlightElement":({el:d,result:a,text:e})=>{const b=X(d);if(!b.length)return;const c=document.createElement("div");c.innerHTML=a.value,a.value=av(b,X(c),e)}};function s(a){return a.nodeName.toLowerCase()}function X(b){const a=[];return function c(d,b){for(let e=d.firstChild;e;e=e.nextSibling)e.nodeType===3?b+=e.nodeValue.length:e.nodeType===1&&(a.push({event:"start",offset:b,node:e}),b=c(e,b),s(e).match(/br|hr|img|input/)||a.push({event:"stop",offset:b,node:e}));return b}(b,0),a}function av(a,b,g){let d=0,e="";const f=[];function h(){return!a.length||!b.length?a.length?a:b:a[0].offset!==b[0].offset?a[0].offset"}function j(a){e+=""}function k(a){(a.event==="start"?i:j)(a.node)}while(a.length||b.length){let b=h();if(e+=c(g.substring(d,b[0].offset)),d=b[0].offset,b===a){f.reverse().forEach(j);do k(b.splice(0,1)[0]),b=h();while(b===a&&b.length&&b[0].offset===d)f.reverse().forEach(i)}else b[0].event==="start"?f.push(b[0].node):f.pop(),k(b.splice(0,1)[0])}return e+c(g.substr(d))}p={},h=a=>{console.error(a)},r=(a,...b)=>{console.log(`WARN: ${a}`,...b)},a=(a,b)=>{if(p[`${a}/${b}`])return;console.log(`Deprecated as of ${a}. ${b}`),p[`${a}/${b}`]=!0},j=c,n=b,x=Symbol("nomatch"),D=function(c){const e=Object.create(null),g=Object.create(null),o=[];let i=!0;const U=/(^(<[^>]+>|\t|)+|\n)/gm,v="Could not find the language '{}', did you forget to load/include a language module?",y={disableAutodetect:!0,name:"Plain text",contains:[]};let b={noHighlightRe:/^(no-?highlight)$/i,languageDetectRe:/\blang(?:uage)?-([\w-]+)\b/i,classPrefix:"hljs-",tabReplace:null,useBR:!1,languages:null,__emitter:H};function z(a){return b.noHighlightRe.test(a)}function R(a){let e=a.className+" ";e+=a.parentNode?a.parentNode.className:"";const c=b.languageDetectRe.exec(e);if(c){const b=d(c[1]);return b||(r(v.replace("{}",c[1])),r("Falling back to no-highlight mode for this block.",a)),b?c[1]:"no-highlight"}return e.split(/\s+/).find(a=>z(a)||d(a))}function B(i,c,g,h){let d="",e="";typeof c=="object"?(d=i,g=c.ignoreIllegals,e=c.language,h=void 0):(a("10.7.0","highlight(lang, code, ...args) has been deprecated."),a("10.7.0","Please use highlight(code, options) instead.\nhttps://github.com/highlightjs/highlight.js/issues/2277"),e=i,d=c);const b={code:d,language:e};k("before:highlight",b);const f=b.result?b.result:s(b.language,b.code,g,h);return f.code=b.code,k("after:highlight",f),f}function s(n,g,L,K){function J(a,b){const c=l.case_insensitive?b[0].toLowerCase():b[0];return Object.prototype.hasOwnProperty.call(a.keywords,c)&&a.keywords[c]}function I(){if(!a.keywords){f.addText(c);return}let e=0;a.keywordPatternRe.lastIndex=0;let b=a.keywordPatternRe.exec(c),d="";while(b){d+=c.substring(e,b.index);const g=J(a,b);if(g){const[a,c]=g;if(f.addText(d),d="",p+=c,a.startsWith("_"))d+=b[0];else{const c=l.classNameAliases[a]||a;f.addKeyword(b[0],c)}}else d+=b[0];e=a.keywordPatternRe.lastIndex,b=a.keywordPatternRe.exec(c)}d+=c.substr(e),f.addText(d)}function H(){if(c==="")return;let b=null;if(typeof a.subLanguage=="string"){if(!e[a.subLanguage]){f.addText(c);return}b=s(a.subLanguage,c,!0,A[a.subLanguage]),A[a.subLanguage]=b.top}else b=m(c,a.subLanguage.length?a.subLanguage:null);a.relevance>0&&(p+=b.relevance),f.addSublanguage(b.emitter,b.language)}function t(){a.subLanguage!=null?H():I(),c=""}function C(b){return b.className&&f.openNode(l.classNameAliases[b.className]||b.className),a=Object.create(b,{parent:{value:a}}),a}function z(a,c,d){let b=ac(a.endRe,d);if(b){if(a["on:end"]){const d=new q(a);a["on:end"](c,d),d.isMatchIgnored&&(b=!1)}if(b){while(a.endsParent&&a.parent)a=a.parent;return a}}if(a.endsWithParent)return z(a.parent,c,d)}function F(b){return a.matcher.regexIndex===0?(c+=b[0],1):(y=!0,0)}function G(d){const b=d[0],a=d.rule,e=new q(a),f=[a.__beforeBegin,a["on:begin"]];for(const a of f){if(!a)continue;if(a(d,e),e.isMatchIgnored)return F(b)}return a&&a.endSameAsBegin&&(a.endRe=at(b)),a.skip?c+=b:(a.excludeBegin&&(c+=b),t(),!a.returnBegin&&!a.excludeBegin&&(c=b)),C(a),a.returnBegin?0:b.length}function D(h){const e=h[0],i=g.substr(h.index),b=z(a,h,i);if(!b)return x;const d=a;d.skip?c+=e:(d.returnEnd||d.excludeEnd||(c+=e),t(),d.excludeEnd&&(c=e));do a.className&&f.closeNode(),!a.skip&&!a.subLanguage&&(p+=a.relevance),a=a.parent;while(a!==b.parent)return b.starts&&(b.endSameAsBegin&&(b.starts.endRe=b.endRe),C(b.starts)),d.returnEnd?0:e.length}function M(){const b=[];for(let c=a;c!==l;c=c.parent)c.className&&b.unshift(c.className);b.forEach(a=>f.openNode(a))}let r={};function B(e,b){const d=b&&b[0];if(c+=e,d==null)return t(),0;if(r.type==="begin"&&b.type==="end"&&r.index===b.index&&d===""){if(c+=g.slice(b.index,b.index+1),!i){const a=new Error("0 width match regex");throw a.languageName=n,a.badRule=r.rule,a}return 1}if(r=b,b.type==="begin")return G(b);if(b.type==="illegal"&&!L){const b=new Error('Illegal lexeme "'+d+'" for mode "'+(a.className||"")+'"');throw b.mode=a,b}if(b.type==="end"){const a=D(b);if(a!==x)return a}if(b.type==="illegal"&&d==="")return 1;if(u>1e5&&u>b.index*3){const a=new Error("potential infinite loop, way more iterations than matches");throw a}return c+=d,d.length}const l=d(n);if(!l)throw h(v.replace("{}",n)),new Error('Unknown language: "'+n+'"');const E=ad(l,{plugins:o});let w="",a=K||E;const A={},f=new b.__emitter(b);M();let c="",p=0,k=0,u=0,y=!1;try{for(a.matcher.considerAll();;){u++,y?y=!1:a.matcher.considerAll(),a.matcher.lastIndex=k;const b=a.matcher.exec(g);if(!b)break;const c=g.substring(k,b.index),d=B(c,b);k=b.index+d}return B(g.substr(k)),f.closeAllNodes(),f.finalize(),w=f.toHTML(),{relevance:Math.floor(p),value:w,language:n,illegal:!1,emitter:f,top:a}}catch(b){if(b.message&&b.message.includes("Illegal"))return{illegal:!0,illegalBy:{msg:b.message,context:g.slice(k-100,k+100),mode:b.mode},sofar:w,relevance:0,value:j(g),emitter:f};if(i)return{illegal:!1,relevance:0,value:j(g),emitter:f,language:n,top:a,errorRaised:b};throw b}}function Q(a){const c={relevance:0,emitter:new b.__emitter(b),value:j(a),illegal:!1,top:y};return c.emitter.addText(a),c}function m(c,a){a=a||b.languages||Object.keys(e);const h=Q(c),f=a.filter(d).filter(C).map(a=>s(a,c,!1));f.unshift(h);const i=f.sort((a,b)=>{if(a.relevance!==b.relevance)return b.relevance-a.relevance;if(a.language&&b.language){if(d(a.language).supersetOf===b.language)return 1;if(d(b.language).supersetOf===a.language)return-1}return 0}),[j,k]=i,g=j;return g.second_best=k,g}function P(a){return b.tabReplace||b.useBR?a.replace(U,a=>a==="\n"?b.useBR?"
    ":a:b.tabReplace?a.replace(/\t/g,b.tabReplace):a):a}function J(a,b,d){const c=b?g[b]:d;a.classList.add("hljs"),c&&a.classList.add(c)}const I={"before:highlightElement":({el:a})=>{b.useBR&&(a.innerHTML=a.innerHTML.replace(/\n/g,"").replace(//g,"\n"))},"after:highlightElement":({result:a})=>{b.useBR&&(a.value=a.value.replace(/\n/g,"
    "))}},F=/^(<[^>]+>|\t)+/gm,D={"after:highlightElement":({result:a})=>{b.tabReplace&&(a.value=a.value.replace(F,a=>a.replace(/\t/g,b.tabReplace)))}};function l(b){let e=null;const c=R(b);if(z(c))return;k("before:highlightElement",{el:b,language:c}),e=b;const d=e.textContent,a=c?B(d,{language:c,ignoreIllegals:!0}):m(d);k("after:highlightElement",{el:b,result:a,text:d}),b.innerHTML=a.value,J(b,c,a.language),b.result={language:a.language,re:a.relevance,relavance:a.relevance},a.second_best&&(b.second_best={language:a.second_best.language,re:a.second_best.relevance,relavance:a.second_best.relevance})}function E(c){c.useBR&&(a("10.3.0","'useBR' will be removed entirely in v11.0"),a("10.3.0","Please see https://github.com/highlightjs/highlight.js/issues/2559")),b=n(b,c)}const u=()=>{if(u.called)return;u.called=!0,a("10.6.0","initHighlighting() is deprecated. Use highlightAll() instead.");const b=document.querySelectorAll("pre code");b.forEach(l)};function G(){a("10.6.0","initHighlightingOnLoad() is deprecated. Use highlightAll() instead."),p=!0}let p=!1;function A(){if(document.readyState==="loading"){p=!0;return}const a=document.querySelectorAll("pre code");a.forEach(l)}function K(){p&&A()}typeof window!="undefined"&&window.addEventListener&&window.addEventListener("DOMContentLoaded",K,!1);function L(b,d){let a=null;try{a=d(c)}catch(c){if(h("Language definition for '{}' could not be registered.".replace("{}",b)),!i)throw c;h(c),a=y}a.name||(a.name=b),e[b]=a,a.rawDefinition=d.bind(null,c),a.aliases&&w(a.aliases,{languageName:b})}function M(a){delete e[a];for(const b of Object.keys(g))g[b]===a&&delete g[b]}function N(){return Object.keys(e)}function O(b){a("10.4.0","requireLanguage will be removed entirely in v11."),a("10.4.0","Please see https://github.com/highlightjs/highlight.js/pull/2844");const c=d(b);if(c)return c;const e=new Error("The '{}' language is required, but not loaded.".replace("{}",b));throw e}function d(a){return a=(a||"").toLowerCase(),e[a]||e[g[a]]}function w(a,{languageName:b}){typeof a=="string"&&(a=[a]),a.forEach(a=>{g[a.toLowerCase()]=b})}function C(b){const a=d(b);return a&&!a.disableAutodetect}function S(a){a["before:highlightBlock"]&&!a["before:highlightElement"]&&(a["before:highlightElement"]=b=>{a["before:highlightBlock"](Object.assign({block:b.el},b))}),a["after:highlightBlock"]&&!a["after:highlightElement"]&&(a["after:highlightElement"]=b=>{a["after:highlightBlock"](Object.assign({block:b.el},b))})}function T(a){S(a),o.push(a)}function k(b,c){const a=b;o.forEach(function(b){b[a]&&b[a](c)})}function V(b){return a("10.2.0","fixMarkup will be removed entirely in v11.0"),a("10.2.0","Please see https://github.com/highlightjs/highlight.js/issues/2534"),P(b)}function W(b){return a("10.7.0","highlightBlock will be removed entirely in v12.0"),a("10.7.0","Please use highlightElement now."),l(b)}Object.assign(c,{highlight:B,highlightAuto:m,highlightAll:A,fixMarkup:V,highlightElement:l,highlightBlock:W,configure:E,initHighlighting:u,initHighlightingOnLoad:G,registerLanguage:L,unregisterLanguage:M,listLanguages:N,getLanguage:d,registerAliases:w,requireLanguage:O,autoDetection:C,inherit:n,addPlugin:T,vuePlugin:ai(c).VuePlugin}),c.debugMode=function(){i=!1},c.safeMode=function(){i=!0},c.versionString=ab;for(const a in f)typeof f[a]=="object"&&t(f[a]);return Object.assign(c,f),c.addPlugin(I),c.addPlugin(Z),c.addPlugin(D),c},W=D({}),au.exports=W}),l=b((n,m)=>{var c="[A-Za-z$_][0-9A-Za-z$_]*",l=["as","in","of","if","for","while","finally","var","new","function","do","return","void","else","break","catch","instanceof","with","throw","case","default","try","switch","continue","typeof","delete","let","yield","const","class","debugger","async","await","static","import","from","export","extends"],e=["true","false","null","undefined","NaN","Infinity"],f=["Intl","DataView","Number","Math","Date","String","RegExp","Object","Function","Boolean","Error","Symbol","Set","Map","WeakSet","WeakMap","Proxy","Reflect","JSON","Promise","Float64Array","Int16Array","Int32Array","Int8Array","Uint16Array","Uint32Array","Float32Array","Array","Uint8Array","Uint8ClampedArray","ArrayBuffer","BigInt64Array","BigUint64Array","BigInt"],g=["EvalError","InternalError","RangeError","ReferenceError","SyntaxError","TypeError","URIError"],h=["setInterval","setTimeout","clearInterval","clearTimeout","require","exports","eval","isFinite","isNaN","parseFloat","parseInt","decodeURI","decodeURIComponent","encodeURI","encodeURIComponent","escape","unescape"],i=["arguments","this","super","console","window","document","localStorage","module","global"],j=[].concat(h,i,f,g);function k(a){return a?typeof a=="string"?a:a.source:null}function b(b){return a("(?=",b,")")}function a(...a){const b=a.map(a=>k(a)).join("");return b}function d(d){const z=(a,{after:b})=>{const c="",end:""},h={begin:/<[A-Za-z0-9\\._:-]+/,end:/\/[A-Za-z0-9\\._:-]+>|\/>/,isTrulyOpeningTag:(a,b)=>{const c=a[0].length+a.index,d=a.input[c];if(d==="<"){b.ignoreMatch();return}d===">"&&(z(a,{after:c})||b.ignoreMatch())}},g={$pattern:c,keyword:l,literal:e,built_in:j},v="[0-9](_?[0-9])*",k=`\\.(${v})`,s=`0|[1-9](_?[0-9])*|0[0-7]*[89][0-9]*`,q={className:"number",variants:[{begin:`(\\b(${s})((${k})|\\.)?|(${k}))[eE][+-]?(${v})\\b`},{begin:`\\b(${s})\\b((${k})\\b|\\.)?|(${k})\\b`},{begin:`\\b(0|[1-9](_?[0-9])*)n\\b`},{begin:"\\b0[xX][0-9a-fA-F](_?[0-9a-fA-F])*n?\\b"},{begin:"\\b0[bB][0-1](_?[0-1])*n?\\b"},{begin:"\\b0[oO][0-7](_?[0-7])*n?\\b"},{begin:"\\b0[0-7]+n?\\b"}],relevance:0},i={className:"subst",begin:"\\$\\{",end:"\\}",keywords:g,contains:[]},r={begin:"html`",end:"",starts:{end:"`",returnEnd:!1,contains:[d.BACKSLASH_ESCAPE,i],subLanguage:"xml"}},p={begin:"css`",end:"",starts:{end:"`",returnEnd:!1,contains:[d.BACKSLASH_ESCAPE,i],subLanguage:"css"}},t={className:"string",begin:"`",end:"`",contains:[d.BACKSLASH_ESCAPE,i]},y=d.COMMENT(/\/\*\*(?!\/)/,"\\*/",{relevance:0,contains:[{className:"doctag",begin:"@[A-Za-z]+",contains:[{className:"type",begin:"\\{",end:"\\}",relevance:0},{className:"variable",begin:f+"(?=\\s*(-)|$)",endsParent:!0,relevance:0},{begin:/(?=[^\n])\s/,relevance:0}]}]}),o={className:"comment",variants:[y,d.C_BLOCK_COMMENT_MODE,d.C_LINE_COMMENT_MODE]},w=[d.APOS_STRING_MODE,d.QUOTE_STRING_MODE,r,p,t,q,d.REGEXP_MODE];i.contains=w.concat({begin:/\{/,end:/\}/,keywords:g,contains:["self"].concat(w)});const u=[].concat(o,i.contains),n=u.concat([{begin:/\(/,end:/\)/,keywords:g,contains:["self"].concat(u)}]),m={className:"params",begin:/\(/,end:/\)/,excludeBegin:!0,excludeEnd:!0,keywords:g,contains:n};return{name:"Javascript",aliases:["js","jsx","mjs","cjs"],keywords:g,exports:{PARAMS_CONTAINS:n},illegal:/#(?![$_A-z])/,contains:[d.SHEBANG({label:"shebang",binary:"node",relevance:5}),{label:"use_strict",className:"meta",relevance:10,begin:/^\s*['"]use (strict|asm)['"]/},d.APOS_STRING_MODE,d.QUOTE_STRING_MODE,r,p,t,o,q,{begin:a(/[{,\n]\s*/,b(a(/(((\/\/.*$)|(\/\*(\*[^/]|[^*])*\*\/))\s*)*/,f+"\\s*:"))),relevance:0,contains:[{className:"attr",begin:f+b("\\s*:"),relevance:0}]},{begin:"("+d.RE_STARTERS_RE+"|\\b(case|return|throw)\\b)\\s*",keywords:"return throw case",contains:[o,d.REGEXP_MODE,{className:"function",begin:"(\\([^()]*(\\([^()]*(\\([^()]*\\)[^()]*)*\\)[^()]*)*\\)|"+d.UNDERSCORE_IDENT_RE+")\\s*=>",returnBegin:!0,end:"\\s*=>",contains:[{className:"params",variants:[{begin:d.UNDERSCORE_IDENT_RE,relevance:0},{className:null,begin:/\(\s*\)/,skip:!0},{begin:/\(/,end:/\)/,excludeBegin:!0,excludeEnd:!0,keywords:g,contains:n}]}]},{begin:/,/,relevance:0},{className:"",begin:/\s/,end:/\s*/,skip:!0},{variants:[{begin:x.begin,end:x.end},{begin:h.begin,"on:begin":h.isTrulyOpeningTag,end:h.end}],subLanguage:"xml",contains:[{begin:h.begin,end:h.end,skip:!0,contains:["self"]}]}],relevance:0},{className:"function",beginKeywords:"function",end:/[{;]/,excludeEnd:!0,keywords:g,contains:["self",d.inherit(d.TITLE_MODE,{begin:f}),m],illegal:/%/},{beginKeywords:"while if switch catch for"},{className:"function",begin:d.UNDERSCORE_IDENT_RE+"\\([^()]*(\\([^()]*(\\([^()]*\\)[^()]*)*\\)[^()]*)*\\)\\s*\\{",returnBegin:!0,contains:[m,d.inherit(d.TITLE_MODE,{begin:f})]},{variants:[{begin:"\\."+f},{begin:"\\$"+f}],relevance:0},{className:"class",beginKeywords:"class",end:/[{;=]/,excludeEnd:!0,illegal:/[:"[\]]/,contains:[{beginKeywords:"extends"},d.UNDERSCORE_TITLE_MODE]},{begin:/\b(?=constructor)/,end:/[{;]/,excludeEnd:!0,contains:[d.inherit(d.TITLE_MODE,{begin:f}),"self",m]},{begin:"(get|set)\\s+(?="+f+"\\()",end:/\{/,keywords:"get set",contains:[d.inherit(d.TITLE_MODE,{begin:f}),{begin:/\(\)/},m]},{begin:/\$[(.]/}]}}m.exports=d}),m=b((c,a)=>{function b(a){const c={literal:"true false null"},d=[a.C_LINE_COMMENT_MODE,a.C_BLOCK_COMMENT_MODE],b=[a.QUOTE_STRING_MODE,a.C_NUMBER_MODE],e={end:",",endsWithParent:!0,excludeEnd:!0,contains:b,keywords:c},f={begin:/\{/,end:/\}/,contains:[{className:"attr",begin:/"/,end:/"/,contains:[a.BACKSLASH_ESCAPE],illegal:"\\n"},a.inherit(e,{begin:/:/})].concat(d),illegal:"\\S"},g={begin:"\\[",end:"\\]",contains:[a.inherit(e)],illegal:"\\S"};return b.push(f,g),d.forEach(function(a){b.push(a)}),{name:"JSON",contains:b,keywords:c,illegal:"\\S"}}a.exports=b}),n=b((e,a)=>{function b(a){return a?typeof a=="string"?a:a.source:null}function c(...a){const c=a.map(a=>b(a)).join("");return c}function d(a){const b={},f={begin:/\$\{/,end:/\}/,contains:["self",{begin:/:-/,contains:[b]}]};Object.assign(b,{className:"variable",variants:[{begin:c(/\$[\w\d#@][\w\d_]*/,`(?![\\w\\d])(?![$])`)},f]});const d={className:"subst",begin:/\$\(/,end:/\)/,contains:[a.BACKSLASH_ESCAPE]},g={begin:/<<-?\s*(?=\w+)/,starts:{contains:[a.END_SAME_AS_BEGIN({begin:/(\w+)/,end:/(\w+)/,className:"string"})]}},e={className:"string",begin:/"/,end:/"/,contains:[a.BACKSLASH_ESCAPE,b,d]};d.contains.push(e);const h={className:"",begin:/\\"/},i={className:"string",begin:/'/,end:/'/},j={begin:/\$\(\(/,end:/\)\)/,contains:[{begin:/\d+#[0-9a-f]+/,className:"number"},a.NUMBER_MODE,b]},k=["fish","bash","zsh","sh","csh","ksh","tcsh","dash","scsh"],l=a.SHEBANG({binary:`(${k.join("|")})`,relevance:10}),m={className:"function",begin:/\w[\w\d_]*\s*\(\s*\)\s*\{/,returnBegin:!0,contains:[a.inherit(a.TITLE_MODE,{begin:/\w[\w\d_]*/})],relevance:0};return{name:"Bash",aliases:["sh","zsh"],keywords:{$pattern:/\b[a-z._-]+\b/,keyword:"if then else elif fi for while in do done case esac function",literal:"true false",built_in:"break cd continue eval exec exit export getopts hash pwd readonly return shift test times trap umask unset alias bind builtin caller command declare echo enable help let local logout mapfile printf read readarray source type typeset ulimit unalias set shopt autoload bg bindkey bye cap chdir clone comparguments compcall compctl compdescribe compfiles compgroups compquote comptags comptry compvalues dirs disable disown echotc echoti emulate fc fg float functions getcap getln history integer jobs kill limit log noglob popd print pushd pushln rehash sched setcap setopt stat suspend ttyctl unfunction unhash unlimit unsetopt vared wait whence where which zcompile zformat zftp zle zmodload zparseopts zprof zpty zregexparse zsocket zstyle ztcp"},contains:[l,a.SHEBANG(),m,j,a.HASH_COMMENT_MODE,g,e,h,i,b]}}a.exports=d}),o=b((i,d)=>{function b(a){return a?typeof a=="string"?a:a.source:null}function e(b){return a("(",b,")*")}function f(b){return a("(",b,")?")}function a(...a){const c=a.map(a=>b(a)).join("");return c}function c(...a){const c="("+a.map(a=>b(a)).join("|")+")";return c}function g(b){const g={"builtin-name":["action","bindattr","collection","component","concat","debugger","each","each-in","get","hash","if","in","input","link-to","loc","log","lookup","mut","outlet","partial","query-params","render","template","textarea","unbound","unless","view","with","yield"]},q={literal:["true","false","undefined","null"]},y=/""|"[^"]+"/,x=/''|'[^']+'/,p=/\[\]|\[[^\]]+\]/,k=/[^\s!"#%&'()*+,.\/;<=>@\[\\\]^`{|}~]+/,w=/(\.|\/)/,m=c(y,x,p,k),u=a(f(/\.|\.\/|\//),m,e(a(w,m))),r=a("(",p,"|",k,")(?==)"),d={begin:u,lexemes:/[\w.\/]+/},j=b.inherit(d,{keywords:q}),i={begin:/\(/,end:/\)/},s={className:"attr",begin:r,relevance:0,starts:{begin:/=/,end:/=/,starts:{contains:[b.NUMBER_MODE,b.QUOTE_STRING_MODE,b.APOS_STRING_MODE,j,i]}}},t={begin:/as\s+\|/,keywords:{keyword:"as"},end:/\|/,contains:[{begin:/\w+/}]},h={contains:[b.NUMBER_MODE,b.QUOTE_STRING_MODE,b.APOS_STRING_MODE,t,s,j,i],returnEnd:!0},v=b.inherit(d,{className:"name",keywords:g,starts:b.inherit(h,{end:/\)/})});i.contains=[v];const l=b.inherit(d,{keywords:g,className:"name",starts:b.inherit(h,{end:/\}\}/})}),o=b.inherit(d,{keywords:g,className:"name"}),n=b.inherit(d,{className:"name",keywords:g,starts:b.inherit(h,{end:/\}\}/})}),z={begin:/\\\{\{/,skip:!0},A={begin:/\\\\(?=\{\{)/,skip:!0};return{name:"Handlebars",aliases:["hbs","html.hbs","html.handlebars","htmlbars"],case_insensitive:!0,subLanguage:"xml",contains:[z,A,b.COMMENT(/\{\{!--/,/--\}\}/),b.COMMENT(/\{\{!/,/\}\}/),{className:"template-tag",begin:/\{\{\{\{(?!\/)/,end:/\}\}\}\}/,contains:[l],starts:{end:/\{\{\{\{\//,returnEnd:!0,subLanguage:"xml"}},{className:"template-tag",begin:/\{\{\{\{\//,end:/\}\}\}\}/,contains:[o]},{className:"template-tag",begin:/\{\{#/,end:/\}\}/,contains:[l]},{className:"template-tag",begin:/\{\{(?=else\}\})/,end:/\}\}/,keywords:"else"},{className:"template-tag",begin:/\{\{(?=else if)/,end:/\}\}/,keywords:"else if"},{className:"template-tag",begin:/\{\{\//,end:/\}\}/,contains:[o]},{className:"template-variable",begin:/\{\{\{/,end:/\}\}\}/,contains:[n]},{className:"template-variable",begin:/\{\{/,end:/\}\}/,contains:[n]}]}}function h(b){const a=g(b);return a.name="HTMLbars",b.getLanguage("handlebars")&&(a.disableAutodetect=!0),a}d.exports=h}),p=b((g,d)=>{function a(a){return a?typeof a=="string"?a:a.source:null}function e(a){return b("(?=",a,")")}function b(...b){const c=b.map(b=>a(b)).join("");return c}function f(...b){const c="("+b.map(b=>a(b)).join("|")+")";return c}function c(c){const d={className:"number",relevance:0,variants:[{begin:/([+-]+)?[\d]+_[\d_]+/},{begin:c.NUMBER_RE}]},a=c.COMMENT();a.variants=[{begin:/;/,end:/$/},{begin:/#/,end:/$/}];const g={className:"variable",variants:[{begin:/\$[\w\d"][\w\d_]*/},{begin:/\$\{(.*?)\}/}]},h={className:"literal",begin:/\bon|off|true|false|yes|no\b/},i={className:"string",contains:[c.BACKSLASH_ESCAPE],variants:[{begin:"'''",end:"'''",relevance:10},{begin:'"""',end:'"""',relevance:10},{begin:'"',end:'"'},{begin:"'",end:"'"}]},k={begin:/\[/,end:/\]/,contains:[a,h,g,i,d,"self"],relevance:0},l=/[A-Za-z0-9_-]+/,m=/"(\\"|[^"])*"/,n=/'[^']*'/,j=f(l,m,n),o=b(j,"(\\s*\\.\\s*",j,")*",e(/\s*=\s*[^#\s]/));return{name:"TOML, also INI",aliases:["toml"],case_insensitive:!0,illegal:/\S/,contains:[a,{className:"section",begin:/\[+/,end:/\]+/},{begin:o,className:"attr",starts:{end:/$/,contains:[a,k,h,g,i,d]}}]}}d.exports=c}),q=b((c,a)=>{function b(a){var c="true false yes no null",b="[\\w#;/?:@&=+$,.~*'()[\\]]+",m={className:"attr",variants:[{begin:"\\w[\\w :\\/.-]*:(?=[ ]|$)"},{begin:'"\\w[\\w :\\/.-]*":(?=[ ]|$)'},{begin:"'\\w[\\w :\\/.-]*':(?=[ ]|$)"}]},j={className:"template-variable",variants:[{begin:/\{\{/,end:/\}\}/},{begin:/%\{/,end:/\}/}]},f={className:"string",relevance:0,variants:[{begin:/'/,end:/'/},{begin:/"/,end:/"/},{begin:/\S+/}],contains:[a.BACKSLASH_ESCAPE,j]},h=a.inherit(f,{variants:[{begin:/'/,end:/'/},{begin:/"/,end:/"/},{begin:/[^\s,{}[\]]+/}]}),i="[0-9]{4}(-[0-9][0-9]){0,2}",q="([Tt \\t][0-9][0-9]?(:[0-9][0-9]){2})?",p="(\\.[0-9]*)?",k="([ \\t])*(Z|[-+][0-9][0-9]?(:[0-9][0-9])?)?",l={className:"number",begin:"\\b"+i+q+p+k+"\\b"},d={end:",",endsWithParent:!0,excludeEnd:!0,keywords:c,relevance:0},n={begin:/\{/,end:/\}/,contains:[d],illegal:"\\n",relevance:0},o={begin:"\\[",end:"\\]",contains:[d],illegal:"\\n",relevance:0},g=[m,{className:"meta",begin:"^---\\s*$",relevance:10},{className:"string",begin:"[\\|>]([1-9]?[+-])?[ ]*\\n( +)[^ ][^\\n]*\\n(\\2[^\\n]+\\n?)*"},{begin:"<%[%=-]?",end:"[%-]?%>",subLanguage:"ruby",excludeBegin:!0,excludeEnd:!0,relevance:0},{className:"type",begin:"!\\w+!"+b},{className:"type",begin:"!<"+b+">"},{className:"type",begin:"!"+b},{className:"type",begin:"!!"+b},{className:"meta",begin:"&"+a.UNDERSCORE_IDENT_RE+"$"},{className:"meta",begin:"\\*"+a.UNDERSCORE_IDENT_RE+"$"},{className:"bullet",begin:"-(?=[ ]|$)",relevance:0},a.HASH_COMMENT_MODE,{beginKeywords:c,keywords:{literal:c}},l,{className:"number",begin:a.C_NUMBER_RE+"\\b",relevance:0},n,o,f],e=[...g];return e.pop(),e.push(h),d.contains=e,{name:"YAML",case_insensitive:!0,aliases:["yml"],contains:g}}a.exports=b}),r=b((e,a)=>{function b(a){return a?typeof a=="string"?a:a.source:null}function c(...a){const c=a.map(a=>b(a)).join("");return c}function d(n){const f={begin:/<\/?[A-Za-z_]/,end:">",subLanguage:"xml",relevance:0},l={begin:"^[-\\*]{3,}",end:"$"},k={className:"code",variants:[{begin:"(`{3,})[^`](.|\\n)*?\\1`*[ ]*"},{begin:"(~{3,})[^~](.|\\n)*?\\1~*[ ]*"},{begin:"```",end:"```+[ ]*$"},{begin:"~~~",end:"~~~+[ ]*$"},{begin:"`.+?`"},{begin:"(?=^( {4}|\\t))",contains:[{begin:"^( {4}|\\t)",end:"(\\n)$"}],relevance:0}]},j={className:"bullet",begin:"^[ ]*([*+-]|(\\d+\\.))(?=\\s+)",end:"\\s+",excludeEnd:!0},i={begin:/^\[[^\n]+\]:/,returnBegin:!0,contains:[{className:"symbol",begin:/\[/,end:/\]/,excludeBegin:!0,excludeEnd:!0},{className:"link",begin:/:\s*/,end:/$/,excludeBegin:!0}]},h=/[A-Za-z][A-Za-z0-9+.-]*/,e={variants:[{begin:/\[.+?\]\[.*?\]/,relevance:0},{begin:/\[.+?\]\(((data|javascript|mailto):|(?:http|ftp)s?:\/\/).*?\)/,relevance:2},{begin:c(/\[.+?\]\(/,h,/:\/\/.*?\)/),relevance:2},{begin:/\[.+?\]\([./?&#].*?\)/,relevance:1},{begin:/\[.+?\]\(.*?\)/,relevance:0}],returnBegin:!0,contains:[{className:"string",relevance:0,begin:"\\[",end:"\\]",excludeBegin:!0,returnEnd:!0},{className:"link",relevance:0,begin:"\\]\\(",end:"\\)",excludeBegin:!0,excludeEnd:!0},{className:"symbol",relevance:0,begin:"\\]\\[",end:"\\]",excludeBegin:!0,excludeEnd:!0}]},d={className:"strong",contains:[],variants:[{begin:/_{2}/,end:/_{2}/},{begin:/\*{2}/,end:/\*{2}/}]},b={className:"emphasis",contains:[],variants:[{begin:/\*(?!\*)/,end:/\*/},{begin:/_(?!_)/,end:/_/,relevance:0}]};d.contains.push(b),b.contains.push(d);let a=[f,e];d.contains=d.contains.concat(a),b.contains=b.contains.concat(a),a=a.concat(d,b);const m={className:"section",variants:[{begin:"^#{1,6}",end:"$",contains:a},{begin:"(?=^.+?\\n[=-]{2,}$)",contains:[{begin:"^[=-]*$"},{begin:"^",end:"\\n",contains:a}]}]},g={className:"quote",begin:"^>\\s+",contains:a,end:"$"};return{name:"Markdown",aliases:["md","mkdown","mkd"],contains:[m,f,j,d,b,g,k,l,e,i]}}a.exports=d}),a=c(k()),t=c(l()),u=c(m()),v=c(n()),w=c(o()),e=c(p()),y=c(q()),z=c(r());a.default.registerLanguage("javascript",t.default),a.default.registerLanguage("json",u.default),a.default.registerLanguage("bash",v.default),a.default.registerLanguage("html",w.default),a.default.registerLanguage("ini",e.default),a.default.registerLanguage("toml",e.default),a.default.registerLanguage("yaml",y.default),a.default.registerLanguage("md",z.default),document.addEventListener("DOMContentLoaded",()=>{document.querySelectorAll("pre code").forEach(b=>{a.default.highlightElement(b)})})})() \ No newline at end of file diff --git a/js/highlight.min.8cdbefd08ec63ef25f4b2510ae50c13b3d9ed43e25a15ddb55f14c33130e68cf8be3131ccf2d087c49f5f21fe88c2f0e2715a21f936047d0d0b85dc48cb864b9.js b/js/highlight.min.8cdbefd08ec63ef25f4b2510ae50c13b3d9ed43e25a15ddb55f14c33130e68cf8be3131ccf2d087c49f5f21fe88c2f0e2715a21f936047d0d0b85dc48cb864b9.js deleted file mode 100644 index 497665e..0000000 --- a/js/highlight.min.8cdbefd08ec63ef25f4b2510ae50c13b3d9ed43e25a15ddb55f14c33130e68cf8be3131ccf2d087c49f5f21fe88c2f0e2715a21f936047d0d0b85dc48cb864b9.js +++ /dev/null @@ -1 +0,0 @@ -(()=>{var f=Object.create,d=Object.defineProperty,x=Object.getPrototypeOf,s=Object.prototype.hasOwnProperty,j=Object.getOwnPropertyNames,h=Object.getOwnPropertyDescriptor,g=a=>d(a,"__esModule",{value:!0}),b=(b,a)=>()=>(a||b((a={exports:{}}).exports,a),a.exports),i=(b,a,c)=>{if(a&&typeof a=="object"||typeof a=="function")for(let e of j(a))!s.call(b,e)&&e!=="default"&&d(b,e,{get:()=>a[e],enumerable:!(c=h(a,e))||c.enumerable});return b},c=a=>i(g(d(a!=null?f(x(a)):{},"default",a&&a.__esModule&&"default"in a?{get:()=>a.default,enumerable:!0}:{value:a,enumerable:!0})),a),k=b((aw,au)=>{var t,Y,q,V,m,U,l,H,C,A,w,i,k,y,v,B,z,d,E,F,o,g,I,J,K,L,M,N,O,P,Q,R,S,T,f,_,$,ab,Z,p,h,r,a,j,n,x,D,W;function u(a){return a instanceof Map?a.clear=a.delete=a.set=function(){throw new Error("map is read-only")}:a instanceof Set&&(a.add=a.clear=a.delete=function(){throw new Error("set is read-only")}),Object.freeze(a),Object.getOwnPropertyNames(a).forEach(function(c){var b=a[c];typeof b=="object"&&!Object.isFrozen(b)&&u(b)}),a}t=u,Y=u,t.default=Y,q=class{constructor(a){a.data===void 0&&(a.data={}),this.data=a.data,this.isMatchIgnored=!1}ignoreMatch(){this.isMatchIgnored=!0}};function c(a){return a.replace(/&/g,"&").replace(//g,">").replace(/"/g,""").replace(/'/g,"'")}function b(b,...c){const a=Object.create(null);for(const c in b)a[c]=b[c];return c.forEach(function(b){for(const c in b)a[c]=b[c]}),a}V="    ",m=a=>!!a.kind,U=class{constructor(a,b){this.buffer="",this.classPrefix=b.classPrefix,a.walk(this)}addText(a){this.buffer+=c(a)}openNode(a){if(!m(a))return;let b=a.kind;a.sublanguage||(b=`${this.classPrefix}${b}`),this.span(b)}closeNode(a){if(!m(a))return;this.buffer+=V}value(){return this.buffer}span(a){this.buffer+=``}},l=class{constructor(){this.rootNode={children:[]},this.stack=[this.rootNode]}get top(){return this.stack[this.stack.length-1]}get root(){return this.rootNode}add(a){this.top.children.push(a)}openNode(b){const a={kind:b,children:[]};this.add(a),this.stack.push(a)}closeNode(){return this.stack.length>1?this.stack.pop():void 0}closeAllNodes(){while(this.closeNode());}toJSON(){return JSON.stringify(this.rootNode,null,4)}walk(a){return this.constructor._walk(a,this.rootNode)}static _walk(b,a){return typeof a=="string"?b.addText(a):a.children&&(b.openNode(a),a.children.forEach(a=>this._walk(b,a)),b.closeNode(a)),b}static _collapse(a){if(typeof a=="string")return;if(!a.children)return;a.children.every(a=>typeof a=="string")?a.children=[a.children.join("")]:a.children.forEach(a=>{l._collapse(a)})}},H=class extends l{constructor(a){super(),this.options=a}addKeyword(a,b){if(a==="")return;this.openNode(b),this.addText(a),this.closeNode()}addText(a){if(a==="")return;this.add(a)}addSublanguage(b,c){const a=b.root;a.kind=c,a.sublanguage=!0,this.add(a)}toHTML(){const a=new U(this,this.options);return a.value()}finalize(){return!0}};function at(a){return new RegExp(a.replace(/[-/\\^$*+?.()|[\]{}]/g,"\\$&"),"m")}function e(a){return a?typeof a=="string"?a:a.source:null}function ar(...a){const b=a.map(a=>e(a)).join("");return b}function aq(...a){const b="("+a.map(a=>e(a)).join("|")+")";return b}function ap(a){return new RegExp(a.toString()+"|").exec("").length-1}function ac(a,c){const b=a&&a.exec(c);return b&&b.index===0}C=/\[(?:[^\\\]]|\\.)*\]|\(\??|\\([1-9][0-9]*)|\\./;function ao(b,c="|"){let a=0;return b.map(d=>{a+=1;const f=a;let b=e(d),c="";while(b.length>0){const d=C.exec(b);if(!d){c+=b;break}c+=b.substring(0,d.index),b=b.substring(d.index+d[0].length),d[0][0]==="\\"&&d[1]?c+="\\"+String(Number(d[1])+f):(c+=d[0],d[0]==="("&&a++)}return c}).map(a=>`(${a})`).join(c)}A=/\b\B/,w="[a-zA-Z]\\w*",i="[a-zA-Z_]\\w*",k="\\b\\d+(\\.\\d+)?",y="(-?)(\\b0[xX][a-fA-F0-9]+|(\\b\\d+(\\.\\d*)?|\\.\\d+)([eE][-+]?\\d+)?)",v="\\b(0b[01]+)",B="!|!=|!==|%|%=|&|&&|&=|\\*|\\*=|\\+|\\+=|,|-|-=|/=|/|:|;|<<|<<=|<=|<|===|==|=|>>>=|>>=|>=|>>>|>>|>|\\?|\\[|\\{|\\(|\\^|\\^=|\\||\\|=|\\|\\||~",z=(a={})=>{const c=/^#![ ]*\//;return a.binary&&(a.begin=ar(c,/.*\b/,a.binary,/\b.*/)),b({className:"meta",begin:c,end:/$/,relevance:0,"on:begin":(a,b)=>{a.index!==0&&b.ignoreMatch()}},a)},d={begin:"\\\\[\\s\\S]",relevance:0},E={className:"string",begin:"'",end:"'",illegal:"\\n",contains:[d]},F={className:"string",begin:'"',end:'"',illegal:"\\n",contains:[d]},o={begin:/\b(a|an|the|are|I'm|isn't|don't|doesn't|won't|but|just|should|pretty|simply|enough|gonna|going|wtf|so|such|will|you|your|they|like|more)\b/},g=function(c,d,e={}){const a=b({className:"comment",begin:c,end:d,contains:[]},e);return a.contains.push(o),a.contains.push({className:"doctag",begin:"(?:TODO|FIXME|NOTE|BUG|OPTIMIZE|HACK|XXX):",relevance:0}),a},I=g("//","$"),J=g("/\\*","\\*/"),K=g("#","$"),L={className:"number",begin:k,relevance:0},M={className:"number",begin:y,relevance:0},N={className:"number",begin:v,relevance:0},O={className:"number",begin:k+"(%|em|ex|ch|rem|vw|vh|vmin|vmax|cm|mm|in|pt|pc|px|deg|grad|rad|turn|s|ms|Hz|kHz|dpi|dpcm|dppx)?",relevance:0},P={begin:/(?=\/[^/\n]*\/)/,contains:[{className:"regexp",begin:/\//,end:/\/[gimuy]*/,illegal:/\n/,contains:[d,{begin:/\[/,end:/\]/,relevance:0,contains:[d]}]}]},Q={className:"title",begin:w,relevance:0},R={className:"title",begin:i,relevance:0},S={begin:"\\.\\s*"+i,relevance:0},T=function(a){return Object.assign(a,{"on:begin":(a,b)=>{b.data._beginMatch=a[1]},"on:end":(b,a)=>{a.data._beginMatch!==b[1]&&a.ignoreMatch()}})},f=Object.freeze({__proto__:null,MATCH_NOTHING_RE:A,IDENT_RE:w,UNDERSCORE_IDENT_RE:i,NUMBER_RE:k,C_NUMBER_RE:y,BINARY_NUMBER_RE:v,RE_STARTERS_RE:B,SHEBANG:z,BACKSLASH_ESCAPE:d,APOS_STRING_MODE:E,QUOTE_STRING_MODE:F,PHRASAL_WORDS_MODE:o,COMMENT:g,C_LINE_COMMENT_MODE:I,C_BLOCK_COMMENT_MODE:J,HASH_COMMENT_MODE:K,NUMBER_MODE:L,C_NUMBER_MODE:M,BINARY_NUMBER_MODE:N,CSS_NUMBER_MODE:O,REGEXP_MODE:P,TITLE_MODE:Q,UNDERSCORE_TITLE_MODE:R,METHOD_GUARD:S,END_SAME_AS_BEGIN:T});function an(a,b){const c=a.input[a.index-1];c==="."&&b.ignoreMatch()}function am(a,b){if(!b)return;if(!a.beginKeywords)return;a.begin="\\b("+a.beginKeywords.split(" ").join("|")+")(?!\\.)(?=\\b|\\s)",a.__beforeBegin=an,a.keywords=a.keywords||a.beginKeywords,delete a.beginKeywords,a.relevance===void 0&&(a.relevance=0)}function al(a,b){if(!Array.isArray(a.illegal))return;a.illegal=aq(...a.illegal)}function ak(a,b){if(!a.match)return;if(a.begin||a.end)throw new Error("begin & end are not supported with match");a.begin=a.match,delete a.match}function aj(a,b){a.relevance===void 0&&(a.relevance=1)}_=["of","and","for","in","not","or","if","then","parent","list","value"],$="keyword";function aa(a,c,d=$){const b={};return typeof a=="string"?e(d,a.split(" ")):Array.isArray(a)?e(d,a):Object.keys(a).forEach(function(d){Object.assign(b,aa(a[d],c,d))}),b;function e(d,a){c&&(a=a.map(a=>a.toLowerCase())),a.forEach(function(c){const a=c.split("|");b[a[0]]=[d,ag(a[0],a[1])]})}}function ag(b,a){return a?Number(a):ae(b)?0:1}function ae(a){return _.includes(a.toLowerCase())}function ad(a,{plugins:i}){function c(b,c){return new RegExp(e(b),"m"+(a.case_insensitive?"i":"")+(c?"g":""))}class f{constructor(){this.matchIndexes={},this.regexes=[],this.matchAt=1,this.position=0}addRule(b,a){a.position=this.position++,this.matchIndexes[this.matchAt]=a,this.regexes.push([a,b]),this.matchAt+=ap(b)+1}compile(){this.regexes.length===0&&(this.exec=()=>null);const a=this.regexes.map(a=>a[1]);this.matcherRe=c(ao(a),!0),this.lastIndex=0}exec(c){this.matcherRe.lastIndex=this.lastIndex;const a=this.matcherRe.exec(c);if(!a)return null;const b=a.findIndex((a,b)=>b>0&&a!==void 0),d=this.matchIndexes[b];return a.splice(0,b),Object.assign(a,d)}}class g{constructor(){this.rules=[],this.multiRegexes=[],this.count=0,this.lastIndex=0,this.regexIndex=0}getMatcher(a){if(this.multiRegexes[a])return this.multiRegexes[a];const b=new f;return this.rules.slice(a).forEach(([a,c])=>b.addRule(a,c)),b.compile(),this.multiRegexes[a]=b,b}resumingScanAtSamePosition(){return this.regexIndex!==0}considerAll(){this.regexIndex=0}addRule(b,a){this.rules.push([b,a]),a.type==="begin"&&this.count++}exec(b){const c=this.getMatcher(this.regexIndex);c.lastIndex=this.lastIndex;let a=c.exec(b);if(this.resumingScanAtSamePosition())if(a&&a.index===this.lastIndex);else{const c=this.getMatcher(0);c.lastIndex=this.lastIndex+1,a=c.exec(b)}return a&&(this.regexIndex+=a.position+1,this.regexIndex===this.count&&this.considerAll()),a}}function h(a){const b=new g;return a.contains.forEach(a=>b.addRule(a.begin,{rule:a,type:"begin"})),a.terminatorEnd&&b.addRule(a.terminatorEnd,{type:"end"}),a.illegal&&b.addRule(a.illegal,{type:"illegal"}),b}function d(b,g){const f=b;if(b.isCompiled)return f;[ak].forEach(a=>a(b,g)),a.compilerExtensions.forEach(a=>a(b,g)),b.__beforeBegin=null,[am,al,aj].forEach(a=>a(b,g)),b.isCompiled=!0;let i=null;if(typeof b.keywords=="object"&&(i=b.keywords.$pattern,delete b.keywords.$pattern),b.keywords&&(b.keywords=aa(b.keywords,a.case_insensitive)),b.lexemes&&i)throw new Error("ERR: Prefer `keywords.$pattern` to `mode.lexemes`, BOTH are not allowed. (see mode reference) ");return i=i||b.lexemes||/\w+/,f.keywordPatternRe=c(i,!0),g&&(b.begin||(b.begin=/\B|\b/),f.beginRe=c(b.begin),b.endSameAsBegin&&(b.end=b.begin),!b.end&&!b.endsWithParent&&(b.end=/\B|\b/),b.end&&(f.endRe=c(b.end)),f.terminatorEnd=e(b.end)||"",b.endsWithParent&&g.terminatorEnd&&(f.terminatorEnd+=(b.end?"|":"")+g.terminatorEnd)),b.illegal&&(f.illegalRe=c(b.illegal)),b.contains||(b.contains=[]),b.contains=[].concat(...b.contains.map(function(a){return af(a==="self"?b:a)})),b.contains.forEach(function(a){d(a,f)}),b.starts&&d(b.starts,g),f.matcher=h(f),f}if(a.compilerExtensions||(a.compilerExtensions=[]),a.contains&&a.contains.includes("self"))throw new Error("ERR: contains `self` is not supported at the top-level of a language. See documentation.");return a.classNameAliases=b(a.classNameAliases||{}),d(a)}function G(a){return!!a&&(a.endsWithParent||G(a.starts))}function af(a){return a.variants&&!a.cachedVariants&&(a.cachedVariants=a.variants.map(function(c){return b(a,{variants:null},c)})),a.cachedVariants?a.cachedVariants:G(a)?b(a,{starts:a.starts?b(a.starts):null}):Object.isFrozen(a)?b(a):a}ab="10.7.2";function ah(a){return Boolean(a||a==="")}function ai(a){const b={props:["language","code","autodetect"],data:function(){return{detectedLanguage:"",unknownLanguage:!1}},computed:{className(){return this.unknownLanguage?"":"hljs "+this.detectedLanguage},highlighted(){if(!this.autoDetect&&!a.getLanguage(this.language))return console.warn(`The language "${this.language}" you specified could not be found.`),this.unknownLanguage=!0,c(this.code);let b={};return this.autoDetect?(b=a.highlightAuto(this.code),this.detectedLanguage=b.language):(b=a.highlight(this.language,this.code,this.ignoreIllegals),this.detectedLanguage=this.language),b.value},autoDetect(){return!this.language||ah(this.autodetect)},ignoreIllegals(){return!0}},render(a){return a("pre",{},[a("code",{class:this.className,domProps:{innerHTML:this.highlighted}})])}},d={install(a){a.component("highlightjs",b)}};return{Component:b,VuePlugin:d}}Z={"after:highlightElement":({el:d,result:a,text:e})=>{const b=X(d);if(!b.length)return;const c=document.createElement("div");c.innerHTML=a.value,a.value=av(b,X(c),e)}};function s(a){return a.nodeName.toLowerCase()}function X(b){const a=[];return function c(d,b){for(let e=d.firstChild;e;e=e.nextSibling)e.nodeType===3?b+=e.nodeValue.length:e.nodeType===1&&(a.push({event:"start",offset:b,node:e}),b=c(e,b),s(e).match(/br|hr|img|input/)||a.push({event:"stop",offset:b,node:e}));return b}(b,0),a}function av(a,b,g){let d=0,e="";const f=[];function h(){return!a.length||!b.length?a.length?a:b:a[0].offset!==b[0].offset?a[0].offset"}function j(a){e+=""}function k(a){(a.event==="start"?i:j)(a.node)}while(a.length||b.length){let b=h();if(e+=c(g.substring(d,b[0].offset)),d=b[0].offset,b===a){f.reverse().forEach(j);do k(b.splice(0,1)[0]),b=h();while(b===a&&b.length&&b[0].offset===d)f.reverse().forEach(i)}else b[0].event==="start"?f.push(b[0].node):f.pop(),k(b.splice(0,1)[0])}return e+c(g.substr(d))}p={},h=a=>{console.error(a)},r=(a,...b)=>{console.log(`WARN: ${a}`,...b)},a=(a,b)=>{if(p[`${a}/${b}`])return;console.log(`Deprecated as of ${a}. ${b}`),p[`${a}/${b}`]=!0},j=c,n=b,x=Symbol("nomatch"),D=function(c){const e=Object.create(null),g=Object.create(null),o=[];let i=!0;const U=/(^(<[^>]+>|\t|)+|\n)/gm,v="Could not find the language '{}', did you forget to load/include a language module?",y={disableAutodetect:!0,name:"Plain text",contains:[]};let b={noHighlightRe:/^(no-?highlight)$/i,languageDetectRe:/\blang(?:uage)?-([\w-]+)\b/i,classPrefix:"hljs-",tabReplace:null,useBR:!1,languages:null,__emitter:H};function z(a){return b.noHighlightRe.test(a)}function R(a){let e=a.className+" ";e+=a.parentNode?a.parentNode.className:"";const c=b.languageDetectRe.exec(e);if(c){const b=d(c[1]);return b||(r(v.replace("{}",c[1])),r("Falling back to no-highlight mode for this block.",a)),b?c[1]:"no-highlight"}return e.split(/\s+/).find(a=>z(a)||d(a))}function B(i,c,g,h){let d="",e="";typeof c=="object"?(d=i,g=c.ignoreIllegals,e=c.language,h=void 0):(a("10.7.0","highlight(lang, code, ...args) has been deprecated."),a("10.7.0","Please use highlight(code, options) instead.\nhttps://github.com/highlightjs/highlight.js/issues/2277"),e=i,d=c);const b={code:d,language:e};k("before:highlight",b);const f=b.result?b.result:s(b.language,b.code,g,h);return f.code=b.code,k("after:highlight",f),f}function s(n,g,L,K){function J(a,b){const c=l.case_insensitive?b[0].toLowerCase():b[0];return Object.prototype.hasOwnProperty.call(a.keywords,c)&&a.keywords[c]}function I(){if(!a.keywords){f.addText(c);return}let e=0;a.keywordPatternRe.lastIndex=0;let b=a.keywordPatternRe.exec(c),d="";while(b){d+=c.substring(e,b.index);const g=J(a,b);if(g){const[a,c]=g;if(f.addText(d),d="",p+=c,a.startsWith("_"))d+=b[0];else{const c=l.classNameAliases[a]||a;f.addKeyword(b[0],c)}}else d+=b[0];e=a.keywordPatternRe.lastIndex,b=a.keywordPatternRe.exec(c)}d+=c.substr(e),f.addText(d)}function H(){if(c==="")return;let b=null;if(typeof a.subLanguage=="string"){if(!e[a.subLanguage]){f.addText(c);return}b=s(a.subLanguage,c,!0,A[a.subLanguage]),A[a.subLanguage]=b.top}else b=m(c,a.subLanguage.length?a.subLanguage:null);a.relevance>0&&(p+=b.relevance),f.addSublanguage(b.emitter,b.language)}function t(){a.subLanguage!=null?H():I(),c=""}function C(b){return b.className&&f.openNode(l.classNameAliases[b.className]||b.className),a=Object.create(b,{parent:{value:a}}),a}function z(a,c,d){let b=ac(a.endRe,d);if(b){if(a["on:end"]){const d=new q(a);a["on:end"](c,d),d.isMatchIgnored&&(b=!1)}if(b){while(a.endsParent&&a.parent)a=a.parent;return a}}if(a.endsWithParent)return z(a.parent,c,d)}function F(b){return a.matcher.regexIndex===0?(c+=b[0],1):(y=!0,0)}function G(d){const b=d[0],a=d.rule,e=new q(a),f=[a.__beforeBegin,a["on:begin"]];for(const a of f){if(!a)continue;if(a(d,e),e.isMatchIgnored)return F(b)}return a&&a.endSameAsBegin&&(a.endRe=at(b)),a.skip?c+=b:(a.excludeBegin&&(c+=b),t(),!a.returnBegin&&!a.excludeBegin&&(c=b)),C(a),a.returnBegin?0:b.length}function D(h){const e=h[0],i=g.substr(h.index),b=z(a,h,i);if(!b)return x;const d=a;d.skip?c+=e:(d.returnEnd||d.excludeEnd||(c+=e),t(),d.excludeEnd&&(c=e));do a.className&&f.closeNode(),!a.skip&&!a.subLanguage&&(p+=a.relevance),a=a.parent;while(a!==b.parent)return b.starts&&(b.endSameAsBegin&&(b.starts.endRe=b.endRe),C(b.starts)),d.returnEnd?0:e.length}function M(){const b=[];for(let c=a;c!==l;c=c.parent)c.className&&b.unshift(c.className);b.forEach(a=>f.openNode(a))}let r={};function B(e,b){const d=b&&b[0];if(c+=e,d==null)return t(),0;if(r.type==="begin"&&b.type==="end"&&r.index===b.index&&d===""){if(c+=g.slice(b.index,b.index+1),!i){const a=new Error("0 width match regex");throw a.languageName=n,a.badRule=r.rule,a}return 1}if(r=b,b.type==="begin")return G(b);if(b.type==="illegal"&&!L){const b=new Error('Illegal lexeme "'+d+'" for mode "'+(a.className||"")+'"');throw b.mode=a,b}if(b.type==="end"){const a=D(b);if(a!==x)return a}if(b.type==="illegal"&&d==="")return 1;if(u>1e5&&u>b.index*3){const a=new Error("potential infinite loop, way more iterations than matches");throw a}return c+=d,d.length}const l=d(n);if(!l)throw h(v.replace("{}",n)),new Error('Unknown language: "'+n+'"');const E=ad(l,{plugins:o});let w="",a=K||E;const A={},f=new b.__emitter(b);M();let c="",p=0,k=0,u=0,y=!1;try{for(a.matcher.considerAll();;){u++,y?y=!1:a.matcher.considerAll(),a.matcher.lastIndex=k;const b=a.matcher.exec(g);if(!b)break;const c=g.substring(k,b.index),d=B(c,b);k=b.index+d}return B(g.substr(k)),f.closeAllNodes(),f.finalize(),w=f.toHTML(),{relevance:Math.floor(p),value:w,language:n,illegal:!1,emitter:f,top:a}}catch(b){if(b.message&&b.message.includes("Illegal"))return{illegal:!0,illegalBy:{msg:b.message,context:g.slice(k-100,k+100),mode:b.mode},sofar:w,relevance:0,value:j(g),emitter:f};if(i)return{illegal:!1,relevance:0,value:j(g),emitter:f,language:n,top:a,errorRaised:b};throw b}}function Q(a){const c={relevance:0,emitter:new b.__emitter(b),value:j(a),illegal:!1,top:y};return c.emitter.addText(a),c}function m(c,a){a=a||b.languages||Object.keys(e);const h=Q(c),f=a.filter(d).filter(C).map(a=>s(a,c,!1));f.unshift(h);const i=f.sort((a,b)=>{if(a.relevance!==b.relevance)return b.relevance-a.relevance;if(a.language&&b.language){if(d(a.language).supersetOf===b.language)return 1;if(d(b.language).supersetOf===a.language)return-1}return 0}),[j,k]=i,g=j;return g.second_best=k,g}function P(a){return b.tabReplace||b.useBR?a.replace(U,a=>{return a==="\n"?b.useBR?"
    ":a:b.tabReplace?a.replace(/\t/g,b.tabReplace):a}):a}function J(a,b,d){const c=b?g[b]:d;a.classList.add("hljs"),c&&a.classList.add(c)}const I={"before:highlightElement":({el:a})=>{b.useBR&&(a.innerHTML=a.innerHTML.replace(/\n/g,"").replace(//g,"\n"))},"after:highlightElement":({result:a})=>{b.useBR&&(a.value=a.value.replace(/\n/g,"
    "))}},F=/^(<[^>]+>|\t)+/gm,D={"after:highlightElement":({result:a})=>{b.tabReplace&&(a.value=a.value.replace(F,a=>a.replace(/\t/g,b.tabReplace)))}};function l(b){let e=null;const c=R(b);if(z(c))return;k("before:highlightElement",{el:b,language:c}),e=b;const d=e.textContent,a=c?B(d,{language:c,ignoreIllegals:!0}):m(d);k("after:highlightElement",{el:b,result:a,text:d}),b.innerHTML=a.value,J(b,c,a.language),b.result={language:a.language,re:a.relevance,relavance:a.relevance},a.second_best&&(b.second_best={language:a.second_best.language,re:a.second_best.relevance,relavance:a.second_best.relevance})}function E(c){c.useBR&&(a("10.3.0","'useBR' will be removed entirely in v11.0"),a("10.3.0","Please see https://github.com/highlightjs/highlight.js/issues/2559")),b=n(b,c)}const u=()=>{if(u.called)return;u.called=!0,a("10.6.0","initHighlighting() is deprecated. Use highlightAll() instead.");const b=document.querySelectorAll("pre code");b.forEach(l)};function G(){a("10.6.0","initHighlightingOnLoad() is deprecated. Use highlightAll() instead."),p=!0}let p=!1;function A(){if(document.readyState==="loading"){p=!0;return}const a=document.querySelectorAll("pre code");a.forEach(l)}function K(){p&&A()}typeof window!="undefined"&&window.addEventListener&&window.addEventListener("DOMContentLoaded",K,!1);function L(b,d){let a=null;try{a=d(c)}catch(c){if(h("Language definition for '{}' could not be registered.".replace("{}",b)),!i)throw c;h(c),a=y}a.name||(a.name=b),e[b]=a,a.rawDefinition=d.bind(null,c),a.aliases&&w(a.aliases,{languageName:b})}function M(a){delete e[a];for(const b of Object.keys(g))g[b]===a&&delete g[b]}function N(){return Object.keys(e)}function O(b){a("10.4.0","requireLanguage will be removed entirely in v11."),a("10.4.0","Please see https://github.com/highlightjs/highlight.js/pull/2844");const c=d(b);if(c)return c;const e=new Error("The '{}' language is required, but not loaded.".replace("{}",b));throw e}function d(a){return a=(a||"").toLowerCase(),e[a]||e[g[a]]}function w(a,{languageName:b}){typeof a=="string"&&(a=[a]),a.forEach(a=>{g[a.toLowerCase()]=b})}function C(b){const a=d(b);return a&&!a.disableAutodetect}function S(a){a["before:highlightBlock"]&&!a["before:highlightElement"]&&(a["before:highlightElement"]=b=>{a["before:highlightBlock"](Object.assign({block:b.el},b))}),a["after:highlightBlock"]&&!a["after:highlightElement"]&&(a["after:highlightElement"]=b=>{a["after:highlightBlock"](Object.assign({block:b.el},b))})}function T(a){S(a),o.push(a)}function k(b,c){const a=b;o.forEach(function(b){b[a]&&b[a](c)})}function V(b){return a("10.2.0","fixMarkup will be removed entirely in v11.0"),a("10.2.0","Please see https://github.com/highlightjs/highlight.js/issues/2534"),P(b)}function W(b){return a("10.7.0","highlightBlock will be removed entirely in v12.0"),a("10.7.0","Please use highlightElement now."),l(b)}Object.assign(c,{highlight:B,highlightAuto:m,highlightAll:A,fixMarkup:V,highlightElement:l,highlightBlock:W,configure:E,initHighlighting:u,initHighlightingOnLoad:G,registerLanguage:L,unregisterLanguage:M,listLanguages:N,getLanguage:d,registerAliases:w,requireLanguage:O,autoDetection:C,inherit:n,addPlugin:T,vuePlugin:ai(c).VuePlugin}),c.debugMode=function(){i=!1},c.safeMode=function(){i=!0},c.versionString=ab;for(const a in f)typeof f[a]=="object"&&t(f[a]);return Object.assign(c,f),c.addPlugin(I),c.addPlugin(Z),c.addPlugin(D),c},W=D({}),au.exports=W}),l=b((n,m)=>{var c="[A-Za-z$_][0-9A-Za-z$_]*",l=["as","in","of","if","for","while","finally","var","new","function","do","return","void","else","break","catch","instanceof","with","throw","case","default","try","switch","continue","typeof","delete","let","yield","const","class","debugger","async","await","static","import","from","export","extends"],e=["true","false","null","undefined","NaN","Infinity"],f=["Intl","DataView","Number","Math","Date","String","RegExp","Object","Function","Boolean","Error","Symbol","Set","Map","WeakSet","WeakMap","Proxy","Reflect","JSON","Promise","Float64Array","Int16Array","Int32Array","Int8Array","Uint16Array","Uint32Array","Float32Array","Array","Uint8Array","Uint8ClampedArray","ArrayBuffer","BigInt64Array","BigUint64Array","BigInt"],g=["EvalError","InternalError","RangeError","ReferenceError","SyntaxError","TypeError","URIError"],h=["setInterval","setTimeout","clearInterval","clearTimeout","require","exports","eval","isFinite","isNaN","parseFloat","parseInt","decodeURI","decodeURIComponent","encodeURI","encodeURIComponent","escape","unescape"],i=["arguments","this","super","console","window","document","localStorage","module","global"],j=[].concat(h,i,f,g);function k(a){return a?typeof a=="string"?a:a.source:null}function b(b){return a("(?=",b,")")}function a(...a){const b=a.map(a=>k(a)).join("");return b}function d(d){const z=(a,{after:b})=>{const c="",end:""},h={begin:/<[A-Za-z0-9\\._:-]+/,end:/\/[A-Za-z0-9\\._:-]+>|\/>/,isTrulyOpeningTag:(a,b)=>{const c=a[0].length+a.index,d=a.input[c];if(d==="<"){b.ignoreMatch();return}d===">"&&(z(a,{after:c})||b.ignoreMatch())}},g={$pattern:c,keyword:l,literal:e,built_in:j},v="[0-9](_?[0-9])*",k=`\\.(${v})`,s=`0|[1-9](_?[0-9])*|0[0-7]*[89][0-9]*`,q={className:"number",variants:[{begin:`(\\b(${s})((${k})|\\.)?|(${k}))[eE][+-]?(${v})\\b`},{begin:`\\b(${s})\\b((${k})\\b|\\.)?|(${k})\\b`},{begin:`\\b(0|[1-9](_?[0-9])*)n\\b`},{begin:"\\b0[xX][0-9a-fA-F](_?[0-9a-fA-F])*n?\\b"},{begin:"\\b0[bB][0-1](_?[0-1])*n?\\b"},{begin:"\\b0[oO][0-7](_?[0-7])*n?\\b"},{begin:"\\b0[0-7]+n?\\b"}],relevance:0},i={className:"subst",begin:"\\$\\{",end:"\\}",keywords:g,contains:[]},r={begin:"html`",end:"",starts:{end:"`",returnEnd:!1,contains:[d.BACKSLASH_ESCAPE,i],subLanguage:"xml"}},p={begin:"css`",end:"",starts:{end:"`",returnEnd:!1,contains:[d.BACKSLASH_ESCAPE,i],subLanguage:"css"}},t={className:"string",begin:"`",end:"`",contains:[d.BACKSLASH_ESCAPE,i]},y=d.COMMENT(/\/\*\*(?!\/)/,"\\*/",{relevance:0,contains:[{className:"doctag",begin:"@[A-Za-z]+",contains:[{className:"type",begin:"\\{",end:"\\}",relevance:0},{className:"variable",begin:f+"(?=\\s*(-)|$)",endsParent:!0,relevance:0},{begin:/(?=[^\n])\s/,relevance:0}]}]}),o={className:"comment",variants:[y,d.C_BLOCK_COMMENT_MODE,d.C_LINE_COMMENT_MODE]},w=[d.APOS_STRING_MODE,d.QUOTE_STRING_MODE,r,p,t,q,d.REGEXP_MODE];i.contains=w.concat({begin:/\{/,end:/\}/,keywords:g,contains:["self"].concat(w)});const u=[].concat(o,i.contains),n=u.concat([{begin:/\(/,end:/\)/,keywords:g,contains:["self"].concat(u)}]),m={className:"params",begin:/\(/,end:/\)/,excludeBegin:!0,excludeEnd:!0,keywords:g,contains:n};return{name:"Javascript",aliases:["js","jsx","mjs","cjs"],keywords:g,exports:{PARAMS_CONTAINS:n},illegal:/#(?![$_A-z])/,contains:[d.SHEBANG({label:"shebang",binary:"node",relevance:5}),{label:"use_strict",className:"meta",relevance:10,begin:/^\s*['"]use (strict|asm)['"]/},d.APOS_STRING_MODE,d.QUOTE_STRING_MODE,r,p,t,o,q,{begin:a(/[{,\n]\s*/,b(a(/(((\/\/.*$)|(\/\*(\*[^/]|[^*])*\*\/))\s*)*/,f+"\\s*:"))),relevance:0,contains:[{className:"attr",begin:f+b("\\s*:"),relevance:0}]},{begin:"("+d.RE_STARTERS_RE+"|\\b(case|return|throw)\\b)\\s*",keywords:"return throw case",contains:[o,d.REGEXP_MODE,{className:"function",begin:"(\\([^()]*(\\([^()]*(\\([^()]*\\)[^()]*)*\\)[^()]*)*\\)|"+d.UNDERSCORE_IDENT_RE+")\\s*=>",returnBegin:!0,end:"\\s*=>",contains:[{className:"params",variants:[{begin:d.UNDERSCORE_IDENT_RE,relevance:0},{className:null,begin:/\(\s*\)/,skip:!0},{begin:/\(/,end:/\)/,excludeBegin:!0,excludeEnd:!0,keywords:g,contains:n}]}]},{begin:/,/,relevance:0},{className:"",begin:/\s/,end:/\s*/,skip:!0},{variants:[{begin:x.begin,end:x.end},{begin:h.begin,"on:begin":h.isTrulyOpeningTag,end:h.end}],subLanguage:"xml",contains:[{begin:h.begin,end:h.end,skip:!0,contains:["self"]}]}],relevance:0},{className:"function",beginKeywords:"function",end:/[{;]/,excludeEnd:!0,keywords:g,contains:["self",d.inherit(d.TITLE_MODE,{begin:f}),m],illegal:/%/},{beginKeywords:"while if switch catch for"},{className:"function",begin:d.UNDERSCORE_IDENT_RE+"\\([^()]*(\\([^()]*(\\([^()]*\\)[^()]*)*\\)[^()]*)*\\)\\s*\\{",returnBegin:!0,contains:[m,d.inherit(d.TITLE_MODE,{begin:f})]},{variants:[{begin:"\\."+f},{begin:"\\$"+f}],relevance:0},{className:"class",beginKeywords:"class",end:/[{;=]/,excludeEnd:!0,illegal:/[:"[\]]/,contains:[{beginKeywords:"extends"},d.UNDERSCORE_TITLE_MODE]},{begin:/\b(?=constructor)/,end:/[{;]/,excludeEnd:!0,contains:[d.inherit(d.TITLE_MODE,{begin:f}),"self",m]},{begin:"(get|set)\\s+(?="+f+"\\()",end:/\{/,keywords:"get set",contains:[d.inherit(d.TITLE_MODE,{begin:f}),{begin:/\(\)/},m]},{begin:/\$[(.]/}]}}m.exports=d}),m=b((c,a)=>{function b(a){const c={literal:"true false null"},d=[a.C_LINE_COMMENT_MODE,a.C_BLOCK_COMMENT_MODE],b=[a.QUOTE_STRING_MODE,a.C_NUMBER_MODE],e={end:",",endsWithParent:!0,excludeEnd:!0,contains:b,keywords:c},f={begin:/\{/,end:/\}/,contains:[{className:"attr",begin:/"/,end:/"/,contains:[a.BACKSLASH_ESCAPE],illegal:"\\n"},a.inherit(e,{begin:/:/})].concat(d),illegal:"\\S"},g={begin:"\\[",end:"\\]",contains:[a.inherit(e)],illegal:"\\S"};return b.push(f,g),d.forEach(function(a){b.push(a)}),{name:"JSON",contains:b,keywords:c,illegal:"\\S"}}a.exports=b}),n=b((e,a)=>{function b(a){return a?typeof a=="string"?a:a.source:null}function c(...a){const c=a.map(a=>b(a)).join("");return c}function d(a){const b={},f={begin:/\$\{/,end:/\}/,contains:["self",{begin:/:-/,contains:[b]}]};Object.assign(b,{className:"variable",variants:[{begin:c(/\$[\w\d#@][\w\d_]*/,`(?![\\w\\d])(?![$])`)},f]});const d={className:"subst",begin:/\$\(/,end:/\)/,contains:[a.BACKSLASH_ESCAPE]},g={begin:/<<-?\s*(?=\w+)/,starts:{contains:[a.END_SAME_AS_BEGIN({begin:/(\w+)/,end:/(\w+)/,className:"string"})]}},e={className:"string",begin:/"/,end:/"/,contains:[a.BACKSLASH_ESCAPE,b,d]};d.contains.push(e);const h={className:"",begin:/\\"/},i={className:"string",begin:/'/,end:/'/},j={begin:/\$\(\(/,end:/\)\)/,contains:[{begin:/\d+#[0-9a-f]+/,className:"number"},a.NUMBER_MODE,b]},k=["fish","bash","zsh","sh","csh","ksh","tcsh","dash","scsh"],l=a.SHEBANG({binary:`(${k.join("|")})`,relevance:10}),m={className:"function",begin:/\w[\w\d_]*\s*\(\s*\)\s*\{/,returnBegin:!0,contains:[a.inherit(a.TITLE_MODE,{begin:/\w[\w\d_]*/})],relevance:0};return{name:"Bash",aliases:["sh","zsh"],keywords:{$pattern:/\b[a-z._-]+\b/,keyword:"if then else elif fi for while in do done case esac function",literal:"true false",built_in:"break cd continue eval exec exit export getopts hash pwd readonly return shift test times trap umask unset alias bind builtin caller command declare echo enable help let local logout mapfile printf read readarray source type typeset ulimit unalias set shopt autoload bg bindkey bye cap chdir clone comparguments compcall compctl compdescribe compfiles compgroups compquote comptags comptry compvalues dirs disable disown echotc echoti emulate fc fg float functions getcap getln history integer jobs kill limit log noglob popd print pushd pushln rehash sched setcap setopt stat suspend ttyctl unfunction unhash unlimit unsetopt vared wait whence where which zcompile zformat zftp zle zmodload zparseopts zprof zpty zregexparse zsocket zstyle ztcp"},contains:[l,a.SHEBANG(),m,j,a.HASH_COMMENT_MODE,g,e,h,i,b]}}a.exports=d}),o=b((i,d)=>{function b(a){return a?typeof a=="string"?a:a.source:null}function e(b){return a("(",b,")*")}function f(b){return a("(",b,")?")}function a(...a){const c=a.map(a=>b(a)).join("");return c}function c(...a){const c="("+a.map(a=>b(a)).join("|")+")";return c}function g(b){const g={"builtin-name":["action","bindattr","collection","component","concat","debugger","each","each-in","get","hash","if","in","input","link-to","loc","log","lookup","mut","outlet","partial","query-params","render","template","textarea","unbound","unless","view","with","yield"]},q={literal:["true","false","undefined","null"]},y=/""|"[^"]+"/,x=/''|'[^']+'/,p=/\[\]|\[[^\]]+\]/,k=/[^\s!"#%&'()*+,.\/;<=>@\[\\\]^`{|}~]+/,w=/(\.|\/)/,m=c(y,x,p,k),u=a(f(/\.|\.\/|\//),m,e(a(w,m))),r=a("(",p,"|",k,")(?==)"),d={begin:u,lexemes:/[\w.\/]+/},j=b.inherit(d,{keywords:q}),i={begin:/\(/,end:/\)/},s={className:"attr",begin:r,relevance:0,starts:{begin:/=/,end:/=/,starts:{contains:[b.NUMBER_MODE,b.QUOTE_STRING_MODE,b.APOS_STRING_MODE,j,i]}}},t={begin:/as\s+\|/,keywords:{keyword:"as"},end:/\|/,contains:[{begin:/\w+/}]},h={contains:[b.NUMBER_MODE,b.QUOTE_STRING_MODE,b.APOS_STRING_MODE,t,s,j,i],returnEnd:!0},v=b.inherit(d,{className:"name",keywords:g,starts:b.inherit(h,{end:/\)/})});i.contains=[v];const l=b.inherit(d,{keywords:g,className:"name",starts:b.inherit(h,{end:/\}\}/})}),o=b.inherit(d,{keywords:g,className:"name"}),n=b.inherit(d,{className:"name",keywords:g,starts:b.inherit(h,{end:/\}\}/})}),z={begin:/\\\{\{/,skip:!0},A={begin:/\\\\(?=\{\{)/,skip:!0};return{name:"Handlebars",aliases:["hbs","html.hbs","html.handlebars","htmlbars"],case_insensitive:!0,subLanguage:"xml",contains:[z,A,b.COMMENT(/\{\{!--/,/--\}\}/),b.COMMENT(/\{\{!/,/\}\}/),{className:"template-tag",begin:/\{\{\{\{(?!\/)/,end:/\}\}\}\}/,contains:[l],starts:{end:/\{\{\{\{\//,returnEnd:!0,subLanguage:"xml"}},{className:"template-tag",begin:/\{\{\{\{\//,end:/\}\}\}\}/,contains:[o]},{className:"template-tag",begin:/\{\{#/,end:/\}\}/,contains:[l]},{className:"template-tag",begin:/\{\{(?=else\}\})/,end:/\}\}/,keywords:"else"},{className:"template-tag",begin:/\{\{(?=else if)/,end:/\}\}/,keywords:"else if"},{className:"template-tag",begin:/\{\{\//,end:/\}\}/,contains:[o]},{className:"template-variable",begin:/\{\{\{/,end:/\}\}\}/,contains:[n]},{className:"template-variable",begin:/\{\{/,end:/\}\}/,contains:[n]}]}}function h(b){const a=g(b);return a.name="HTMLbars",b.getLanguage("handlebars")&&(a.disableAutodetect=!0),a}d.exports=h}),p=b((g,d)=>{function a(a){return a?typeof a=="string"?a:a.source:null}function e(a){return b("(?=",a,")")}function b(...b){const c=b.map(b=>a(b)).join("");return c}function f(...b){const c="("+b.map(b=>a(b)).join("|")+")";return c}function c(c){const d={className:"number",relevance:0,variants:[{begin:/([+-]+)?[\d]+_[\d_]+/},{begin:c.NUMBER_RE}]},a=c.COMMENT();a.variants=[{begin:/;/,end:/$/},{begin:/#/,end:/$/}];const g={className:"variable",variants:[{begin:/\$[\w\d"][\w\d_]*/},{begin:/\$\{(.*?)\}/}]},h={className:"literal",begin:/\bon|off|true|false|yes|no\b/},i={className:"string",contains:[c.BACKSLASH_ESCAPE],variants:[{begin:"'''",end:"'''",relevance:10},{begin:'"""',end:'"""',relevance:10},{begin:'"',end:'"'},{begin:"'",end:"'"}]},k={begin:/\[/,end:/\]/,contains:[a,h,g,i,d,"self"],relevance:0},l=/[A-Za-z0-9_-]+/,m=/"(\\"|[^"])*"/,n=/'[^']*'/,j=f(l,m,n),o=b(j,"(\\s*\\.\\s*",j,")*",e(/\s*=\s*[^#\s]/));return{name:"TOML, also INI",aliases:["toml"],case_insensitive:!0,illegal:/\S/,contains:[a,{className:"section",begin:/\[+/,end:/\]+/},{begin:o,className:"attr",starts:{end:/$/,contains:[a,k,h,g,i,d]}}]}}d.exports=c}),q=b((c,a)=>{function b(a){var c="true false yes no null",b="[\\w#;/?:@&=+$,.~*'()[\\]]+",m={className:"attr",variants:[{begin:"\\w[\\w :\\/.-]*:(?=[ ]|$)"},{begin:'"\\w[\\w :\\/.-]*":(?=[ ]|$)'},{begin:"'\\w[\\w :\\/.-]*':(?=[ ]|$)"}]},j={className:"template-variable",variants:[{begin:/\{\{/,end:/\}\}/},{begin:/%\{/,end:/\}/}]},f={className:"string",relevance:0,variants:[{begin:/'/,end:/'/},{begin:/"/,end:/"/},{begin:/\S+/}],contains:[a.BACKSLASH_ESCAPE,j]},h=a.inherit(f,{variants:[{begin:/'/,end:/'/},{begin:/"/,end:/"/},{begin:/[^\s,{}[\]]+/}]}),i="[0-9]{4}(-[0-9][0-9]){0,2}",q="([Tt \\t][0-9][0-9]?(:[0-9][0-9]){2})?",p="(\\.[0-9]*)?",k="([ \\t])*(Z|[-+][0-9][0-9]?(:[0-9][0-9])?)?",l={className:"number",begin:"\\b"+i+q+p+k+"\\b"},d={end:",",endsWithParent:!0,excludeEnd:!0,keywords:c,relevance:0},n={begin:/\{/,end:/\}/,contains:[d],illegal:"\\n",relevance:0},o={begin:"\\[",end:"\\]",contains:[d],illegal:"\\n",relevance:0},g=[m,{className:"meta",begin:"^---\\s*$",relevance:10},{className:"string",begin:"[\\|>]([1-9]?[+-])?[ ]*\\n( +)[^ ][^\\n]*\\n(\\2[^\\n]+\\n?)*"},{begin:"<%[%=-]?",end:"[%-]?%>",subLanguage:"ruby",excludeBegin:!0,excludeEnd:!0,relevance:0},{className:"type",begin:"!\\w+!"+b},{className:"type",begin:"!<"+b+">"},{className:"type",begin:"!"+b},{className:"type",begin:"!!"+b},{className:"meta",begin:"&"+a.UNDERSCORE_IDENT_RE+"$"},{className:"meta",begin:"\\*"+a.UNDERSCORE_IDENT_RE+"$"},{className:"bullet",begin:"-(?=[ ]|$)",relevance:0},a.HASH_COMMENT_MODE,{beginKeywords:c,keywords:{literal:c}},l,{className:"number",begin:a.C_NUMBER_RE+"\\b",relevance:0},n,o,f],e=[...g];return e.pop(),e.push(h),d.contains=e,{name:"YAML",case_insensitive:!0,aliases:["yml"],contains:g}}a.exports=b}),r=b((e,a)=>{function b(a){return a?typeof a=="string"?a:a.source:null}function c(...a){const c=a.map(a=>b(a)).join("");return c}function d(n){const f={begin:/<\/?[A-Za-z_]/,end:">",subLanguage:"xml",relevance:0},l={begin:"^[-\\*]{3,}",end:"$"},k={className:"code",variants:[{begin:"(`{3,})[^`](.|\\n)*?\\1`*[ ]*"},{begin:"(~{3,})[^~](.|\\n)*?\\1~*[ ]*"},{begin:"```",end:"```+[ ]*$"},{begin:"~~~",end:"~~~+[ ]*$"},{begin:"`.+?`"},{begin:"(?=^( {4}|\\t))",contains:[{begin:"^( {4}|\\t)",end:"(\\n)$"}],relevance:0}]},j={className:"bullet",begin:"^[ ]*([*+-]|(\\d+\\.))(?=\\s+)",end:"\\s+",excludeEnd:!0},i={begin:/^\[[^\n]+\]:/,returnBegin:!0,contains:[{className:"symbol",begin:/\[/,end:/\]/,excludeBegin:!0,excludeEnd:!0},{className:"link",begin:/:\s*/,end:/$/,excludeBegin:!0}]},h=/[A-Za-z][A-Za-z0-9+.-]*/,e={variants:[{begin:/\[.+?\]\[.*?\]/,relevance:0},{begin:/\[.+?\]\(((data|javascript|mailto):|(?:http|ftp)s?:\/\/).*?\)/,relevance:2},{begin:c(/\[.+?\]\(/,h,/:\/\/.*?\)/),relevance:2},{begin:/\[.+?\]\([./?&#].*?\)/,relevance:1},{begin:/\[.+?\]\(.*?\)/,relevance:0}],returnBegin:!0,contains:[{className:"string",relevance:0,begin:"\\[",end:"\\]",excludeBegin:!0,returnEnd:!0},{className:"link",relevance:0,begin:"\\]\\(",end:"\\)",excludeBegin:!0,excludeEnd:!0},{className:"symbol",relevance:0,begin:"\\]\\[",end:"\\]",excludeBegin:!0,excludeEnd:!0}]},d={className:"strong",contains:[],variants:[{begin:/_{2}/,end:/_{2}/},{begin:/\*{2}/,end:/\*{2}/}]},b={className:"emphasis",contains:[],variants:[{begin:/\*(?!\*)/,end:/\*/},{begin:/_(?!_)/,end:/_/,relevance:0}]};d.contains.push(b),b.contains.push(d);let a=[f,e];d.contains=d.contains.concat(a),b.contains=b.contains.concat(a),a=a.concat(d,b);const m={className:"section",variants:[{begin:"^#{1,6}",end:"$",contains:a},{begin:"(?=^.+?\\n[=-]{2,}$)",contains:[{begin:"^[=-]*$"},{begin:"^",end:"\\n",contains:a}]}]},g={className:"quote",begin:"^>\\s+",contains:a,end:"$"};return{name:"Markdown",aliases:["md","mkdown","mkd"],contains:[m,f,j,d,b,g,k,l,e,i]}}a.exports=d}),a=c(k()),t=c(l()),u=c(m()),v=c(n()),w=c(o()),e=c(p()),y=c(q()),z=c(r());a.default.registerLanguage("javascript",t.default),a.default.registerLanguage("json",u.default),a.default.registerLanguage("bash",v.default),a.default.registerLanguage("html",w.default),a.default.registerLanguage("ini",e.default),a.default.registerLanguage("toml",e.default),a.default.registerLanguage("yaml",y.default),a.default.registerLanguage("md",z.default),document.addEventListener("DOMContentLoaded",()=>{document.querySelectorAll("pre code").forEach(b=>{a.default.highlightElement(b)})})})() \ No newline at end of file diff --git a/opensource/contribute/index.html b/opensource/contribute/index.html index 42c1868..bae1f38 100644 --- a/opensource/contribute/index.html +++ b/opensource/contribute/index.html @@ -1,8 +1,8 @@ -Contribute - Kerberos Docs
    - +Contribute - Kerberos Docs
    + Kerberos Docs

    Contribute

    We are backed up by an amazing community. Feel free the help.

    In this document we describe the different things you need to know if you would like to add a new feature to Kerberos Open Source, or change some of its behaviour for your own use case.

    Before starting, as you might have read already, you need to know that Kerberos Open Source consists of two solutions. A front-end, also called web, which allows you to review the recordings and to configure the back-end settings. A back-end, also called machinery, which is computer vision solution that processes the video stream of surveillance camera.

    Once you start changing or adding features to Kerberos Open Source, there is a big chance you will need to modify the previously mentioned solutions. That’s why we will discuss how you can contribute to one or both solutions.

    Machinery

    Contributing to the machinery repository requires C++ skills. This section describes all the technical stuff you will need to know. If you want to contribute, the first thing you will need to do is installing the source code on your working station.

    Prerequisites

    A Linux OS, or Mac OSX (Window is not supported).

    Installation

    The complete installation can be found on the advanced installation page, describing the complete set of instructions. However for simplicity we will give a summarized version, as probably you will already have a development environment set up.

    Install development tools (C++, CMake) and V4L utils, and clone the repository. Compile the project using cmake and make.

    sudo apt-get -y update
+

    Contribute

    We are backed up by an amazing community. Feel free the help.

    In this document we describe the different things you need to know if you would like to add a new feature to Kerberos Open Source, or change some of its behaviour for your own use case.

    Before starting, as you might have read already, you need to know that Kerberos Open Source consists of two solutions. A front-end, also called web, which allows you to review the recordings and to configure the back-end settings. A back-end, also called machinery, which is computer vision solution that processes the video stream of surveillance camera.

    Once you start changing or adding features to Kerberos Open Source, there is a big chance you will need to modify the previously mentioned solutions. That’s why we will discuss how you can contribute to one or both solutions.

    Machinery

    Contributing to the machinery repository requires C++ skills. This section describes all the technical stuff you will need to know. If you want to contribute, the first thing you will need to do is installing the source code on your working station.

    Prerequisites

    A Linux OS, or Mac OSX (Window is not supported).

    Installation

    The complete installation can be found on the advanced installation page, describing the complete set of instructions. However for simplicity we will give a summarized version, as probably you will already have a development environment set up.

    Install development tools (C++, CMake) and V4L utils, and clone the repository. Compile the project using cmake and make.

    sudo apt-get -y update
 sudo apt-get install -y git cmake subversion dh-autoreconf libcurl4-openssl-dev yasm libx264-dev pkg-config libssl-dev
 cd && sudo git clone https://github.com/kerberos-io/machinery
 cd machinery && mkdir build && cd build
@@ -101,5 +101,5 @@ php -r "unlink('composer-setup.php');"

    Besides PHP, the project also relies on BackboneJS (Javascript) for the front-end. Therefore a couple JavaScript dependencies should be installed.

    npm -g install bower
 cd public
 bower update
-

    When everything is installed properly, you need too link the web project with your applicationn server. Read more on the Laravel documentation website.

    Edit this page on GitHub

    ← Upgrade
    Machinery →
    \ No newline at end of file +

    When everything is installed properly, you need too link the web project with your applicationn server. Read more on the Laravel documentation website.

    Edit this page on GitHub

    ← Upgrade
    Machinery →
    \ No newline at end of file diff --git a/opensource/first-things-first/index.html b/opensource/first-things-first/index.html index fc696a0..804ac73 100644 --- a/opensource/first-things-first/index.html +++ b/opensource/first-things-first/index.html @@ -1,7 +1,7 @@ -First things first - Kerberos Docs
    - +First things first - Kerberos Docs
    + Kerberos Docs

    First things first

    The Kerberos Open Source agent a low budget but delightful VMS.

    Kerberos started as an Open Source project back in 2014. Our main goal was, and still is, to provide everyone in this world with a free, professional and complete video surveillance system, which they can install in a couple of minutes. -Kerberos was initially developed for the Raspberry Pi, due to this many of the tools we have been using are lightweight and fast (such as C++). Over the years we have found other ways to make Kerberos available, such as KiOS (our custom Linux), Docker and Kubernetes.

    In this section we want to make clear what the Open Source version of Kerberos is about, and when you should be using it. What it can do, and what it can’t do.

    License

    The Kerberos Open Source project is licensed with BY-NC-SA 4.0, this means that everyone can use Kerberos and modify if to their needs, in a non commercial activity.

    When using the Open Source version

    Kerberos Open Source is perfect for personal usage. It’s great if you only have a couple of surveillance cameras to be managed. A Kerberos agent (e.g. on a Raspberry Pi or inside a Docker container) runs for each camera. Their are many different installation possibilities, please have a look at the architecture or installation page.

    Every Kerberos agent has it’s own web interface (front-end) to review media recording, and processing engine (back-end) of a specific surveillance camera. The Open Source version doesn’t come with a central overview of all recordings generated by your Kerberos agents. For this feature we highly recommend Kerberos cloud.

    If you want to manage more than 10 Kerberos agents, it’s recommended to use Kerberos Enterprise. This will help you to scale, support high availability and load balancing. Check out the architectures section for a better understanding of when to use what.

    How to install

    A Kerberos Open Source agent can be installed in different ways. Every installation method have their own advantages and disadvantages. Depending on the usecase you could choose one method over the other. Read more on the installation section, to learn about the different installation methods.

    1. KiOS: You have a Raspberry Pi, and you only want to run the Kerberos agent on it.
    2. Raspbian: You have a Raspberry Pi, but you want other services running next to your Kerberos agent.
    3. Docker: You have a lot of IP cameras, and/or don’t want to mess with dependencies.
    4. Generic: You want to develop/extend Kerberos Open Source with your own features, or you want to run the Kerberos agent on a not supported OS/architecure.

    Edit this page on GitHub

    Get started →
    \ No newline at end of file +

    First things first

    The Kerberos Open Source agent a low budget but delightful VMS.

    Kerberos started as an Open Source project back in 2014. Our main goal was, and still is, to provide everyone in this world with a free, professional and complete video surveillance system, which they can install in a couple of minutes. +Kerberos was initially developed for the Raspberry Pi, due to this many of the tools we have been using are lightweight and fast (such as C++). Over the years we have found other ways to make Kerberos available, such as KiOS (our custom Linux), Docker and Kubernetes.

    In this section we want to make clear what the Open Source version of Kerberos is about, and when you should be using it. What it can do, and what it can’t do.

    License

    The Kerberos Open Source project is licensed with BY-NC-SA 4.0, this means that everyone can use Kerberos and modify if to their needs, in a non commercial activity.

    When using the Open Source version

    Kerberos Open Source is perfect for personal usage. It’s great if you only have a couple of surveillance cameras to be managed. A Kerberos agent (e.g. on a Raspberry Pi or inside a Docker container) runs for each camera. Their are many different installation possibilities, please have a look at the architecture or installation page.

    Every Kerberos agent has it’s own web interface (front-end) to review media recording, and processing engine (back-end) of a specific surveillance camera. The Open Source version doesn’t come with a central overview of all recordings generated by your Kerberos agents. For this feature we highly recommend Kerberos cloud.

    If you want to manage more than 10 Kerberos agents, it’s recommended to use Kerberos Enterprise. This will help you to scale, support high availability and load balancing. Check out the architectures section for a better understanding of when to use what.

    How to install

    A Kerberos Open Source agent can be installed in different ways. Every installation method have their own advantages and disadvantages. Depending on the usecase you could choose one method over the other. Read more on the installation section, to learn about the different installation methods.

    1. KiOS: You have a Raspberry Pi, and you only want to run the Kerberos agent on it.
    2. Raspbian: You have a Raspberry Pi, but you want other services running next to your Kerberos agent.
    3. Docker: You have a lot of IP cameras, and/or don’t want to mess with dependencies.
    4. Generic: You want to develop/extend Kerberos Open Source with your own features, or you want to run the Kerberos agent on a not supported OS/architecure.

    Edit this page on GitHub

    Get started →
    \ No newline at end of file diff --git a/opensource/get-started/index.html b/opensource/get-started/index.html index d9f8299..0c61838 100644 --- a/opensource/get-started/index.html +++ b/opensource/get-started/index.html @@ -1,6 +1,6 @@ -Get started - Kerberos Docs
    - +Get started - Kerberos Docs
    + Kerberos Docs

    Get started

    What to expect from the Kerberos Open Source agent.

    Once you’ve installed Kerberos Open Source, you will have access to the web application. This web application allows you to administrate the machinery.

    Welcome page

    The first time you open a browser, and navigate to the web application (ip address of your device), you will land on the welcome page. This page will guide you through some basic steps and set simple configurations such as username and password.

    The landing page after successfully installing Kerberos Opensource.

    The landing page after successfully installing Kerberos Opensource.

    Login page

    When you’ve finished the welcome page, you will be redirected to the login page from now one. Use the credentials you have defined during the configuration of the welcome page. By default the username is root, and the password is root.

    After setting up the system you can proceed to login.

    After setting up the system you can proceed to login.

    Dashboard

    After you have signed in successfully, you will land on the dashboard page. This page will give you an overview of some simple statistics. Such as the the activity per day, per hour, etc.

    The dashboard gives you a high-level overview of what has been happening.

    The dashboard gives you a high-level overview of what has been happening.

    Media

    By selecting a specific day from the left navigation, or choosing the date picker on the top, you will be shown all the relevant media for that specific day. Both videos and images are listed and grouped (if they are within a specific time span). By scrolling down, more media items will be shown.

    You can use the timeslider at the top of the page for browsing through the day. The white (no activity) to gray (low activity) to red (high activity), will give you an indications of the amount of recordings for that specific hour.

    The media page gives an overview of your recordings (grouped into sequences) for that specific day.

    The media page gives an overview of your recordings (grouped into sequences) for that specific day.

    By drilling down into a sequence, you will see all the related recordings.

    By drilling down into a sequence, you will see all the related recordings.

    Settings

    Before being able to record anything, you will need to specify your capture device. A capture device is what we call: a camera. This camera can be a USB, RPi or IP camera. By default the RPi camera is selected, so if you are planning to use a IP camera make sure to change it on the settings page.

    The settings page allows you to modify and tweak the camera and motion settings.

    The settings page allows you to modify and tweak the camera and motion settings.

    Region of interest

    Besides selecting the capture device, you will have different options to make the detection more intelligent, such as defining a regions of interest, or an activation timeline (when Kerberos Open Source should be active).

    The region of interest allows you to inspect a specific region of the camera.

    The region of interest allows you to inspect a specific region of the camera.

    Storage

    Storing your recordings on your device is fine, on the other hand you might want to make it available remotely. By giving your Kerberos Hub credentials in the storage section, your recordings will be synced to our cloud solution.

    The region of interest allows you to inspect a specific region of the camera.

    The region of interest allows you to inspect a specific region of the camera.

    System

    This page will gave you overall information of Kerberos Open Source. It will give you information (logging) about the system, shows you some system information, the number of recordings on the system and more.

    The system pages show you the current status of your agent.

    The system pages show you the current status of your agent.

    Edit this page on GitHub

    ← First things first
    Installation →
    \ No newline at end of file +

    Get started

    What to expect from the Kerberos Open Source agent.

    Once you’ve installed Kerberos Open Source, you will have access to the web application. This web application allows you to administrate the machinery.

    Welcome page

    The first time you open a browser, and navigate to the web application (ip address of your device), you will land on the welcome page. This page will guide you through some basic steps and set simple configurations such as username and password.

    The landing page after successfully installing Kerberos Opensource.

    The landing page after successfully installing Kerberos Opensource.

    Login page

    When you’ve finished the welcome page, you will be redirected to the login page from now one. Use the credentials you have defined during the configuration of the welcome page. By default the username is root, and the password is root.

    After setting up the system you can proceed to login.

    After setting up the system you can proceed to login.

    Dashboard

    After you have signed in successfully, you will land on the dashboard page. This page will give you an overview of some simple statistics. Such as the the activity per day, per hour, etc.

    The dashboard gives you a high-level overview of what has been happening.

    The dashboard gives you a high-level overview of what has been happening.

    Media

    By selecting a specific day from the left navigation, or choosing the date picker on the top, you will be shown all the relevant media for that specific day. Both videos and images are listed and grouped (if they are within a specific time span). By scrolling down, more media items will be shown.

    You can use the timeslider at the top of the page for browsing through the day. The white (no activity) to gray (low activity) to red (high activity), will give you an indications of the amount of recordings for that specific hour.

    The media page gives an overview of your recordings (grouped into sequences) for that specific day.

    The media page gives an overview of your recordings (grouped into sequences) for that specific day.

    By drilling down into a sequence, you will see all the related recordings.

    By drilling down into a sequence, you will see all the related recordings.

    Settings

    Before being able to record anything, you will need to specify your capture device. A capture device is what we call: a camera. This camera can be a USB, RPi or IP camera. By default the RPi camera is selected, so if you are planning to use a IP camera make sure to change it on the settings page.

    The settings page allows you to modify and tweak the camera and motion settings.

    The settings page allows you to modify and tweak the camera and motion settings.

    Region of interest

    Besides selecting the capture device, you will have different options to make the detection more intelligent, such as defining a regions of interest, or an activation timeline (when Kerberos Open Source should be active).

    The region of interest allows you to inspect a specific region of the camera.

    The region of interest allows you to inspect a specific region of the camera.

    Storage

    Storing your recordings on your device is fine, on the other hand you might want to make it available remotely. By giving your Kerberos Hub credentials in the storage section, your recordings will be synced to our cloud solution.

    The region of interest allows you to inspect a specific region of the camera.

    The region of interest allows you to inspect a specific region of the camera.

    System

    This page will gave you overall information of Kerberos Open Source. It will give you information (logging) about the system, shows you some system information, the number of recordings on the system and more.

    The system pages show you the current status of your agent.

    The system pages show you the current status of your agent.

    Edit this page on GitHub

    ← First things first
    Installation →
    \ No newline at end of file diff --git a/opensource/index.html b/opensource/index.html index 2e30a30..5887251 100644 --- a/opensource/index.html +++ b/opensource/index.html @@ -1,6 +1,6 @@ -Opensource - Kerberos Docs
    - +Opensource - Kerberos Docs
    + Kerberos Docs
    \ No newline at end of file +
    \ No newline at end of file diff --git a/opensource/index.xml b/opensource/index.xml index 4ec4565..3ea4d5c 100644 --- a/opensource/index.xml +++ b/opensource/index.xml @@ -1,11 +1,11 @@ -Opensource onhttps://staging.doc.kerberos.live/opensource/Recent content in Opensource onHugo -- gohugo.ioen-USTue, 06 Oct 2020 08:49:15 +0000First things firsthttps://staging.doc.kerberos.live/opensource/first-things-first/Tue, 06 Oct 2020 08:49:31 +0000https://staging.doc.kerberos.live/opensource/first-things-first/Kerberos started as an Open Source project back in 2014. Our main goal was, and still is, to provide everyone in this world with a free, professional and complete video surveillance system, which they can install in a couple of minutes. Kerberos was initially developed for the Raspberry Pi, due to this many of the tools we have been using are lightweight and fast (such as C++). Over the years we have found other ways to make Kerberos available, such as KiOS (our custom Linux), Docker and Kubernetes.Get startedhttps://staging.doc.kerberos.live/opensource/get-started/Tue, 06 Oct 2020 08:49:31 +0000https://staging.doc.kerberos.live/opensource/get-started/Once you&rsquo;ve installed Kerberos Open Source, you will have access to the web application. This web application allows you to administrate the machinery. +Opensource onhttps://doc.kerberos.io/opensource/Recent content in Opensource onHugo -- gohugo.ioen-USTue, 06 Oct 2020 08:49:15 +0000First things firsthttps://doc.kerberos.io/opensource/first-things-first/Tue, 06 Oct 2020 08:49:31 +0000https://doc.kerberos.io/opensource/first-things-first/Kerberos started as an Open Source project back in 2014. Our main goal was, and still is, to provide everyone in this world with a free, professional and complete video surveillance system, which they can install in a couple of minutes. Kerberos was initially developed for the Raspberry Pi, due to this many of the tools we have been using are lightweight and fast (such as C++). Over the years we have found other ways to make Kerberos available, such as KiOS (our custom Linux), Docker and Kubernetes.Get startedhttps://doc.kerberos.io/opensource/get-started/Tue, 06 Oct 2020 08:49:31 +0000https://doc.kerberos.io/opensource/get-started/Once you&rsquo;ve installed Kerberos Open Source, you will have access to the web application. This web application allows you to administrate the machinery. Welcome page The first time you open a browser, and navigate to the web application (ip address of your device), you will land on the welcome page. This page will guide you through some basic steps and set simple configurations such as username and password. -The landing page after successfully installing Kerberos Opensource.Installationhttps://staging.doc.kerberos.live/opensource/installation/Tue, 06 Oct 2020 08:49:31 +0000https://staging.doc.kerberos.live/opensource/installation/Kerberos Open Source comes with different installation flavours. So you might think, why? The reason is simple, depending on the use case one option is better than another. A short list of recommendations: -Plug and play KiOS: You have a Raspberry Pi, and you only want to run a Kerberos agent on it. Docker: You have a lot of IP cameras, and/or don&rsquo;t want to mess with dependencies. Balena: Runnning the Kerberos Docker container on top of Balena.Advanced Installationhttps://staging.doc.kerberos.live/opensource/installation-advanced/Tue, 06 Oct 2020 08:49:31 +0000https://staging.doc.kerberos.live/opensource/installation-advanced/Following installation methods are only for advanced users, who need to have more control over the Kerberos Open Source environment. +The landing page after successfully installing Kerberos Opensource.Installationhttps://doc.kerberos.io/opensource/installation/Tue, 06 Oct 2020 08:49:31 +0000https://doc.kerberos.io/opensource/installation/Kerberos Open Source comes with different installation flavours. So you might think, why? The reason is simple, depending on the use case one option is better than another. A short list of recommendations: +Plug and play KiOS: You have a Raspberry Pi, and you only want to run a Kerberos agent on it. Docker: You have a lot of IP cameras, and/or don&rsquo;t want to mess with dependencies. Balena: Runnning the Kerberos Docker container on top of Balena.Advanced Installationhttps://doc.kerberos.io/opensource/installation-advanced/Tue, 06 Oct 2020 08:49:31 +0000https://doc.kerberos.io/opensource/installation-advanced/Following installation methods are only for advanced users, who need to have more control over the Kerberos Open Source environment. Raspbian If you have already an OS (e.g. Raspbian Buster) flashed to your Raspberry Pi, then it makes sense to install the Kerberos agent on top of your existing OS. There are two ways to achieve this: -Install the Kerberos agent using Docker (more info below), or you can install the Kerberos agent manually (machinery + web).Release noteshttps://staging.doc.kerberos.live/opensource/releases/Tue, 06 Oct 2020 08:49:31 +0000https://staging.doc.kerberos.live/opensource/releases/2.8.0 Aligned machinery, web and KiOS versions. Too many people were confused by the versioning. -Web Videos displayed on canvas were blocked in latest browsers. Disabled reboot and shutdown. Disabled upgrade process, use fwupdate shell command instead. KiOS Major upgrade, solved many different problems (list to long); not possible to upgrade from 2.7.0 to 2.8.0. Updated firmware to latest Raspbian (raspberrypi-kernel_1.20180417-1). Support for the Raspberry Pi 4. 2.Licensehttps://staging.doc.kerberos.live/opensource/license/Tue, 06 Oct 2020 08:49:31 +0000https://staging.doc.kerberos.live/opensource/license/Summary You are free to: -Share — copy and redistribute the material in any medium or format Adapt — remix, transform, and build upon the material The license Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License (&ldquo;Public License&rdquo;). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.Upgradehttps://staging.doc.kerberos.live/opensource/upgrade/Tue, 06 Oct 2020 08:49:31 +0000https://staging.doc.kerberos.live/opensource/upgrade/To upgrade your Kerberos agent to a new version you should follow the approach which fits your initial installation method. If you installed KiOS follow the KiOS upgrade procedure, if installed on Raspbian follow the Raspbian upgrade procedure, etc. -Please note that it might be possible that some new files are added or existing files were updated. To make sure everything works as expected, you should clear your browser cache.Contributehttps://staging.doc.kerberos.live/opensource/contribute/Tue, 06 Oct 2020 08:49:31 +0000https://staging.doc.kerberos.live/opensource/contribute/In this document we describe the different things you need to know if you would like to add a new feature to Kerberos Open Source, or change some of its behaviour for your own use case. -Before starting, as you might have read already, you need to know that Kerberos Open Source consists of two solutions. A front-end, also called web, which allows you to review the recordings and to configure the back-end settings.Machineryhttps://staging.doc.kerberos.live/opensource/machinery/Tue, 06 Oct 2020 08:49:31 +0000https://staging.doc.kerberos.live/opensource/machinery/The machinery is the processing engine of Kerberos Open Source. It&rsquo;s an image processing framework, written in C++, who benefits from other third party libraries (OpenCV, etc). It takes images from the type of camera (USB-, IP- or RPi-camera) you&rsquo;ve configured in the configuration files and executes one ore more algorithms and post-processes (e.g. save a snapshot). The configuration files allow you to define the type of camera, post-processes, conditions and much more; it&rsquo;s highly configurable.Webhttps://staging.doc.kerberos.live/opensource/web/Tue, 06 Oct 2020 08:49:31 +0000https://staging.doc.kerberos.live/opensource/web/The web is responsible for the visualization. It&rsquo;s a GUI which helps the user to find activity at a specific period, configure the machinery, view a live stream, see system information and much more. +Install the Kerberos agent using Docker (more info below), or you can install the Kerberos agent manually (machinery + web).Release noteshttps://doc.kerberos.io/opensource/releases/Tue, 06 Oct 2020 08:49:31 +0000https://doc.kerberos.io/opensource/releases/2.8.0 Aligned machinery, web and KiOS versions. Too many people were confused by the versioning. +Web Videos displayed on canvas were blocked in latest browsers. Disabled reboot and shutdown. Disabled upgrade process, use fwupdate shell command instead. KiOS Major upgrade, solved many different problems (list to long); not possible to upgrade from 2.7.0 to 2.8.0. Updated firmware to latest Raspbian (raspberrypi-kernel_1.20180417-1). Support for the Raspberry Pi 4. 2.Licensehttps://doc.kerberos.io/opensource/license/Tue, 06 Oct 2020 08:49:31 +0000https://doc.kerberos.io/opensource/license/Summary You are free to: +Share — copy and redistribute the material in any medium or format Adapt — remix, transform, and build upon the material The license Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License (&ldquo;Public License&rdquo;). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.Upgradehttps://doc.kerberos.io/opensource/upgrade/Tue, 06 Oct 2020 08:49:31 +0000https://doc.kerberos.io/opensource/upgrade/To upgrade your Kerberos agent to a new version you should follow the approach which fits your initial installation method. If you installed KiOS follow the KiOS upgrade procedure, if installed on Raspbian follow the Raspbian upgrade procedure, etc. +Please note that it might be possible that some new files are added or existing files were updated. To make sure everything works as expected, you should clear your browser cache.Contributehttps://doc.kerberos.io/opensource/contribute/Tue, 06 Oct 2020 08:49:31 +0000https://doc.kerberos.io/opensource/contribute/In this document we describe the different things you need to know if you would like to add a new feature to Kerberos Open Source, or change some of its behaviour for your own use case. +Before starting, as you might have read already, you need to know that Kerberos Open Source consists of two solutions. A front-end, also called web, which allows you to review the recordings and to configure the back-end settings.Machineryhttps://doc.kerberos.io/opensource/machinery/Tue, 06 Oct 2020 08:49:31 +0000https://doc.kerberos.io/opensource/machinery/The machinery is the processing engine of Kerberos Open Source. It&rsquo;s an image processing framework, written in C++, who benefits from other third party libraries (OpenCV, etc). It takes images from the type of camera (USB-, IP- or RPi-camera) you&rsquo;ve configured in the configuration files and executes one ore more algorithms and post-processes (e.g. save a snapshot). The configuration files allow you to define the type of camera, post-processes, conditions and much more; it&rsquo;s highly configurable.Webhttps://doc.kerberos.io/opensource/web/Tue, 06 Oct 2020 08:49:31 +0000https://doc.kerberos.io/opensource/web/The web is responsible for the visualization. It&rsquo;s a GUI which helps the user to find activity at a specific period, configure the machinery, view a live stream, see system information and much more. It&rsquo;s written in PHP using the extremely popular PHP Framework Laravel, and Javascript using the client-side framework BackboneJS. We will discuss the different pages and functionality briefly. Please check out the demo environment if you want to see a real life example. \ No newline at end of file diff --git a/opensource/installation-advanced/index.html b/opensource/installation-advanced/index.html index d4d73dd..f1d83c0 100644 --- a/opensource/installation-advanced/index.html +++ b/opensource/installation-advanced/index.html @@ -1,8 +1,8 @@ -Advanced Installation - Kerberos Docs
    - +Advanced Installation - Kerberos Docs
    + Kerberos Docs

    Advanced Installation

    More flexibility and control over your Kerberos Open Source agents.

    Following installation methods are only for advanced users, who need to have more control over the Kerberos Open Source environment.

    Raspbian

    If you have already an OS (e.g. Raspbian Buster) flashed to your Raspberry Pi, then it makes sense to install the Kerberos agent on top of your existing OS. There are two ways to achieve this:

    1. Install the Kerberos agent using Docker (more info below),
    2. or you can install the Kerberos agent manually (machinery + web).

    This section will focus on option 2, and will show you how to install the Kerberos agent manually.

    Update OS

    Let’s start with updating the OS, and installing a couple of packages.

    We have tested the Raspbian installation on Raspbian GNU/Linux 10 (buster). It might be that if you have a different version of Raspbian, you will need to install additional/different packages.

    sudo apt-get update && sudo apt-get install -y ffmpeg
+

    Advanced Installation

    More flexibility and control over your Kerberos Open Source agents.

    Following installation methods are only for advanced users, who need to have more control over the Kerberos Open Source environment.

    Raspbian

    If you have already an OS (e.g. Raspbian Buster) flashed to your Raspberry Pi, then it makes sense to install the Kerberos agent on top of your existing OS. There are two ways to achieve this:

    1. Install the Kerberos agent using Docker (more info below),
    2. or you can install the Kerberos agent manually (machinery + web).

    This section will focus on option 2, and will show you how to install the Kerberos agent manually.

    Update OS

    Let’s start with updating the OS, and installing a couple of packages.

    We have tested the Raspbian installation on Raspbian GNU/Linux 10 (buster). It might be that if you have a different version of Raspbian, you will need to install additional/different packages.

    sudo apt-get update && sudo apt-get install -y ffmpeg

    Machinery

    Download the debian file from the machinery repository.

    https://github.com/kerberos-io/machinery/releases

    A .deb file is available for every version of the Raspberry Pi. For example if you are using a Raspberry Pi 4 for version 2.8.0, execute following command. You can change the version and Raspberry Pi board to your needs.

    Please make sure you pick the right board (rpi, rpi2, rpi3 or rpi4), and choose the version you want (e.g. 2.8.0). Replace below url, with your preferences.

    wget https://github.com/kerberos-io/machinery/releases/download/v2.8.0/rpi4-machinery-kerberosio-armhf-2.8.0.deb
 sudo dpkg -i rpi4-machinery-kerberosio-armhf-2.8.0.deb

    Download the x265 library (version 160) from the machinery repository, as Raspbian Buster 10 only ships with version 165. Make sure you select the right board.

    v2.8.0/rpi4-libx265.so.160 this will download the libx265 shared library for the Raspberry Pi 4.

    wget https://github.com/kerberos-io/machinery/releases/download/v2.8.0/rpi4-libx265.so.160
@@ -114,5 +114,5 @@ fi;

    Make the script executable.

    chmod +x /home/[user]/autoremoval.sh

    Initiate a cronjob, and select the nano editor.

    crontab -e

    Append following line, to execute the autoremoval.sh script every 5min.

    */5 * * * * /bin/bash /home/[user]/autoremoval.sh
-

    Edit this page on GitHub

    ← Installation
    Release notes →
    \ No newline at end of file +

    Edit this page on GitHub

    ← Installation
    Release notes →
    \ No newline at end of file diff --git a/opensource/installation/index.html b/opensource/installation/index.html index c2fd03a..c7fd145 100644 --- a/opensource/installation/index.html +++ b/opensource/installation/index.html @@ -1,8 +1,8 @@ -Installation - Kerberos Docs
    - +Installation - Kerberos Docs
    + Kerberos Docs

    Installation

    Get your Kerberos Open Source agents up and running in just a couple of minutes.

    Kerberos Open Source comes with different installation flavours. So you might think, why? The reason is simple, depending on the use case one option is better than another. A short list of recommendations:

    Plug and play

    1. KiOS: You have a Raspberry Pi, and you only want to run a Kerberos agent on it.
    2. Docker: You have a lot of IP cameras, and/or don’t want to mess with dependencies.
    3. Balena: Runnning the Kerberos Docker container on top of Balena.

    Advanced

    1. Raspbian: You have a Raspberry Pi, but you want other services running next to the Kerberos agent.
    2. Generic: You want to develop/extend Kerberos with your own features, or you want to run a Kerberos agent on a not supported OS/architecure.

    Plug and play

    Following installation methods aim for the simplicity of installing Kerberos Open Source. With almost no efforts you can have Kerberos Open Source running.

    KiOS

    KiOS (Kerberos Operating System) is our custom linux OS, which runs the Kerberos agent out-of-the-box (read plug-and-play). It’s an OS designed for the Raspberry Pi (all version are supported), which you can flash to an SD card.

    It can be installed using our own installer, which comes with a nice interface that handles the flashing and network configuration for you, or you can handle the flashing yourself by using Etcher.

    Github

    KiOS is compiled using Buildroot, the project can be found on following Github repo.

    Kerberos Open Source installer

    Installing the Kerberos agent to your Raspberry Pi, has never been so easy. By using our cross-platform installer, you can run a fully configured video surveillance system within 3 minutes. Indeed, we also think that’s awesome!

    Using the KiOS installer, you can easily deploy the Kerberos Opensource agent to your Raspberry Pi.

    Using the KiOS installer, you can easily deploy the Kerberos Opensource agent to your Raspberry Pi.

    Download the correct installer for your OS below:

    https://github.com/kerberos-io/etcher/releases

    Etcher

    If you love Etcher, or the Kerberos installer is not working as expected, you can also flash the Kerberos agent to your SD card manually. It goes as following:

    1. Download the KiOS image,
    2. flash it to your SD card with Etcher,
    3. and edit some configuration files at the boot directory.
    You could also install using the Etcher installer.

    You could also install using the Etcher installer.

    Once you have download the KiOS image (make sure you downloaded the right image) and flashed it to an SD card, put it back into your working station. Navigate to the SD card and creating following files.

    Connecting to WiFi

    If you want to connect your Raspberry Pi to a WiFi connection, you will need to create a file wireless.conf on your SD card, with following contents. Change the SSID and password properties to your own WiFi credentials.

    update_config=1
+

    Installation

    Get your Kerberos Open Source agents up and running in just a couple of minutes.

    Kerberos Open Source comes with different installation flavours. So you might think, why? The reason is simple, depending on the use case one option is better than another. A short list of recommendations:

    Plug and play

    1. KiOS: You have a Raspberry Pi, and you only want to run a Kerberos agent on it.
    2. Docker: You have a lot of IP cameras, and/or don’t want to mess with dependencies.
    3. Balena: Runnning the Kerberos Docker container on top of Balena.

    Advanced

    1. Raspbian: You have a Raspberry Pi, but you want other services running next to the Kerberos agent.
    2. Generic: You want to develop/extend Kerberos with your own features, or you want to run a Kerberos agent on a not supported OS/architecure.

    Plug and play

    Following installation methods aim for the simplicity of installing Kerberos Open Source. With almost no efforts you can have Kerberos Open Source running.

    KiOS

    KiOS (Kerberos Operating System) is our custom linux OS, which runs the Kerberos agent out-of-the-box (read plug-and-play). It’s an OS designed for the Raspberry Pi (all version are supported), which you can flash to an SD card.

    It can be installed using our own installer, which comes with a nice interface that handles the flashing and network configuration for you, or you can handle the flashing yourself by using Etcher.

    Github

    KiOS is compiled using Buildroot, the project can be found on following Github repo.

    Kerberos Open Source installer

    Installing the Kerberos agent to your Raspberry Pi, has never been so easy. By using our cross-platform installer, you can run a fully configured video surveillance system within 3 minutes. Indeed, we also think that’s awesome!

    Using the KiOS installer, you can easily deploy the Kerberos Opensource agent to your Raspberry Pi.

    Using the KiOS installer, you can easily deploy the Kerberos Opensource agent to your Raspberry Pi.

    Download the correct installer for your OS below:

    https://github.com/kerberos-io/etcher/releases

    Etcher

    If you love Etcher, or the Kerberos installer is not working as expected, you can also flash the Kerberos agent to your SD card manually. It goes as following:

    1. Download the KiOS image,
    2. flash it to your SD card with Etcher,
    3. and edit some configuration files at the boot directory.
    You could also install using the Etcher installer.

    You could also install using the Etcher installer.

    Once you have download the KiOS image (make sure you downloaded the right image) and flashed it to an SD card, put it back into your working station. Navigate to the SD card and creating following files.

    Connecting to WiFi

    If you want to connect your Raspberry Pi to a WiFi connection, you will need to create a file wireless.conf on your SD card, with following contents. Change the SSID and password properties to your own WiFi credentials.

    update_config=1
 ctrl_interface=/var/run/wpa_supplicant
 network={
   scan_ssid=1
@@ -37,7 +37,7 @@ http://localhost:82
 -v ~/logs:/etc/opt/kerberosio/logs \
 -v ~/webconfig:/var/www/web/config \
 -d kerberos/kerberos
-

    Balena

    Running Kerberos inside a Docker container is great, it makes it possible to run Kerberos everywhere; basically on any OS. You can deploy Kerberos easily to the many different IoT boards we nowadays have available. The challenge with all these IoT boards is that they have different system architecures, however thanks to Docker (and its multi architecture builds), we can ship Kerberos to any of them. If you have a Raspberry Pi, you have two options: Docker and KiOS. If you have any other board, then Docker is the way to go.

    Once you’ve deployed the Kerberos Docker container, you can start monitoring your video surveillances cameras, however it doesn’t have to stop here. Probably you also want remote access to your IoT board, and maybe some other cool stuff like system control, a VPN, a public url? This is where Balena.io comes in.

    Before getting into the details, you can find a more detailed tutorial at this blog.

    1. Create a Balena account

    Before moving on, make sure you have registered on Balena.

    Creating a Balena Cloud account to onboard your Kerberos Opensource agent.

    Creating a Balena Cloud account to onboard your Kerberos Opensource agent.

    2. Create a device and flash

    After you signed up, you can create an application for a specific IoT board (e.g. Raspberry Pi 3). Once created you will be able to download the balena OS image, which you can flash to your SD card using Etcher.

    After signed up, create an application for your Kerberos Opensource agent.

    After signed up, create an application for your Kerberos Opensource agent.

    3. Connect

    Once you’ve flashed the balena OS, turned on your IoT board, a new device should come up on the Balena dashboard (below the application you’ve created). At this point you will be able to connect to your device using the balena-cli read more about the installation here.

    First connect the balena-cli to your account by executing following command. Choose the recommended option.

    balena login
+

    Balena

    Running Kerberos inside a Docker container is great, it makes it possible to run Kerberos everywhere; basically on any OS. You can deploy Kerberos easily to the many different IoT boards we nowadays have available. The challenge with all these IoT boards is that they have different system architecures, however thanks to Docker (and its multi architecture builds), we can ship Kerberos to any of them. If you have a Raspberry Pi, you have two options: Docker and KiOS. If you have any other board, then Docker is the way to go.

    Once you’ve deployed the Kerberos Docker container, you can start monitoring your video surveillances cameras, however it doesn’t have to stop here. Probably you also want remote access to your IoT board, and maybe some other cool stuff like system control, a VPN, a public url? This is where Balena.io comes in.

    Before getting into the details, you can find a more detailed tutorial at this blog.

    1. Create a Balena account

    Before moving on, make sure you have registered on Balena.

    Creating a Balena Cloud account to onboard your Kerberos Opensource agent.

    Creating a Balena Cloud account to onboard your Kerberos Opensource agent.

    2. Create a device and flash

    After you signed up, you can create an application for a specific IoT board (e.g. Raspberry Pi 3). Once created you will be able to download the balena OS image, which you can flash to your SD card using Etcher.

    After signed up, create an application for your Kerberos Opensource agent.

    After signed up, create an application for your Kerberos Opensource agent.

    3. Connect

    Once you’ve flashed the balena OS, turned on your IoT board, a new device should come up on the Balena dashboard (below the application you’ve created). At this point you will be able to connect to your device using the balena-cli read more about the installation here.

    First connect the balena-cli to your account by executing following command. Choose the recommended option.

    balena login

    After succesfully logged in you should be able to list your devices.

    balena devices

    4. Write

    Finally, we can push our Kerberos Docker container to our application (and devices). To do this we need to create two files.

    1. Create a new directory and the Dockerfile.

    The first file is named Dockerfile this file will contain a base image which references to our Kerberos image, which you can find here.

    mkdir kerberosbalena
 cd kerberosbalena
@@ -71,5 +71,5 @@ services:
       io.balena.features.resin-api: '1'
       io.balena.features.balena-socket: '1'

    5. Push

    Now we created our two files, we can publish the Kerberos container to balena (our application), by executing the push command (replace <application_name> by the name of your application).

    balena push <application_name>
-

    Once finished you should see following message, and on the dashboard you should see your devices updating (Yes you can add multiple devices to an application). You’re ready ;)

    Once created you can push the Kerberos Opensource agent to your Balenca Cloud app.

    Once created you can push the Kerberos Opensource agent to your Balenca Cloud app.

    Edit this page on GitHub

    ← Get started
    Advanced Installation →
    \ No newline at end of file +

    Once finished you should see following message, and on the dashboard you should see your devices updating (Yes you can add multiple devices to an application). You’re ready ;)

    Once created you can push the Kerberos Opensource agent to your Balenca Cloud app.

    Once created you can push the Kerberos Opensource agent to your Balenca Cloud app.

    Edit this page on GitHub

    ← Get started
    Advanced Installation →
    \ No newline at end of file diff --git a/opensource/license/index.html b/opensource/license/index.html index 0a9d488..e84d743 100644 --- a/opensource/license/index.html +++ b/opensource/license/index.html @@ -1,9 +1,9 @@ -License - Kerberos Docs
    - +License - Kerberos Docs
    + Kerberos Docs

    License

    Creative Commons BY-NC-SA 4.0

    Summary

    You are free to:

    • Share — copy and redistribute the material in any medium or format
    • Adapt — remix, transform, and build upon the material

    The license

    Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License +

    License

    Creative Commons BY-NC-SA 4.0

    Summary

    You are free to:

    • Share — copy and redistribute the material in any medium or format
    • Adapt — remix, transform, and build upon the material

    The license

    Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License (“Public License”). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.

    Section 1 – Definitions

    Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.

    Adapter’s License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License.

    BY-NC-SA Compatible License means a license listed at creativecommons.org/compatiblelicenses, approved by Creative Commons as essentially the equivalent of this Public License.

    Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.

    Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.

    Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material.

    License Elements means the license attributes listed in the name of a Creative Commons Public License. The License Elements of this Public License are Attribution, NonCommercial, and ShareAlike.

    Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License.

    Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license.

    Licensor means the individual(s) or entity(ies) granting rights under this Public License.

    NonCommercial means not primarily intended for or directed towards commercial advantage or monetary compensation. For purposes of this Public License, the exchange of the Licensed Material for other material subject to Copyright and Similar Rights by digital file-sharing or similar means is NonCommercial provided there is no payment of monetary compensation in connection with the exchange.

    Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them.

    Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.

    You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning.

    Section 2 – Scope

    License grant.

    Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to:

    • reproduce and Share the Licensed Material, in whole or in part, for NonCommercial purposes only; and
    • produce, reproduce, and Share Adapted Material for NonCommercial purposes only.

    Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions.

    Term.

    The term of this Public License is specified in Section 6(a).

    Media and formats; technical modifications allowed.

    The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material.

    Downstream recipients.

    Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License.

    Additional offer from the Licensor – Adapted Material. Every recipient of Adapted Material from You automatically receives an offer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapter’s License You apply.

    No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.

    No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i). Other rights.

    Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise.

    Patent and trademark rights are not licensed under this Public License.

    To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties, including when the Licensed Material is used other than for NonCommercial purposes.

    Section 3 – License Conditions

    Your exercise of the Licensed Rights is expressly made subject to the following conditions.

    Attribution.

    If You Share the Licensed Material (including in modified form), You must:

    • retain the following if it is supplied by the Licensor with the Licensed Material:
    • identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
    • a copyright notice;
    • a notice that refers to this Public License;
    • a notice that refers to the disclaimer of warranties;
    • a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
    • indicate if You modified the Licensed Material and retain an indication of any previous modifications; and
    • indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License.

    You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information.

    If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable.

    ShareAlike.

    In addition to the conditions in Section 3(a), if You Share Adapted Material You produce, the following conditions also apply.

    The Adapter’s License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-NC-SA Compatible License.

    You must include the text of, or the URI or hyperlink to, the Adapter’s License You apply. You may satisfy this condition in any reasonable manner based on the medium, means, and context in which You Share Adapted Material.

    You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, Adapted Material that restrict exercise of the rights granted under the Adapter’s License You apply.

    Section 4 – Sui Generis Database Rights

    Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:

    • for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database for NonCommercial purposes only;
    • if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material, including for purposes of Section 3(b); and
    • You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database.

    For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.

    Section 5 – Disclaimer of Warranties and Limitation of Liability

    Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.

    To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.

    The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.

    Section 6 – Term and Termination

    This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically. -Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:

    automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or

    • upon express reinstatement by the Licensor.

    For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.

    For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.

    Sections 1, 5, 6, 7, and 8 survive termination of this Public License.

    Section 7 – Other Terms and Conditions

    The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.

    Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.

    Section 8 – Interpretation

    For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.

    To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.

    No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.

    Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.

    Edit this page on GitHub

    ← Release notes
    Upgrade →
    \ No newline at end of file +Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:

    automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or

    • upon express reinstatement by the Licensor.

    For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.

    For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.

    Sections 1, 5, 6, 7, and 8 survive termination of this Public License.

    Section 7 – Other Terms and Conditions

    The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.

    Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.

    Section 8 – Interpretation

    For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.

    To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.

    No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.

    Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.

    Edit this page on GitHub

    ← Release notes
    Upgrade →
    \ No newline at end of file diff --git a/opensource/machinery/index.html b/opensource/machinery/index.html index 60d749e..0a51d05 100644 --- a/opensource/machinery/index.html +++ b/opensource/machinery/index.html @@ -1,8 +1,8 @@ -Machinery - Kerberos Docs
    - +Machinery - Kerberos Docs
    + Kerberos Docs

    Machinery

    The machinery is the engine of the Kerberos Open Source agent, it connects to the camera and makes recordings.

    The machinery is the processing engine of Kerberos Open Source. It’s an image processing framework, written in C++, who benefits from other third party libraries (OpenCV, etc). It takes images from the type of camera (USB-, IP- or RPi-camera) you’ve configured in the configuration files and executes one ore more algorithms and post-processes (e.g. save a snapshot). The configuration files allow you to define the type of camera, post-processes, conditions and much more; it’s highly configurable. It’s important to note that the machinery, out-of-the-box, can handle only one camera at a time.

    Project structure

    The machinery is an image processing framework which is devided into four steps:

    • condition
    • algorithm
    • expositor
    • heuristic

    The steps belong to a four passway; illustrated on the image below. In each cycle a sequence of images is processed. Each step will process the sequence, and will return some result to the next step. For example: an algorithm will process the images and returns an array to the Expositor, which contains boolean values. The steps are loosly coupled, so they have simple conventions, just like the example before.

    Thanks to the loosly coupling, each step can be developed indepently. So algorithms, expositors, heuristics and conditions can be switched on the fly. This makes it easier for other developers who want to contribute to the machinery. They can create a new algorithm without knowing how a specific expositor or heuristic works. They just need to be aware of the convention an algorithm should meet.

    The Kerberos Opensource agent is composed out of different concepts.

    The Kerberos Opensource agent is composed out of different concepts.

    These different steps can be configured by editing a couple of configurationn files located at config/. The main configuration file config/config.xml looks like this:

    <?xml version="1.0"?>
+

    Machinery

    The machinery is the engine of the Kerberos Open Source agent, it connects to the camera and makes recordings.

    The machinery is the processing engine of Kerberos Open Source. It’s an image processing framework, written in C++, who benefits from other third party libraries (OpenCV, etc). It takes images from the type of camera (USB-, IP- or RPi-camera) you’ve configured in the configuration files and executes one ore more algorithms and post-processes (e.g. save a snapshot). The configuration files allow you to define the type of camera, post-processes, conditions and much more; it’s highly configurable. It’s important to note that the machinery, out-of-the-box, can handle only one camera at a time.

    Project structure

    The machinery is an image processing framework which is devided into four steps:

    • condition
    • algorithm
    • expositor
    • heuristic

    The steps belong to a four passway; illustrated on the image below. In each cycle a sequence of images is processed. Each step will process the sequence, and will return some result to the next step. For example: an algorithm will process the images and returns an array to the Expositor, which contains boolean values. The steps are loosly coupled, so they have simple conventions, just like the example before.

    Thanks to the loosly coupling, each step can be developed indepently. So algorithms, expositors, heuristics and conditions can be switched on the fly. This makes it easier for other developers who want to contribute to the machinery. They can create a new algorithm without knowing how a specific expositor or heuristic works. They just need to be aware of the convention an algorithm should meet.

    The Kerberos Opensource agent is composed out of different concepts.

    The Kerberos Opensource agent is composed out of different concepts.

    These different steps can be configured by editing a couple of configurationn files located at config/. The main configuration file config/config.xml looks like this:

    <?xml version="1.0"?>
 <kerberos>
   <instance>
     <name type="text">frontdoor</name>
@@ -252,5 +252,5 @@ Detailed information (a JSON object) is published to an MQTT topic. The JSON obj
     </Mjpg>
 </streams>

    Enabled

    A boolean which turns ON/OFF the stream. This is interesting when working with IP cameras, where you already have an RTSP/MJPG stream from the camera itself.

    Stream Port

    The port on which the stream is available.

    Quality

    The quality is a value between [0-100]. The lower the quality, the more the image will be compressed. If you’re using the RaspberryPi Camera module, this option will be ignored.

    Username/password

    You can secure the MJPEG streaming with a username and password. These credentials will be used to authorize your requests using Basic Authentication. Please note that once enabled, the live stream on the dashboard page can fail; however it will work if you open it directly in your browser or ip camera client. The format of the streaming url, after authentication enabled, will look as following:

    http://username:password@ip-camera:8899
-

    Edit this page on GitHub

    ← Contribute
    Web →
    \ No newline at end of file +

    Edit this page on GitHub

    ← Contribute
    Web →
    \ No newline at end of file diff --git a/opensource/releases/index.html b/opensource/releases/index.html index 57265b3..4acc244 100644 --- a/opensource/releases/index.html +++ b/opensource/releases/index.html @@ -1,6 +1,6 @@ -Release notes - Kerberos Docs
    - +Release notes - Kerberos Docs
    + Kerberos Docs

    Release notes

    Understand what's new in the Kerberos Open Source agent.

    2.8.0

    Aligned machinery, web and KiOS versions. Too many people were confused by the versioning.

    Web

    • Videos displayed on canvas were blocked in latest browsers.
    • Disabled reboot and shutdown.
    • Disabled upgrade process, use fwupdate shell command instead.

    KiOS

    • Major upgrade, solved many different problems (list to long); not possible to upgrade from 2.7.0 to 2.8.0.
    • Updated firmware to latest Raspbian (raspberrypi-kernel_1.20180417-1).
    • Support for the Raspberry Pi 4.

    2.7.2

    Machinery

    • To optimise the cloud experience we’ve added a proxy.kerberos.io machine in between.
    • We’ve changed the S3 storage scheme (class:ONEZONE_IA).

    2.7.1

    Machinery

    • Resolved deadlock with livestreaming while restarting machinery.
    • Revert logging library; enabled log rotating.

    KiOS

    • Updated firmware to latest Raspbian (raspberrypi-kernel_1.20180417-1).
    • Resolved issue with WIFI on Raspberry Pi 3B+

    2.7.0

    Web

    • Unique session cookie, which allows to open multiple web interfaces (e.g. when using docker).

    Machinery

    • Added live streaming feature for app.kerberos.io
    • Upgraded logging library: log file can be max 5MB, and will rotate.
    • Better logging for cloud uploads (failed information).

    Docker

    • No longer need docker-compose, we merged the web and machinery containers to a single container.

    KiOS

    • Updated firmware to latest Raspbian.
    • Support for the Raspberry Pi 3B+.

    2.6.1

    Web

    • Solved issue with persisting login configuration. #111

    Machinery

    • Added Pushbullet. #139
    • Cloud upload was not longer working (hotfix also in 2.6.0).

    2.6.0

    Web

    • Add a cloud connection verification method. #112

    Machinery

    • Add background color timestamp. #128
    • Send instanceId in AWS header when uploading to cloud (necessary for new cloud app).
    • Better support for Chinese IP cameras.

    Docker

    • Bug: Autoremove old images/video within Docker Containers. #104

    2.5.0

    Web

    • Added Chinese and Italian language.
    • Resolved issue with INSTALLED=true.
    • Make latest_sequence available with basic auth. #99

    Machinery

    • Provide an IO service for publishing events to MQTT. #89
    • Optimize recording with H264_OMX. #83
    • Implement throttler for Io detections. #96
    • SSL version 1.0.0 is no longer accessible in Raspbian. #109

    2.4.2

    Web

    • Typo in french translation, causes the web interface crash.

    Machinery

    • Resolved major bug in livestream: memory leak in stream class. #94
    • Capture health verification: check if the chosen capture device is still grabbing (and didn’t stalled).
    • Extra logging when recording with raspberry pi camera.
    • Make sure the cloud upload is functioning properly, after an upload it’s verified if the files really exist in the cloud.

    2.4.1

    Web

    • Show warning when system is disabled. #88.
    • Hull selector in basic view not always working.

    2.4.0

    Ecosystem

    • Enable/Disable force network mode.
    • Enable/Disable auto removal media.

    Web

    • Upgrade from Laravel 4.2 to Laravel 5.4 #70.
    • Fix bug with heatmap radius slider #84.
    • Design tweaks toggle button (remove outline).
    • Disabled possibility to timestamp video when using hardware acceleration.

    Docker

    • Fix SSL support #4.
    • Auto removal if disk is full.

    Machinery

    • OpenMAX IL hardware encoding for Raspberry Pi camera. #83
      • Optimized live streaming.
      • Optimized h264 recording.
    • Basic authentication for live streaming (username and password). #80

    2.3.1

    Machinery

    • Update for kerberos.cloud: pushing content-type.
    • Change default configurations.

    2.3.0

    Ecosystem

    • Support for Raspberry Pi Zero W. #8

    2.2.1

    Ecosystem

    • Upgraded FFmpeg and libx264 on KiOS.

    Web

    • Add Bulgarian translation. #81

    Machinery

    • Bug: IoVideo crashes due to a memory leak. #70

    2.2.0

    Ecosystem

    • Added support for Armbian.
    • Raspbian: Async requests causes session corruption. #78

    Web

    • Bug: Issue format instance name. #57
    • Redesign settings page (better UX). #39
    • Possibility to edit password through web interface. #63
    • Support for viewing videos.
    • Update radius of heatmap.
    • PHP7 support. #60
    • Welcome/installation page. #60
    • Translation updated. #74
    • Privacy mode. #54

    Machinery

    • Output as video file. #60
    • Bug: System hangs when a wrong IP camera url was defined. #48
    • Run arbitrary script/program. #31
    • Bug: Weird colors from RPi Camera. #64
    • Upgrade to OpenCV 3.2.0.

    2.1.0

    Web

    • Added PhotoSwipe for image overview (easier to browse through images). #45
    • Added reboot and shutdown commands. #46
    • Added logging view to system page. #33
    • Added labels to check if machinery is running.
    • Added error handling if web interface isn’t working properly.
    • Fixed Heatmap.js fail to load by ad-blocker. #42
    • Show additional information on the dashboard (streaming is opening or not) there is no data available.
    • Settings page is now visible on mobile (+ changed icon).
    • Fixed sorting of news articles.
    • Removed links to assets in the cloud (.css files).
    • Design: improved layout of login page, async loading of image view.

    Machinery

    • Added configurable streaming port and quality. #41
    • Added new algorithm: Background subtraction.
    • Added new heuristic: Counter (for object/people counting). #42
    • Added video capture, which can be used for debugging purposes (replay a video fragment).
    • It’s now possible to mark the images with a timestamp. #36
    • Fixed blocking streaming socket. #39

    Ecosystem

    • Fix removal images if disk is almost full (wrong path was defined).
    • Support for the Raspberry Pi Camera module v2.1. #3
    • Support for the Raspberry Pi Zero; updated kernel to latest Raspbian. #3
    • KiOS GUI installer.

    2.0.0

    Web

    • Add simple ON/OFF toggle. #24
    • Added update strategy when using KiOS. #23
    • A system page which shows system information. #20
    • Heatmap on dashboard page #19
    • Added live stream view on the dashboard page #2
    • Fixed bug cloud syncing #16
    • Fixed broken settings page when space in instane name #16

    Machinery

    • RTSP support for IP-camera’s. #21
    • Verbose logging. #35
    • IO-devices are executed in a seperate thread. #28
    • Live streaming (MJPEG). #26
    • Execute multiple instances on a machine. #24
    • Override config by arguments. #22
    • Move S3 upload to machinery and remove sync-s3 repository. #16

    Docker

    • Added Docker image (x86_x64) to Docker Hub.

    Ecosystem

    • Add support for Raspberry Pi 1, 2 and 3. #1

    1.1.0

    Web

    • Support IP camera’s with MJPEG stream. #3
    • Introduce new API methods to configure the machinery, using basic auth. #4
    • Optimization of loading image and dashboard page, completely redesigned the retrieval of images. #5
    • Optimization of settings page. #5
    • Timebar gradient only works in Chrome. #6
    • Minor CSS fixes for responsive layout.

    Machinery

    • Flip/rotate option for capture devices. #5
    • Support IP camera’s with MJPEG stream. #4
    • Introduced webhook io device. #5

    Cloud

    • Fixed problem when syncing a huge amount of images. #1

    1.0.3

    Web

    • Optimize performance, new datastructure has been implemented.

    Machinery

    • Memory optimization.
    • Removal of images older than 3 days have been removed.
    • Start machinery automatically (delay has been removed).

    Cloud

    • Resolved file exist problem.

    1.0.2

    Web

    • Timezone on settings page is also used for the webinterface.

    Machinery

    • Added extra timezones to timezone.xml.

    1.0.1

    Web

    • Improved error handling (date search).

    Machinery

    • Improved memory cleanup.

    1.0.0

    First commit of Kerberos.io

    • Camera support: USBCamera (V4L), Raspberry Pi camera module (MMAL).
    • Conditions: Enabled (turn on/off Kerberos) and active Time per day.
    • Algorithms: Differential Images.
    • Heuristics: Sequence.
    • Expositors: Select a Hull or Rectangle.
    • Outputs: Write image to Disk, trigger an GPIO output pin and send a TCP/IP packet.
    • Cloud: send your images to the Kerberos.io cloud aplication.

    Edit this page on GitHub

    ← Advanced Installation
    License →
    \ No newline at end of file +

    Release notes

    Understand what's new in the Kerberos Open Source agent.

    2.8.0

    Aligned machinery, web and KiOS versions. Too many people were confused by the versioning.

    Web

    • Videos displayed on canvas were blocked in latest browsers.
    • Disabled reboot and shutdown.
    • Disabled upgrade process, use fwupdate shell command instead.

    KiOS

    • Major upgrade, solved many different problems (list to long); not possible to upgrade from 2.7.0 to 2.8.0.
    • Updated firmware to latest Raspbian (raspberrypi-kernel_1.20180417-1).
    • Support for the Raspberry Pi 4.

    2.7.2

    Machinery

    • To optimise the cloud experience we’ve added a proxy.kerberos.io machine in between.
    • We’ve changed the S3 storage scheme (class:ONEZONE_IA).

    2.7.1

    Machinery

    • Resolved deadlock with livestreaming while restarting machinery.
    • Revert logging library; enabled log rotating.

    KiOS

    • Updated firmware to latest Raspbian (raspberrypi-kernel_1.20180417-1).
    • Resolved issue with WIFI on Raspberry Pi 3B+

    2.7.0

    Web

    • Unique session cookie, which allows to open multiple web interfaces (e.g. when using docker).

    Machinery

    • Added live streaming feature for app.kerberos.io
    • Upgraded logging library: log file can be max 5MB, and will rotate.
    • Better logging for cloud uploads (failed information).

    Docker

    • No longer need docker-compose, we merged the web and machinery containers to a single container.

    KiOS

    • Updated firmware to latest Raspbian.
    • Support for the Raspberry Pi 3B+.

    2.6.1

    Web

    • Solved issue with persisting login configuration. #111

    Machinery

    • Added Pushbullet. #139
    • Cloud upload was not longer working (hotfix also in 2.6.0).

    2.6.0

    Web

    • Add a cloud connection verification method. #112

    Machinery

    • Add background color timestamp. #128
    • Send instanceId in AWS header when uploading to cloud (necessary for new cloud app).
    • Better support for Chinese IP cameras.

    Docker

    • Bug: Autoremove old images/video within Docker Containers. #104

    2.5.0

    Web

    • Added Chinese and Italian language.
    • Resolved issue with INSTALLED=true.
    • Make latest_sequence available with basic auth. #99

    Machinery

    • Provide an IO service for publishing events to MQTT. #89
    • Optimize recording with H264_OMX. #83
    • Implement throttler for Io detections. #96
    • SSL version 1.0.0 is no longer accessible in Raspbian. #109

    2.4.2

    Web

    • Typo in french translation, causes the web interface crash.

    Machinery

    • Resolved major bug in livestream: memory leak in stream class. #94
    • Capture health verification: check if the chosen capture device is still grabbing (and didn’t stalled).
    • Extra logging when recording with raspberry pi camera.
    • Make sure the cloud upload is functioning properly, after an upload it’s verified if the files really exist in the cloud.

    2.4.1

    Web

    • Show warning when system is disabled. #88.
    • Hull selector in basic view not always working.

    2.4.0

    Ecosystem

    • Enable/Disable force network mode.
    • Enable/Disable auto removal media.

    Web

    • Upgrade from Laravel 4.2 to Laravel 5.4 #70.
    • Fix bug with heatmap radius slider #84.
    • Design tweaks toggle button (remove outline).
    • Disabled possibility to timestamp video when using hardware acceleration.

    Docker

    • Fix SSL support #4.
    • Auto removal if disk is full.

    Machinery

    • OpenMAX IL hardware encoding for Raspberry Pi camera. #83
      • Optimized live streaming.
      • Optimized h264 recording.
    • Basic authentication for live streaming (username and password). #80

    2.3.1

    Machinery

    • Update for kerberos.cloud: pushing content-type.
    • Change default configurations.

    2.3.0

    Ecosystem

    • Support for Raspberry Pi Zero W. #8

    2.2.1

    Ecosystem

    • Upgraded FFmpeg and libx264 on KiOS.

    Web

    • Add Bulgarian translation. #81

    Machinery

    • Bug: IoVideo crashes due to a memory leak. #70

    2.2.0

    Ecosystem

    • Added support for Armbian.
    • Raspbian: Async requests causes session corruption. #78

    Web

    • Bug: Issue format instance name. #57
    • Redesign settings page (better UX). #39
    • Possibility to edit password through web interface. #63
    • Support for viewing videos.
    • Update radius of heatmap.
    • PHP7 support. #60
    • Welcome/installation page. #60
    • Translation updated. #74
    • Privacy mode. #54

    Machinery

    • Output as video file. #60
    • Bug: System hangs when a wrong IP camera url was defined. #48
    • Run arbitrary script/program. #31
    • Bug: Weird colors from RPi Camera. #64
    • Upgrade to OpenCV 3.2.0.

    2.1.0

    Web

    • Added PhotoSwipe for image overview (easier to browse through images). #45
    • Added reboot and shutdown commands. #46
    • Added logging view to system page. #33
    • Added labels to check if machinery is running.
    • Added error handling if web interface isn’t working properly.
    • Fixed Heatmap.js fail to load by ad-blocker. #42
    • Show additional information on the dashboard (streaming is opening or not) there is no data available.
    • Settings page is now visible on mobile (+ changed icon).
    • Fixed sorting of news articles.
    • Removed links to assets in the cloud (.css files).
    • Design: improved layout of login page, async loading of image view.

    Machinery

    • Added configurable streaming port and quality. #41
    • Added new algorithm: Background subtraction.
    • Added new heuristic: Counter (for object/people counting). #42
    • Added video capture, which can be used for debugging purposes (replay a video fragment).
    • It’s now possible to mark the images with a timestamp. #36
    • Fixed blocking streaming socket. #39

    Ecosystem

    • Fix removal images if disk is almost full (wrong path was defined).
    • Support for the Raspberry Pi Camera module v2.1. #3
    • Support for the Raspberry Pi Zero; updated kernel to latest Raspbian. #3
    • KiOS GUI installer.

    2.0.0

    Web

    • Add simple ON/OFF toggle. #24
    • Added update strategy when using KiOS. #23
    • A system page which shows system information. #20
    • Heatmap on dashboard page #19
    • Added live stream view on the dashboard page #2
    • Fixed bug cloud syncing #16
    • Fixed broken settings page when space in instane name #16

    Machinery

    • RTSP support for IP-camera’s. #21
    • Verbose logging. #35
    • IO-devices are executed in a seperate thread. #28
    • Live streaming (MJPEG). #26
    • Execute multiple instances on a machine. #24
    • Override config by arguments. #22
    • Move S3 upload to machinery and remove sync-s3 repository. #16

    Docker

    • Added Docker image (x86_x64) to Docker Hub.

    Ecosystem

    • Add support for Raspberry Pi 1, 2 and 3. #1

    1.1.0

    Web

    • Support IP camera’s with MJPEG stream. #3
    • Introduce new API methods to configure the machinery, using basic auth. #4
    • Optimization of loading image and dashboard page, completely redesigned the retrieval of images. #5
    • Optimization of settings page. #5
    • Timebar gradient only works in Chrome. #6
    • Minor CSS fixes for responsive layout.

    Machinery

    • Flip/rotate option for capture devices. #5
    • Support IP camera’s with MJPEG stream. #4
    • Introduced webhook io device. #5

    Cloud

    • Fixed problem when syncing a huge amount of images. #1

    1.0.3

    Web

    • Optimize performance, new datastructure has been implemented.

    Machinery

    • Memory optimization.
    • Removal of images older than 3 days have been removed.
    • Start machinery automatically (delay has been removed).

    Cloud

    • Resolved file exist problem.

    1.0.2

    Web

    • Timezone on settings page is also used for the webinterface.

    Machinery

    • Added extra timezones to timezone.xml.

    1.0.1

    Web

    • Improved error handling (date search).

    Machinery

    • Improved memory cleanup.

    1.0.0

    First commit of Kerberos.io

    • Camera support: USBCamera (V4L), Raspberry Pi camera module (MMAL).
    • Conditions: Enabled (turn on/off Kerberos) and active Time per day.
    • Algorithms: Differential Images.
    • Heuristics: Sequence.
    • Expositors: Select a Hull or Rectangle.
    • Outputs: Write image to Disk, trigger an GPIO output pin and send a TCP/IP packet.
    • Cloud: send your images to the Kerberos.io cloud aplication.

    Edit this page on GitHub

    ← Advanced Installation
    License →
    \ No newline at end of file diff --git a/opensource/upgrade/index.html b/opensource/upgrade/index.html index 91d5deb..41a3ab8 100644 --- a/opensource/upgrade/index.html +++ b/opensource/upgrade/index.html @@ -1,9 +1,9 @@ -Upgrade - Kerberos Docs
    - +Upgrade - Kerberos Docs
    + Kerberos Docs

    Upgrade

    Learn how to maintain and upgrade your Kerberos Open Source agents to a newer version.

    To upgrade your Kerberos agent to a new version you should follow the approach which fits your initial installation method. If you installed KiOS follow the KiOS upgrade procedure, if installed on Raspbian follow the Raspbian upgrade procedure, etc.

    Please note that it might be possible that some new files are added or existing files were updated. To make sure everything works as expected, you should clear your browser cache.

    KiOS

    If you installed KiOS, you can use the built-in upgrade method, fwupdate. The fwupdate command is a shell script which contains a couple of functions. For example it allows you to download, extract and flash a new version of KiOS to your SD card. The process is pretty straight forward.

    First SSH or connect to KiOS first, and execute following command to see your current version.

    fwupdate current
+

    Upgrade

    Learn how to maintain and upgrade your Kerberos Open Source agents to a newer version.

    To upgrade your Kerberos agent to a new version you should follow the approach which fits your initial installation method. If you installed KiOS follow the KiOS upgrade procedure, if installed on Raspbian follow the Raspbian upgrade procedure, etc.

    Please note that it might be possible that some new files are added or existing files were updated. To make sure everything works as expected, you should clear your browser cache.

    KiOS

    If you installed KiOS, you can use the built-in upgrade method, fwupdate. The fwupdate command is a shell script which contains a couple of functions. For example it allows you to download, extract and flash a new version of KiOS to your SD card. The process is pretty straight forward.

    First SSH or connect to KiOS first, and execute following command to see your current version.

    fwupdate current

    Next look for all available versions of KiOS.

    fwupdate versions

    Select the version to which you would like to upgrade, and run following command.

    fwupdate upgrade <version>
-

    KiOS will reboot, and your new version will be available.

    Raspbian

    If you want to install a new version of the Kerberos agent for Raspbian, there is no automated versioning process available like KiOS. To perform an upgrade you’ll need to follow the traditional installation procedure of Raspbian.

    Docker

    When a new release is available, a new Docker image will be available on the Docker hub. You can simply delete your existing container and image, and download it again.

    Edit this page on GitHub

    ← License
    Contribute →
    \ No newline at end of file +

    KiOS will reboot, and your new version will be available.

    Raspbian

    If you want to install a new version of the Kerberos agent for Raspbian, there is no automated versioning process available like KiOS. To perform an upgrade you’ll need to follow the traditional installation procedure of Raspbian.

    Docker

    When a new release is available, a new Docker image will be available on the Docker hub. You can simply delete your existing container and image, and download it again.

    Edit this page on GitHub

    ← License
    Contribute →
    \ No newline at end of file diff --git a/opensource/web/index.html b/opensource/web/index.html index 3a00a65..d359eb0 100644 --- a/opensource/web/index.html +++ b/opensource/web/index.html @@ -1,8 +1,8 @@ -Web - Kerberos Docs
    - +Web - Kerberos Docs
    + Kerberos Docs

    Web

    The web is the front-end for the Kerberos Open Source agent, it allows you to review recordings and update camera settings.

    The web is responsible for the visualization. It’s a GUI which helps the user to find activity at a specific period, configure the machinery, view a live stream, see system information and much more.

    It’s written in PHP using the extremely popular PHP Framework Laravel, and Javascript using the client-side framework BackboneJS. We will discuss the different pages and functionality briefly. Please check out the demo environment if you want to see a real life example.

    Overview

    We will shortly discuss the different pages that make up the web interface of Kerberos Open Source.

    Dashboard

    The landing page of the web is the dashboard. On the dashboard a user will see some statistics: activity per hour, activity per day, a live stream, the latest activity and a heatmap.

    The dashboard gives a high-level overview of your Kerberos Opensource agent.

    The dashboard gives a high-level overview of your Kerberos Opensource agent.

    Overview

    When selecting a specific day, you’ll will get a timeline and overview. By using the timeline you can navigate through a day; the timeline highlights the amount of activity, from gray to red.

    The media page gives an overview of your recordings (grouped into sequences) for that specific day.

    The media page gives an overview of your recordings (grouped into sequences) for that specific day.

    Settings

    The settings page allows you to configure the machinery. You can define the type of camera, post-processes, conditions and much more; it’s highly configurable.

    The settings page allows you to modify and tweak the camera and motion settings.

    The settings page allows you to modify and tweak the camera and motion settings.

    System

    The system page allows you to monitor the system. On this page you’ll get an overview of the system specifications (CPU, Memory, Network, etc). Several actions are available: you can download system information (for debugging purposes) and download or remove your images.

    The system pages show you the current status of your agent.

    The system pages show you the current status of your agent.

    Project structure

    The web interface is using the Laravel framework (version 5.4). There is a lot of documentation related to Laravel, please review their documentation website here. In a nutshell this is how the web is organised.

    Back-end

    • config/app.php - general application settings.
    • config/kerberos.php - this file contains web specific parameters; the user credentials to sign in, etc.
    • app/Http/Controllers - MVC controllers
    • app/Http/Repositories -repositories are injected into the controller.
    • app/Providers/AppServiceProvider.php - bind repositories to a specific interface - dependency injection.
    • routes/api.php - contains all the URI endpoints for Ajax calls.
    • routes/web.php - url routing for pages.

    Front-end

    • public/css/less - LESS is used for the CSS.
    • public/js/app - BackboneJS and RequireJS is used for building modular JS classes.
    • public/js/mustache - Mustache is used for the client-side view rendering.
    • public/js/vendor - This is where the bower extensions are installed.
    • public/capture - A directory where images are written to by default.
    • public/bower.json - The bower extensions used in the web repository.
    • public/Gruntfile.js - We are using Grunt for our task manager.

    API

    If you want to integrate the Kerberos agent with your own application, you’re at the right place! The web interface comes with a RESTfull API, that allows you to retrieve and modify information from the Kerberos agent.

    • Disable the machinery
    • Health check
    • Enable or disable output devices
    • etc.

    Authentication

    To use the RESTfull API of your Kerberos agent you need to define an Authorization header with each request. We use Basic Authentication to secure the different endpoints.

    "Authorization": "Basic root:root"
+

    Web

    The web is the front-end for the Kerberos Open Source agent, it allows you to review recordings and update camera settings.

    The web is responsible for the visualization. It’s a GUI which helps the user to find activity at a specific period, configure the machinery, view a live stream, see system information and much more.

    It’s written in PHP using the extremely popular PHP Framework Laravel, and Javascript using the client-side framework BackboneJS. We will discuss the different pages and functionality briefly. Please check out the demo environment if you want to see a real life example.

    Overview

    We will shortly discuss the different pages that make up the web interface of Kerberos Open Source.

    Dashboard

    The landing page of the web is the dashboard. On the dashboard a user will see some statistics: activity per hour, activity per day, a live stream, the latest activity and a heatmap.

    The dashboard gives a high-level overview of your Kerberos Opensource agent.

    The dashboard gives a high-level overview of your Kerberos Opensource agent.

    Overview

    When selecting a specific day, you’ll will get a timeline and overview. By using the timeline you can navigate through a day; the timeline highlights the amount of activity, from gray to red.

    The media page gives an overview of your recordings (grouped into sequences) for that specific day.

    The media page gives an overview of your recordings (grouped into sequences) for that specific day.

    Settings

    The settings page allows you to configure the machinery. You can define the type of camera, post-processes, conditions and much more; it’s highly configurable.

    The settings page allows you to modify and tweak the camera and motion settings.

    The settings page allows you to modify and tweak the camera and motion settings.

    System

    The system page allows you to monitor the system. On this page you’ll get an overview of the system specifications (CPU, Memory, Network, etc). Several actions are available: you can download system information (for debugging purposes) and download or remove your images.

    The system pages show you the current status of your agent.

    The system pages show you the current status of your agent.

    Project structure

    The web interface is using the Laravel framework (version 5.4). There is a lot of documentation related to Laravel, please review their documentation website here. In a nutshell this is how the web is organised.

    Back-end

    • config/app.php - general application settings.
    • config/kerberos.php - this file contains web specific parameters; the user credentials to sign in, etc.
    • app/Http/Controllers - MVC controllers
    • app/Http/Repositories -repositories are injected into the controller.
    • app/Providers/AppServiceProvider.php - bind repositories to a specific interface - dependency injection.
    • routes/api.php - contains all the URI endpoints for Ajax calls.
    • routes/web.php - url routing for pages.

    Front-end

    • public/css/less - LESS is used for the CSS.
    • public/js/app - BackboneJS and RequireJS is used for building modular JS classes.
    • public/js/mustache - Mustache is used for the client-side view rendering.
    • public/js/vendor - This is where the bower extensions are installed.
    • public/capture - A directory where images are written to by default.
    • public/bower.json - The bower extensions used in the web repository.
    • public/Gruntfile.js - We are using Grunt for our task manager.

    API

    If you want to integrate the Kerberos agent with your own application, you’re at the right place! The web interface comes with a RESTfull API, that allows you to retrieve and modify information from the Kerberos agent.

    • Disable the machinery
    • Health check
    • Enable or disable output devices
    • etc.

    Authentication

    To use the RESTfull API of your Kerberos agent you need to define an Authorization header with each request. We use Basic Authentication to secure the different endpoints.

    "Authorization": "Basic root:root"

    An example with Python looks like this.

    import requests
 import json
 import base64
@@ -60,5 +60,5 @@ print(response.text)

    GET api/v1/system/health

    Description

    Check if the machinery is running (the stream is connected).

    Response

    {
  	"status": "false"
 }
-

    Edit this page on GitHub

    ← Machinery
    \ No newline at end of file +

    Edit this page on GitHub

    ← Machinery
    \ No newline at end of file diff --git a/opensourcev3/announcement/index.html b/opensourcev3/announcement/index.html index f0af2f1..2749c5d 100644 --- a/opensourcev3/announcement/index.html +++ b/opensourcev3/announcement/index.html @@ -1,6 +1,6 @@ -Announcement - Kerberos Docs
    - +Announcement - Kerberos Docs
    + Kerberos Docs

    Announcement

    A new Open Source agent with more features, better performance, and great UX.

    Kerberos Open Source (v3) is the next generation of Kerberos.io, and is the successor of (v1/v2). More specifically it will replace and merge the machinery and web repositories. A switch in technologies and architecture has been made. Version 3 is still under active development, and not yet released. The progress can be followed at the develop branch and project overview.

    What is changing?

    At the bottom line, we are rebuilding the project from scratch using a different technology stack. We are saying goodbye to C++, PHP (Laravel), BackboneJS and saying hello to Golang and React. Despite the technology changes, we are also changing the architecture, we have put in place a couple of years ago. The biggest change is to run the show inside a single repository, and no longer over seperate repos (machinery and web). Read more about this in the FAQ.

    The Opensource version 3 is a complete new rewrite of the version 2.

    The Opensource version 3 is a complete new rewrite of the version 2.

    FAQ

    1. Why a mono repo?

    We have noticed in the past (v1 and v2) splitting the repositories (machinery and web), created a lot of confusion within our community. People didn’t understand the different versions and so on. This caused a lack of collaboration, and made it impossible for some people to collaborate and contribute.

    Having a mono repo, which is well organised, simplifies the entry point for new people who would like to use, understand and/or contribute to Kerberos Open Source.

    2. Why a change in technologies?

    In previous versions (v1 and v2) we used technologies like C++, PHP and BackboneJS. 7 years ago this was still acceptable, however time has changed and new technologies such as React and Golang became very popular.

    Due to previous reason we have decided to rebuild the Kerberos Open Source technology from scratch, taking into account all the feedback we acquired over the years. Having these technologies available, we will enable more people to contribute and use our technology.

    3. What is the difference with Kerberos Enterprise?

    We started the developments of Kerberos Enterprise a year ago (January, 2020), our focus here was scalability, and fast development and easy deployment. We noticed that with technologies such as Golang and React, we can still provide a highly performant video surveillance system.

    Kerberos Open Source will use the same technology stack, and some code pieces, of Kerberos Enterprise which we have already build. We have a very clear now, of how a well developed and documented video surveillance system needs to look like.

    4. When are we going to be able to install the first version?

    We plan to ship the first version by the end of Q1, afterwards we will add more and more features as usual.

    5. Change in License

    Kerberos Open Source (v3) is now available under the MIT license.

    Edit this page on GitHub

    \ No newline at end of file +

    Announcement

    A new Open Source agent with more features, better performance, and great UX.

    Kerberos Open Source (v3) is the next generation of Kerberos.io, and is the successor of (v1/v2). More specifically it will replace and merge the machinery and web repositories. A switch in technologies and architecture has been made. Version 3 is still under active development, and not yet released. The progress can be followed at the develop branch and project overview.

    What is changing?

    At the bottom line, we are rebuilding the project from scratch using a different technology stack. We are saying goodbye to C++, PHP (Laravel), BackboneJS and saying hello to Golang and React. Despite the technology changes, we are also changing the architecture, we have put in place a couple of years ago. The biggest change is to run the show inside a single repository, and no longer over seperate repos (machinery and web). Read more about this in the FAQ.

    The Opensource version 3 is a complete new rewrite of the version 2.

    The Opensource version 3 is a complete new rewrite of the version 2.

    FAQ

    1. Why a mono repo?

    We have noticed in the past (v1 and v2) splitting the repositories (machinery and web), created a lot of confusion within our community. People didn’t understand the different versions and so on. This caused a lack of collaboration, and made it impossible for some people to collaborate and contribute.

    Having a mono repo, which is well organised, simplifies the entry point for new people who would like to use, understand and/or contribute to Kerberos Open Source.

    2. Why a change in technologies?

    In previous versions (v1 and v2) we used technologies like C++, PHP and BackboneJS. 7 years ago this was still acceptable, however time has changed and new technologies such as React and Golang became very popular.

    Due to previous reason we have decided to rebuild the Kerberos Open Source technology from scratch, taking into account all the feedback we acquired over the years. Having these technologies available, we will enable more people to contribute and use our technology.

    3. What is the difference with Kerberos Enterprise?

    We started the developments of Kerberos Enterprise a year ago (January, 2020), our focus here was scalability, and fast development and easy deployment. We noticed that with technologies such as Golang and React, we can still provide a highly performant video surveillance system.

    Kerberos Open Source will use the same technology stack, and some code pieces, of Kerberos Enterprise which we have already build. We have a very clear now, of how a well developed and documented video surveillance system needs to look like.

    4. When are we going to be able to install the first version?

    We plan to ship the first version by the end of Q1, afterwards we will add more and more features as usual.

    5. Change in License

    Kerberos Open Source (v3) is now available under the MIT license.

    Edit this page on GitHub

    \ No newline at end of file diff --git a/opensourcev3/index.html b/opensourcev3/index.html index 0c41a13..f503a8f 100644 --- a/opensourcev3/index.html +++ b/opensourcev3/index.html @@ -1,6 +1,6 @@ -Opensource v3 - Kerberos Docs
    - +Opensource v3 - Kerberos Docs
    + Kerberos Docs
    \ No newline at end of file +
    \ No newline at end of file diff --git a/opensourcev3/index.xml b/opensourcev3/index.xml index b058564..3c5fb2c 100644 --- a/opensourcev3/index.xml +++ b/opensourcev3/index.xml @@ -1,2 +1,2 @@ -Opensource v3 onhttps://staging.doc.kerberos.live/opensourcev3/Recent content in Opensource v3 onHugo -- gohugo.ioen-USTue, 06 Oct 2020 08:49:15 +0000Announcementhttps://staging.doc.kerberos.live/opensourcev3/announcement/Tue, 06 Oct 2020 08:49:31 +0000https://staging.doc.kerberos.live/opensourcev3/announcement/Kerberos Open Source (v3) is the next generation of Kerberos.io, and is the successor of (v1/v2). More specifically it will replace and merge the machinery and web repositories. A switch in technologies and architecture has been made. Version 3 is still under active development, and not yet released. The progress can be followed at the develop branch and project overview. +Opensource v3 onhttps://doc.kerberos.io/opensourcev3/Recent content in Opensource v3 onHugo -- gohugo.ioen-USTue, 06 Oct 2020 08:49:15 +0000Announcementhttps://doc.kerberos.io/opensourcev3/announcement/Tue, 06 Oct 2020 08:49:31 +0000https://doc.kerberos.io/opensourcev3/announcement/Kerberos Open Source (v3) is the next generation of Kerberos.io, and is the successor of (v1/v2). More specifically it will replace and merge the machinery and web repositories. A switch in technologies and architecture has been made. Version 3 is still under active development, and not yet released. The progress can be followed at the develop branch and project overview. What is changing? At the bottom line, we are rebuilding the project from scratch using a different technology stack. \ No newline at end of file diff --git a/prologue/deployments/index.html b/prologue/deployments/index.html index 30fe782..ec07181 100644 --- a/prologue/deployments/index.html +++ b/prologue/deployments/index.html @@ -1,6 +1,6 @@ -Deployments - Kerberos Docs
    - +Deployments - Kerberos Docs
    + Kerberos Docs

    Deployments

    Discover the different deployments and use cases, learn more about the architecture.

    In this section we will explain some usecases and best practices, which might help you to define the architecture that fits your needs.

    Please read the introduction page first, before moving forward.

    When starting with Kerberos you might ask yourself, how should I deploy these so called, Kerberos agents? Well, there are different options. You can install a Kerberos agent on a Raspberry Pi, VM, Server or even in a Kubernetes cluster. So what should you do, and when? Let’s have a closer look at the different options.

    The first thing you need to consider is the environment, in which you want to deploy your Kerberos agents. Is it inside your house, your company or at a public place? Another important factor is the number of surveillance cameras you would like to monitor, and if you have any high availability requirements.

    Agents on-premise

    The most common scenario is to install your Kerberos agents on-premise. This has a couple of benefits such as latency, bandwidth and a less complex security model. When installing a Kerberos agent on-premise, you have a couple of different options.

    Less than 5 cameras

    If you have a limited number of surveillance cameras you would like to monitor, and don’t have any high availability requirements, the Kerberos Open Source agent is a good choice. For example, you can install the Kerberos Open Source agent on a Raspberry Pi, by using KiOS, Raspbian OS or compile it from source.

    On below architecture, a couple of Kerberos agents are installed on-premise (inside the local network). A Kerberos agent is installed for each surveillance camera, and each Kerberos agent runs on a seperate host (Raspberry Pi, VM, etc). The web interface of the Kerberos agents can be reached from the internal network, but cannot be accessed from the cloud.

    Having just a single or two camera(s) to be monitored then Kerberos Opensource might be the right choice.

    Having just a single or two camera(s) to be monitored then Kerberos Opensource might be the right choice.

    Another option to install the Kerberos Open Source agent is to use Docker. Instead of having seperate hosts for each Kerberos agent, you will have a single host (Docker host) with multiple Docker containers. A Docker container is deployed for each surveillance camera, which contains the software to run the Kerberos agent.

    Running your Kerberos agents inside Docker containers, allows you to process multiple surveillance cameras using only one host.

    Having just a few of cameras to be monitored then Kerberos Opensource with Docker might be the right choice.

    Having just a few of cameras to be monitored then Kerberos Opensource with Docker might be the right choice.

    More than 5 cameras

    When working within an enterprise context, where you require high availability and have a large amount of surveillance cameras being monitored, Kerberos Enterprise is a good choice. Im comparison to the Open Source version, Kerberos Enterprise uses Kubernetes to help you scale (and secure) your video surveillance landscape. Kerberos agents, or Kubernetes deployments, are deployed inside your cluster and load balanced over the different nodes. When a Kerberos agent dies, or the node on which the deployment is running, Kubernetes will reschedule it to another healthy node.

    When you start having bigger deployments it's recommended to go with a Kubernetes approach.

    When you start having bigger deployments it’s recommended to go with a Kubernetes approach.

    Agents in the cloud

    Instead of processing your surveillance cameras on-premise you could also process them in the cloud. There are a couple advantages, for example, you don’t have to manage your own hardware, you can simply spin up a VM on one of the hyperscalers, and add it to your existing cluster.

    When dealing with Kerberos agents in the cloud, the complexity starts with the security model. As your surveillance cameras are running somewhere on-premise, you will need to make them available to your Kerberos agents, which are running in the cloud. There are several ways to do that, such as port forwarding (not recommended) or setting up a site-to-site VPN (recommended).

    When setting up a VPN connection you will expose your surveillance cameras to your Kerberos agents. Once you’ve configured the Kerberos agents, data will flow through this secure tunnel, from on-premise to your cloud enviroment.

    Less than 5 cameras

    If you have a limited number of surveillance cameras you would like to monitor, and don’t have any high availability requirements, the Kerberos Open Source agent is a good choice. You can install the Kerberos Open Source agent on Docker. Instead of having seperate VM’s for each Kerberos agent, you will have a single VM (Docker host) with multiple Docker containers. A Docker container is deployed for each surveillance camera, which contains the software to run the Kerberos agent.

    By using port forwarding or a VPN tunnel you can start processing your camera streams in the cloud.

    By using port forwarding or a VPN tunnel you can start processing your camera streams in the cloud.

    More than 5 cameras

    Similar to Kerberos Enterprise on-premise, you can run the a Kubernetes in the cloud. The exact same solution is available, only the way how you connect to your video surveillance cameras will be different, as they will probably live in a different network. To make this work you will need to setup a VPN tunnel (or whatever your security teams have defined as a back practice). When Kerberos Enterprise is deployed to the cloud, it can be used any where. Public cloud (AWS, Google, Azure, etc) or private cloud. You can run it where you want.

    As previous mentioned you could process them in a Kubernetes cluster in the cloud.

    As previous mentioned you could process them in a Kubernetes cluster in the cloud.

    Kerberos Hub

    Once you’ve configured one of the previously mentioned architectures, you will have one or more Kerberos agents running, in the cloud or on-premise.

    The Kerberos Open Source agent comes with a web interface, which makes it possible to review the activity for that specific agent; they don’t have a consolidated overview. This means that you will need to open multiple web interfaces, one for Kerberos agent. In contrary Kerberos Enterprise agents, don’t come with a web interface, therefore the Kerberos Hub (public or private edition) is recommended.

    To simplify this process and resolve some other challenges, Kerberos Hub was developed.

    Kerberos Hub is a cloud solution which allows you to have a single overview of all the media recordings generated by your surveillance cameras. It’s not a solution for processing your surveillance cameras in the cloud. For processing of your surveillance cameras, a Kerberos agent is used.

    A brief list of the key features of Kerberos Hub are:

    • Secured storage
    • Consolidated overview
    • Advanced searching
    • Machine learning
    • Alerts
    • Live streaming
    • Accounts
    • Logging

    Checkout the demo environment to see and feel the Kerberos Hub solution yourself.

    Architecture

    A simplified architecture is found below. In this architecture the Kerberos agents are installed on-premise (but this could also be in the cloud), next to the surveillance cameras. Once one of the agents recorded a footage it will send the recording to our Kerberos Vault service, using the credentials you’ve defined inside the agent.

    As soon as the recording is successfully received several engines will be executed, that will further process the recording and extract metadata from it (classification, origin of the surveillance camera, etc). A lot of processing is happening behind the scenes.

    By using a browser you can navigate to Kerberos Hub, and review all the recordings made by the Kerberos agents on-premise. On top of that you will receive more context about the recordings, get notifications, view a livestream and much more. Read more about Kerberos Hub.

    As previous mentioned you could process them in a Kubernetes cluster in the cloud.

    As previous mentioned you could process them in a Kubernetes cluster in the cloud.

    Edit this page on GitHub

    ← How it works
    Glossary →
    \ No newline at end of file +

    Deployments

    Discover the different deployments and use cases, learn more about the architecture.

    In this section we will explain some usecases and best practices, which might help you to define the architecture that fits your needs.

    Please read the introduction page first, before moving forward.

    When starting with Kerberos you might ask yourself, how should I deploy these so called, Kerberos agents? Well, there are different options. You can install a Kerberos agent on a Raspberry Pi, VM, Server or even in a Kubernetes cluster. So what should you do, and when? Let’s have a closer look at the different options.

    The first thing you need to consider is the environment, in which you want to deploy your Kerberos agents. Is it inside your house, your company or at a public place? Another important factor is the number of surveillance cameras you would like to monitor, and if you have any high availability requirements.

    Agents on-premise

    The most common scenario is to install your Kerberos agents on-premise. This has a couple of benefits such as latency, bandwidth and a less complex security model. When installing a Kerberos agent on-premise, you have a couple of different options.

    Less than 5 cameras

    If you have a limited number of surveillance cameras you would like to monitor, and don’t have any high availability requirements, the Kerberos Open Source agent is a good choice. For example, you can install the Kerberos Open Source agent on a Raspberry Pi, by using KiOS, Raspbian OS or compile it from source.

    On below architecture, a couple of Kerberos agents are installed on-premise (inside the local network). A Kerberos agent is installed for each surveillance camera, and each Kerberos agent runs on a seperate host (Raspberry Pi, VM, etc). The web interface of the Kerberos agents can be reached from the internal network, but cannot be accessed from the cloud.

    Having just a single or two camera(s) to be monitored then Kerberos Opensource might be the right choice.

    Having just a single or two camera(s) to be monitored then Kerberos Opensource might be the right choice.

    Another option to install the Kerberos Open Source agent is to use Docker. Instead of having seperate hosts for each Kerberos agent, you will have a single host (Docker host) with multiple Docker containers. A Docker container is deployed for each surveillance camera, which contains the software to run the Kerberos agent.

    Running your Kerberos agents inside Docker containers, allows you to process multiple surveillance cameras using only one host.

    Having just a few of cameras to be monitored then Kerberos Opensource with Docker might be the right choice.

    Having just a few of cameras to be monitored then Kerberos Opensource with Docker might be the right choice.

    More than 5 cameras

    When working within an enterprise context, where you require high availability and have a large amount of surveillance cameras being monitored, Kerberos Enterprise is a good choice. Im comparison to the Open Source version, Kerberos Enterprise uses Kubernetes to help you scale (and secure) your video surveillance landscape. Kerberos agents, or Kubernetes deployments, are deployed inside your cluster and load balanced over the different nodes. When a Kerberos agent dies, or the node on which the deployment is running, Kubernetes will reschedule it to another healthy node.

    When you start having bigger deployments it's recommended to go with a Kubernetes approach.

    When you start having bigger deployments it’s recommended to go with a Kubernetes approach.

    Agents in the cloud

    Instead of processing your surveillance cameras on-premise you could also process them in the cloud. There are a couple advantages, for example, you don’t have to manage your own hardware, you can simply spin up a VM on one of the hyperscalers, and add it to your existing cluster.

    When dealing with Kerberos agents in the cloud, the complexity starts with the security model. As your surveillance cameras are running somewhere on-premise, you will need to make them available to your Kerberos agents, which are running in the cloud. There are several ways to do that, such as port forwarding (not recommended) or setting up a site-to-site VPN (recommended).

    When setting up a VPN connection you will expose your surveillance cameras to your Kerberos agents. Once you’ve configured the Kerberos agents, data will flow through this secure tunnel, from on-premise to your cloud enviroment.

    Less than 5 cameras

    If you have a limited number of surveillance cameras you would like to monitor, and don’t have any high availability requirements, the Kerberos Open Source agent is a good choice. You can install the Kerberos Open Source agent on Docker. Instead of having seperate VM’s for each Kerberos agent, you will have a single VM (Docker host) with multiple Docker containers. A Docker container is deployed for each surveillance camera, which contains the software to run the Kerberos agent.

    By using port forwarding or a VPN tunnel you can start processing your camera streams in the cloud.

    By using port forwarding or a VPN tunnel you can start processing your camera streams in the cloud.

    More than 5 cameras

    Similar to Kerberos Enterprise on-premise, you can run the a Kubernetes in the cloud. The exact same solution is available, only the way how you connect to your video surveillance cameras will be different, as they will probably live in a different network. To make this work you will need to setup a VPN tunnel (or whatever your security teams have defined as a back practice). When Kerberos Enterprise is deployed to the cloud, it can be used any where. Public cloud (AWS, Google, Azure, etc) or private cloud. You can run it where you want.

    As previous mentioned you could process them in a Kubernetes cluster in the cloud.

    As previous mentioned you could process them in a Kubernetes cluster in the cloud.

    Kerberos Hub

    Once you’ve configured one of the previously mentioned architectures, you will have one or more Kerberos agents running, in the cloud or on-premise.

    The Kerberos Open Source agent comes with a web interface, which makes it possible to review the activity for that specific agent; they don’t have a consolidated overview. This means that you will need to open multiple web interfaces, one for Kerberos agent. In contrary Kerberos Enterprise agents, don’t come with a web interface, therefore the Kerberos Hub (public or private edition) is recommended.

    To simplify this process and resolve some other challenges, Kerberos Hub was developed.

    Kerberos Hub is a cloud solution which allows you to have a single overview of all the media recordings generated by your surveillance cameras. It’s not a solution for processing your surveillance cameras in the cloud. For processing of your surveillance cameras, a Kerberos agent is used.

    A brief list of the key features of Kerberos Hub are:

    • Secured storage
    • Consolidated overview
    • Advanced searching
    • Machine learning
    • Alerts
    • Live streaming
    • Accounts
    • Logging

    Checkout the demo environment to see and feel the Kerberos Hub solution yourself.

    Architecture

    A simplified architecture is found below. In this architecture the Kerberos agents are installed on-premise (but this could also be in the cloud), next to the surveillance cameras. Once one of the agents recorded a footage it will send the recording to our Kerberos Vault service, using the credentials you’ve defined inside the agent.

    As soon as the recording is successfully received several engines will be executed, that will further process the recording and extract metadata from it (classification, origin of the surveillance camera, etc). A lot of processing is happening behind the scenes.

    By using a browser you can navigate to Kerberos Hub, and review all the recordings made by the Kerberos agents on-premise. On top of that you will receive more context about the recordings, get notifications, view a livestream and much more. Read more about Kerberos Hub.

    As previous mentioned you could process them in a Kubernetes cluster in the cloud.

    As previous mentioned you could process them in a Kubernetes cluster in the cloud.

    Edit this page on GitHub

    ← How it works
    Glossary →
    \ No newline at end of file diff --git a/prologue/glossary/index.html b/prologue/glossary/index.html index 0070305..57d91e0 100644 --- a/prologue/glossary/index.html +++ b/prologue/glossary/index.html @@ -1,6 +1,6 @@ -Glossary - Kerberos Docs
    - +Glossary - Kerberos Docs
    + Kerberos Docs

    Glossary

    A better understanding of the Kerberos Ecosystem.

    While working in the Kerberos Ecosystem, specific words and sentences become to start feel natural. Unfortunately that’s not the case for everyone, that’s why we added and updated this glossary page, to anyone can come back to this if he would require more detailed explanation.

    Agent

    An agent is a collection of binaries, shipped in different forms such as Docker, Balena, etc). It executes specific tasks related to the camera processing, monitoring, configuration and reviewing.

    There are two types of agents: an Open Source agent and an Enterprise agent.

    Open Source agent

    The Open Source agent …

    Enterprise agent

    The Enterprise agent …

    Edit this page on GitHub

    ← Deployments
    \ No newline at end of file +

    Glossary

    A better understanding of the Kerberos Ecosystem.

    While working in the Kerberos Ecosystem, specific words and sentences become to start feel natural. Unfortunately that’s not the case for everyone, that’s why we added and updated this glossary page, to anyone can come back to this if he would require more detailed explanation.

    Agent

    An agent is a collection of binaries, shipped in different forms such as Docker, Balena, etc). It executes specific tasks related to the camera processing, monitoring, configuration and reviewing.

    There are two types of agents: an Open Source agent and an Enterprise agent.

    Open Source agent

    The Open Source agent …

    Enterprise agent

    The Enterprise agent …

    Edit this page on GitHub

    ← Deployments
    \ No newline at end of file diff --git a/prologue/how/index.html b/prologue/how/index.html index df9bdb2..5efc2f1 100644 --- a/prologue/how/index.html +++ b/prologue/how/index.html @@ -1,6 +1,6 @@ -How it works - Kerberos Docs
    - +How it works - Kerberos Docs
    + Kerberos Docs

    How it works

    How Kerberos.io works, and the different building blocks.

    When you install Kerberos Open Source or Kerberos Enterprise we will refer to it as the Kerberos Agent. A Kerberos Agent, is a software solution that consist of two pieces: Front-End and Back-End. The Back-End processes the video stream of a single surveillance camera, makes recordings and takes actions (for example sending notifications). The Front-End allows you to review recordings, and configure the Back-End.

    A Kerberos agent consists of both a backend en frontend.

    A Kerberos agent consists of both a backend en frontend.

    Front-End

    The Kerberos Agent ships with a web interface (Front-End) and a video processing engine (Back-End). The Front-End allows the user to modify specific settings, and if Kerberos Open Source, watch recordings in a easy-to-use interface; The Front-End for Kerberos Enterprise is only for configuration purposes only.

    Back-End

    The Back-End piece of the Kerberos Agent is a service that processes the camera feed with computer vision algorithms to detect motion, and makes recordings and/or execute specific actions. Kerberos Enterprise supports any type of IP-camera (RTSP/ONVIF), and Kerberos Open Source also adds support for USB (V4L2) and the popular Raspberry Pi camera.

    Depending on which Kerberos Agent, Kerberos Open Source or Kerberos Enterprise, you will have different installation methods. If you would like to learn more about the Kerberos Agent, have a look in the related sections: Open Source, Enterprise.

    Open Source vs Enterprise

    The Kerberos project started as an Open Source project, with a main focus on low-cost devices such as the Raspberry Pi. Later on the Open Source version was bundled inside the Docker technology so that it was easier to distribute. Anyone can use the Open Source version for personal usage.

    Enterprises are more demanding, and have a lot of surveillance cameras, therefore they need a scalable surveillance system. The Enterprise edition of Kerberos allows you to operate a video surveillance cluster (Kubernetes) on-premise or in the cloud (AWS/GCP/Azure).

    The different deployment options for Opensource and Enterprise agent.

    The different deployment options for Opensource and Enterprise agent.

    The Open Source and Enterprise edition are significantly different from a source code point of view. The Enterprise edition is a complete rewrite of the Open Source version, and got all the best practices we discovered over the years implemented. Both version are and will remain updated in the future.

    Kerberos Vault

    Users or Enteprises which only have a few surveillance cameras to manage, probably will be fine with Kerberos Open Source. On top of that they might include Kerberos Cloud for remote access and monitoring.

    On the other hand if you plan to manage a larger network of surveillance cameras, you will have to look into Kerberos Enterprise. Backed up with Kubernetes, Kerberos Enterprise, will give you the real super powers to your scale surveillance camera landscape. Kerberos Enterprise comes with a Front-End to manage and scale your deployments inside a Kubernetes Cluster.

    Kerberos Enterprise leverages a service called, Kerberos Vault, for central and hybrid storage. Kerberos Vault implements the concept of BYOC (Bring Your Own Cloud). By selecting a cloud provider (AWS, GCP, AZURE) or on-premise (Minio) you can bring your recordings where you them to be.

    In addition to the concept of BYOC, Kerberos Vault enables you to connect to Kerberos Cloud (with your own storage), send events to message brokers (such as Kafka or SQS) and enables you to build custom apps or services (such as a custom machine learning service).

    Kerberos Vault allows you to bring your own storage, and build extensions and integrations.

    Kerberos Vault allows you to bring your own storage, and build extensions and integrations.

    Kerberos Hub

    When installing a Kerberos Agent inside your local network, it’s possible to review your activity by using the agent its web interface. By all network principles, having a local setup, you will not be able to access the web interface from the cloud (outside your local network). On top of that, the Kerberos Agent doesn’t come with a consolidated overview. This means that you will need to open multiple web interfaces, one for each connected surveillance camera. To simplify and resolve all of these challenges, Kerberos Cloud was developed.

    A Kerberos agent consists of both a backend en frontend.

    A Kerberos agent consists of both a backend en frontend.

    Edit this page on GitHub

    Deployments →
    \ No newline at end of file +

    How it works

    How Kerberos.io works, and the different building blocks.

    When you install Kerberos Open Source or Kerberos Enterprise we will refer to it as the Kerberos Agent. A Kerberos Agent, is a software solution that consist of two pieces: Front-End and Back-End. The Back-End processes the video stream of a single surveillance camera, makes recordings and takes actions (for example sending notifications). The Front-End allows you to review recordings, and configure the Back-End.

    A Kerberos agent consists of both a backend en frontend.

    A Kerberos agent consists of both a backend en frontend.

    Front-End

    The Kerberos Agent ships with a web interface (Front-End) and a video processing engine (Back-End). The Front-End allows the user to modify specific settings, and if Kerberos Open Source, watch recordings in a easy-to-use interface; The Front-End for Kerberos Enterprise is only for configuration purposes only.

    Back-End

    The Back-End piece of the Kerberos Agent is a service that processes the camera feed with computer vision algorithms to detect motion, and makes recordings and/or execute specific actions. Kerberos Enterprise supports any type of IP-camera (RTSP/ONVIF), and Kerberos Open Source also adds support for USB (V4L2) and the popular Raspberry Pi camera.

    Depending on which Kerberos Agent, Kerberos Open Source or Kerberos Enterprise, you will have different installation methods. If you would like to learn more about the Kerberos Agent, have a look in the related sections: Open Source, Enterprise.

    Open Source vs Enterprise

    The Kerberos project started as an Open Source project, with a main focus on low-cost devices such as the Raspberry Pi. Later on the Open Source version was bundled inside the Docker technology so that it was easier to distribute. Anyone can use the Open Source version for personal usage.

    Enterprises are more demanding, and have a lot of surveillance cameras, therefore they need a scalable surveillance system. The Enterprise edition of Kerberos allows you to operate a video surveillance cluster (Kubernetes) on-premise or in the cloud (AWS/GCP/Azure).

    The different deployment options for Opensource and Enterprise agent.

    The different deployment options for Opensource and Enterprise agent.

    The Open Source and Enterprise edition are significantly different from a source code point of view. The Enterprise edition is a complete rewrite of the Open Source version, and got all the best practices we discovered over the years implemented. Both version are and will remain updated in the future.

    Kerberos Vault

    Users or Enteprises which only have a few surveillance cameras to manage, probably will be fine with Kerberos Open Source. On top of that they might include Kerberos Cloud for remote access and monitoring.

    On the other hand if you plan to manage a larger network of surveillance cameras, you will have to look into Kerberos Enterprise. Backed up with Kubernetes, Kerberos Enterprise, will give you the real super powers to your scale surveillance camera landscape. Kerberos Enterprise comes with a Front-End to manage and scale your deployments inside a Kubernetes Cluster.

    Kerberos Enterprise leverages a service called, Kerberos Vault, for central and hybrid storage. Kerberos Vault implements the concept of BYOC (Bring Your Own Cloud). By selecting a cloud provider (AWS, GCP, AZURE) or on-premise (Minio) you can bring your recordings where you them to be.

    In addition to the concept of BYOC, Kerberos Vault enables you to connect to Kerberos Cloud (with your own storage), send events to message brokers (such as Kafka or SQS) and enables you to build custom apps or services (such as a custom machine learning service).

    Kerberos Vault allows you to bring your own storage, and build extensions and integrations.

    Kerberos Vault allows you to bring your own storage, and build extensions and integrations.

    Kerberos Hub

    When installing a Kerberos Agent inside your local network, it’s possible to review your activity by using the agent its web interface. By all network principles, having a local setup, you will not be able to access the web interface from the cloud (outside your local network). On top of that, the Kerberos Agent doesn’t come with a consolidated overview. This means that you will need to open multiple web interfaces, one for each connected surveillance camera. To simplify and resolve all of these challenges, Kerberos Cloud was developed.

    A Kerberos agent consists of both a backend en frontend.

    A Kerberos agent consists of both a backend en frontend.

    Edit this page on GitHub

    Deployments →
    \ No newline at end of file diff --git a/prologue/index.html b/prologue/index.html index 3847c31..652cffb 100644 --- a/prologue/index.html +++ b/prologue/index.html @@ -1,6 +1,6 @@ -Prologue - Kerberos Docs
    - +Prologue - Kerberos Docs
    + Kerberos Docs
    \ No newline at end of file +
    \ No newline at end of file diff --git a/prologue/index.xml b/prologue/index.xml index e79ee82..9d2f36e 100644 --- a/prologue/index.xml +++ b/prologue/index.xml @@ -1,5 +1,5 @@ -Prologue onhttps://staging.doc.kerberos.live/prologue/Recent content in Prologue onHugo -- gohugo.ioen-USTue, 06 Oct 2020 08:48:45 +0000How it workshttps://staging.doc.kerberos.live/prologue/how/Tue, 06 Oct 2020 08:48:57 +0000https://staging.doc.kerberos.live/prologue/how/When you install Kerberos Open Source or Kerberos Enterprise we will refer to it as the Kerberos Agent. A Kerberos Agent, is a software solution that consist of two pieces: Front-End and Back-End. The Back-End processes the video stream of a single surveillance camera, makes recordings and takes actions (for example sending notifications). The Front-End allows you to review recordings, and configure the Back-End. -A Kerberos agent consists of both a backend en frontend.Deploymentshttps://staging.doc.kerberos.live/prologue/deployments/Tue, 06 Oct 2020 08:48:57 +0000https://staging.doc.kerberos.live/prologue/deployments/In this section we will explain some usecases and best practices, which might help you to define the architecture that fits your needs. +Prologue onhttps://doc.kerberos.io/prologue/Recent content in Prologue onHugo -- gohugo.ioen-USTue, 06 Oct 2020 08:48:45 +0000How it workshttps://doc.kerberos.io/prologue/how/Tue, 06 Oct 2020 08:48:57 +0000https://doc.kerberos.io/prologue/how/When you install Kerberos Open Source or Kerberos Enterprise we will refer to it as the Kerberos Agent. A Kerberos Agent, is a software solution that consist of two pieces: Front-End and Back-End. The Back-End processes the video stream of a single surveillance camera, makes recordings and takes actions (for example sending notifications). The Front-End allows you to review recordings, and configure the Back-End. +A Kerberos agent consists of both a backend en frontend.Deploymentshttps://doc.kerberos.io/prologue/deployments/Tue, 06 Oct 2020 08:48:57 +0000https://doc.kerberos.io/prologue/deployments/In this section we will explain some usecases and best practices, which might help you to define the architecture that fits your needs. Please read the introduction page first, before moving forward. -When starting with Kerberos you might ask yourself, how should I deploy these so called, Kerberos agents? Well, there are different options. You can install a Kerberos agent on a Raspberry Pi, VM, Server or even in a Kubernetes cluster.Glossaryhttps://staging.doc.kerberos.live/prologue/glossary/Tue, 06 Oct 2020 08:48:57 +0000https://staging.doc.kerberos.live/prologue/glossary/While working in the Kerberos Ecosystem, specific words and sentences become to start feel natural. Unfortunately that&rsquo;s not the case for everyone, that&rsquo;s why we added and updated this glossary page, to anyone can come back to this if he would require more detailed explanation. +When starting with Kerberos you might ask yourself, how should I deploy these so called, Kerberos agents? Well, there are different options. You can install a Kerberos agent on a Raspberry Pi, VM, Server or even in a Kubernetes cluster.Glossaryhttps://doc.kerberos.io/prologue/glossary/Tue, 06 Oct 2020 08:48:57 +0000https://doc.kerberos.io/prologue/glossary/While working in the Kerberos Ecosystem, specific words and sentences become to start feel natural. Unfortunately that&rsquo;s not the case for everyone, that&rsquo;s why we added and updated this glossary page, to anyone can come back to this if he would require more detailed explanation. Agent An agent is a collection of binaries, shipped in different forms such as Docker, Balena, etc). It executes specific tasks related to the camera processing, monitoring, configuration and reviewing. \ No newline at end of file diff --git a/robots.txt b/robots.txt index 7f7002c..bd0cb36 100644 --- a/robots.txt +++ b/robots.txt @@ -1,4 +1,4 @@ User-agent: * Allow: / -Sitemap: https://staging.doc.kerberos.live/sitemap.xml \ No newline at end of file +Sitemap: https://doc.kerberos.io/sitemap.xml \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml index df512d1..5e17e72 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -1 +1 @@ -/2020-10-06T08:48:57+00:00weekly0.5/prologue/how/2020-10-06T08:48:57+00:00weekly0.5/prologue/deployments/2020-10-06T08:48:57+00:00weekly0.5/prologue/glossary/2020-10-06T08:48:57+00:00weekly0.5/opensource/first-things-first/2020-10-06T08:49:31+00:00weekly0.5/opensource/get-started/2020-10-06T08:49:31+00:00weekly0.5/opensource/installation/2020-10-06T08:49:31+00:00weekly0.5/opensource/installation-advanced/2020-10-06T08:49:31+00:00weekly0.5/opensource/releases/2020-10-06T08:49:31+00:00weekly0.5/opensource/license/2020-10-06T08:49:31+00:00weekly0.5/opensource/upgrade/2020-10-06T08:49:31+00:00weekly0.5/opensource/contribute/2020-10-06T08:49:31+00:00weekly0.5/opensource/machinery/2020-10-06T08:49:31+00:00weekly0.5/opensource/web/2020-10-06T08:49:31+00:00weekly0.5/opensourcev3/announcement/2020-10-06T08:49:31+00:00weekly0.5/enterprise/first-things-first/2020-10-06T08:49:31+00:00weekly0.5/hub/first-things-first/2020-10-06T08:49:31+00:00weekly0.5/vault/first-things-first/2020-10-06T08:49:31+00:00weekly0.5/enterprise/get-started/2020-10-06T08:49:31+00:00weekly0.5/vault/get-started/2020-10-06T08:49:31+00:00weekly0.5/enterprise/installation/2020-10-06T08:49:31+00:00weekly0.5/vault/installation/2020-10-06T08:49:31+00:00weekly0.5/enterprise/installation-cloud/2020-10-06T08:49:31+00:00weekly0.5/vault/installation-cloud/2020-10-06T08:49:31+00:00weekly0.5/enterprise/installation-edge/2020-10-06T08:49:31+00:00weekly0.5/vault/installation-edge/2020-10-06T08:49:31+00:00weekly0.5/vault/providers/2020-10-06T08:49:31+00:00weekly0.5/enterprise/releases/2020-10-06T08:49:31+00:00weekly0.5/vault/recycle/2020-10-06T08:49:31+00:00weekly0.5/vault/releases/releases/2020-10-06T08:49:31+00:00weekly0.5/enterprise/2020-10-06T08:49:15+00:00weekly0.5/hub/2020-10-06T08:49:15+00:00weekly0.5/vault/2020-10-06T08:49:15+00:00weekly0.5/help/2020-10-06T08:49:15+00:00weekly0.5/opensource/2020-10-06T08:49:15+00:00weekly0.5/opensourcev3/2020-10-06T08:49:15+00:00weekly0.5/prologue/2020-10-06T08:48:45+00:00weekly0.5/contributors/weekly0.5 \ No newline at end of file +/2020-10-06T08:48:57+00:00weekly0.5/prologue/how/2020-10-06T08:48:57+00:00weekly0.5/prologue/deployments/2020-10-06T08:48:57+00:00weekly0.5/prologue/glossary/2020-10-06T08:48:57+00:00weekly0.5/opensource/first-things-first/2020-10-06T08:49:31+00:00weekly0.5/opensource/get-started/2020-10-06T08:49:31+00:00weekly0.5/opensource/installation/2020-10-06T08:49:31+00:00weekly0.5/opensource/installation-advanced/2020-10-06T08:49:31+00:00weekly0.5/opensource/releases/2020-10-06T08:49:31+00:00weekly0.5/opensource/license/2020-10-06T08:49:31+00:00weekly0.5/opensource/upgrade/2020-10-06T08:49:31+00:00weekly0.5/opensource/contribute/2020-10-06T08:49:31+00:00weekly0.5/opensource/machinery/2020-10-06T08:49:31+00:00weekly0.5/opensource/web/2020-10-06T08:49:31+00:00weekly0.5/opensourcev3/announcement/2020-10-06T08:49:31+00:00weekly0.5/enterprise/first-things-first/2020-10-06T08:49:31+00:00weekly0.5/hub/first-things-first/2020-10-06T08:49:31+00:00weekly0.5/vault/first-things-first/2020-10-06T08:49:31+00:00weekly0.5/enterprise/get-started/2020-10-06T08:49:31+00:00weekly0.5/vault/get-started/2020-10-06T08:49:31+00:00weekly0.5/enterprise/installation/2020-10-06T08:49:31+00:00weekly0.5/vault/installation/2020-10-06T08:49:31+00:00weekly0.5/enterprise/installation-cloud/2020-10-06T08:49:31+00:00weekly0.5/vault/installation-cloud/2020-10-06T08:49:31+00:00weekly0.5/enterprise/installation-edge/2020-10-06T08:49:31+00:00weekly0.5/vault/installation-edge/2020-10-06T08:49:31+00:00weekly0.5/vault/providers/2020-10-06T08:49:31+00:00weekly0.5/enterprise/releases/2020-10-06T08:49:31+00:00weekly0.5/vault/recycle/2020-10-06T08:49:31+00:00weekly0.5/vault/releases/releases/2020-10-06T08:49:31+00:00weekly0.5/enterprise/2020-10-06T08:49:15+00:00weekly0.5/hub/2020-10-06T08:49:15+00:00weekly0.5/vault/2020-10-06T08:49:15+00:00weekly0.5/help/2020-10-06T08:49:15+00:00weekly0.5/opensource/2020-10-06T08:49:15+00:00weekly0.5/opensourcev3/2020-10-06T08:49:15+00:00weekly0.5/prologue/2020-10-06T08:48:45+00:00weekly0.5/categories/weekly0.5/contributors/weekly0.5/tags/weekly0.5 \ No newline at end of file diff --git a/tags/index.html b/tags/index.html new file mode 100644 index 0000000..65b3a62 --- /dev/null +++ b/tags/index.html @@ -0,0 +1,6 @@ +Tags - Kerberos Docs
    + +Kerberos Docs +

    Tags

    \ No newline at end of file diff --git a/tags/index.xml b/tags/index.xml new file mode 100644 index 0000000..519158f --- /dev/null +++ b/tags/index.xml @@ -0,0 +1 @@ +Tags onhttps://doc.kerberos.io/tags/Recent content in Tags onHugo -- gohugo.ioen-US \ No newline at end of file diff --git a/vault/first-things-first/index.html b/vault/first-things-first/index.html index c4f8b3d..8f895a7 100644 --- a/vault/first-things-first/index.html +++ b/vault/first-things-first/index.html @@ -1,11 +1,11 @@ -First things first - Kerberos DocsFirst things first - Kerberos Docs
    - +Kerberos Vault In addition to that you have the option to Bring Your Own Storage (BYOS), using Kerberos Vault.">
    + Kerberos Docs

    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

    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:

    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

    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

    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.

    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.

    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

    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.

    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

    Get Started →
    \ No newline at end of file +

    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

    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:

    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

    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

    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.

    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.

    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

    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.

    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

    Get Started →
    \ No newline at end of file diff --git a/vault/get-started/index.html b/vault/get-started/index.html index d581fa4..c07c027 100644 --- a/vault/get-started/index.html +++ b/vault/get-started/index.html @@ -1,15 +1,15 @@ -Get Started - Kerberos DocsGet Started - Kerberos Docs
    - +Despite exposing a web app, Kerberos Storage also ships with a number of API’s. These API’s are exposed as, Swagger documentation, and can be used for extension and integration usecases. Think about following usecase.">
    + Kerberos Docs

    Get Started

    Once you’ve installed Kerberos Storage, you will have the Kerberos Storage web app running. This web app allows you to administrate Kerberos Storage. You can add storage providers, queues, accounts, and more from a single interface. Isn’t that great.

    Despite exposing a web app, Kerberos Storage also ships with a number of API’s. These API’s are exposed as, Swagger documentation, and can be used for extension and integration usecases. Think about following usecase..

    Having a couple of Kerberos Enterprise clusters installed, you could bring the recording of all your recordings at a single place. Next to that you would like to process every single recording being uploaded.

    Having storage is just one thing, processing it with your own programming logical is what makes value.

    Using the concept of Queues, you could integrate with a Kafka queue, and receive real-time messages everytime a recording wa succesfully uploaded. Starting to process the different messages, you know which recordings were uploaded, and you can request the raw recording from Kerberos Storage, using one of it’s API’s. You could do with the recording what you want, in the programming language you prefer, and send the outcome of for example your highly customized machine learning algorithm to your own video analytics hub.

    A concrete tutorial can be found here, it explains how to connect to Kerberos Storage, and run a color detection algorithm.

    Login page

    Once you open a browser, and navigate to the Kerberos Storage web app (see installation for the URL), you will land on the login page.

    After successful installation you should be able to access the login page.

    After successful installation you should be able to access the login page.

    The default username and password of the Kerberos Storage app is:

    • username: root
    • password: kerberos

    The username and password can be changed in the deployment.yaml file.

    License key

    The first time you login you are asked for a license key, this can be obtained by sending a request to cedric@verstraeten.io, more information will be shared publicly soon. An example license key looks like this:

    —–BEGIN LICENSE KEY—– +

    Get Started

    Once you’ve installed Kerberos Storage, you will have the Kerberos Storage web app running. This web app allows you to administrate Kerberos Storage. You can add storage providers, queues, accounts, and more from a single interface. Isn’t that great.

    Despite exposing a web app, Kerberos Storage also ships with a number of API’s. These API’s are exposed as, Swagger documentation, and can be used for extension and integration usecases. Think about following usecase..

    Having a couple of Kerberos Enterprise clusters installed, you could bring the recording of all your recordings at a single place. Next to that you would like to process every single recording being uploaded.

    Having storage is just one thing, processing it with your own programming logical is what makes value.

    Using the concept of Queues, you could integrate with a Kafka queue, and receive real-time messages everytime a recording wa succesfully uploaded. Starting to process the different messages, you know which recordings were uploaded, and you can request the raw recording from Kerberos Storage, using one of it’s API’s. You could do with the recording what you want, in the programming language you prefer, and send the outcome of for example your highly customized machine learning algorithm to your own video analytics hub.

    A concrete tutorial can be found here, it explains how to connect to Kerberos Storage, and run a color detection algorithm.

    Login page

    Once you open a browser, and navigate to the Kerberos Storage web app (see installation for the URL), you will land on the login page.

    After successful installation you should be able to access the login page.

    After successful installation you should be able to access the login page.

    The default username and password of the Kerberos Storage app is:

    • username: root
    • password: kerberos

    The username and password can be changed in the deployment.yaml file.

    License key

    The first time you login you are asked for a license key, this can be obtained by sending a request to cedric@verstraeten.io, more information will be shared publicly soon. An example license key looks like this:

    —–BEGIN LICENSE KEY—– L/+DAwEBB2xpY2Vuc2UB/4QAAQIBB1BheWxvYWQBCgABCVNpZ25hdHVyZQEKAAAA /9z/hAFUPBAADG1haW4uTGljZW5zZf+BAwEBB0xpY2Vuc2UB/4IAAQIBB0NvbXBh bnkBDAABB0V4cFRpbWUBBAAAABb/ghMBCmtlcmJlcm9zaW8B/MC7ZzIAAf+AOaJ+ 8eU3OlZCphr4uJyH/PzfuDkMrqyfIsutc5kSz3rjsRtU4e6vETpHre8CPvFyx5w2 0O8PKCIR4z1q28qJK2cvHQTK0/zf+KfYLilEcmNczLXgg+bnPvtA/bU/K8ZEwbnw Rta3+8zId+xtYQApdmHwo/Ih/vCN579iDeunwVQA -—–END LICENSE KEY—–

    Before you can access the Kerberos Vault system, you will need a license key.

    Before you can access the Kerberos Vault system, you will need a license key.

    Once you received a license key, and entered it into the web app you will be redirected to the login screen. Enter your credentials again, and you will land on the providers page (read more about it in the next chapter).

    Providers

    Providers are the actual datasource where you want to store your recordings. These providers could be a storage provider in the cloud or a storage provider on premise. By adding a provider, you have to provide credentials that allow Kerberos Storage to store recordings in that specific provider. Following provider are currently supported. You can choose from:

    As explained before, for each provider, the appropriate security settings has to be filled in. For example for AWS you need to define the access and secret key, for GCP you need to define a service account.

    A provider can be marked as temporary. This is helpful if you wish to store your recordings for a short period, and want to use it for processing purpose only. A benefit of doing this is reducing costs (if you host in the public cloud).

    One or more providers can be configured to centralise your storage.

    One or more providers can be configured to centralise your storage.

    Queues

    Events or messages are generated each time a recording was uploaded to Kerberos Storage. These messages can be send to one ore more message brokers such as Apache Kafka or AWS SQS. From the interface you can setup the connection, and once configured events will flow to your predefined message brokers.

    An example or usecase of Queues is already discussed at the beginning of this page. Another usecase is the development of our Kerberos Cloud offering. Each time a Kerberos Cloud customer is sending recordings to his or her Kerberos Cloud profile, it is stored inside Kerberos Storage, and thus in one of our predefined providers. After storing successfully, a real-time message is send into our private Kafka broker, which is starting a chain of processing in sequence but also in parallel:

    • Metadata storage in MongoDB,
    • Notifications,
    • Classification with Tensorflow,
    • Counting algorithms,
    • and much more.
    Kerberos Vault can be configured to send events to message brokers to create real-time apps of ML models.

    Kerberos Vault can be configured to send events to message brokers to create real-time apps of ML models.

    Accounts

    Having setup a Provider and a Queue, you also need to configure an account to interact with Kerberos Storage in a safe context. Creating an account allow you to do this. An account is the access point for end users to interact with your Kerberos Storage instance. On the Account page you can create one or more accounts and specify credentials for authentication and specific setting for authorization.

    • Allowed providers,
    • Provider directory
    • Public Key,
    • Secret Key,
    • Day limit (the number of days a recording is stored.)

    So just a short recap, an account allows something or someone to interact with Kerberos Storage, and store data in the authorized Providers and in an directory, the Provider directory, inside that Provider.

    As explained before, you can choose in which directory, the Provider directory, an account can store the recordings. By defining a Provider directory you limit an account to have only access to this directory. On the other hand if you want to give an account more flexibility, and thus grant more access, you can use the * value for the Provider directory parameter. The latter will allow an account to write, in any subdirectory in the Provider.

    Once an account is created it can be used in Kerberos Enterprise (and soon Kerberos Open Source) to persist your data from your Kerberos Enterprise agent into your own Provider.

    One or more accounts can be created to secure your storage access.

    One or more accounts can be created to secure your storage access.

    Media

    Once a recording is stored inside a specific Provider it will show up on the Media page. The Media page is an overview, list page, of all your recordings being uploaded to a Provider. It is used for quickly reviewing activity as for recycling, for the latter read more at the next paragraph.

    All uploaded recordings are visualised through the media page.

    All uploaded recordings are visualised through the media page.

    Recycle

    Storing recordings in a Provider is one thing, making sure you manage the storage capacity of your Provider properly is also important. Storage might need to be recycled after a while because of several reasons:

    • maybe the data is no longer relevant,
    • due to security or compliance,
    • reducing costs, etc.

    To make this possible Kerberos Storage comes with a configurable recycle deployment, which you can run next to your Kerberos Storage deployment. Learn more about recycling here.

    Edit this page on GitHub

    ← First things first
    Installation →
    \ No newline at end of file +—–END LICENSE KEY—–

    Before you can access the Kerberos Vault system, you will need a license key.

    Before you can access the Kerberos Vault system, you will need a license key.

    Once you received a license key, and entered it into the web app you will be redirected to the login screen. Enter your credentials again, and you will land on the providers page (read more about it in the next chapter).

    Providers

    Providers are the actual datasource where you want to store your recordings. These providers could be a storage provider in the cloud or a storage provider on premise. By adding a provider, you have to provide credentials that allow Kerberos Storage to store recordings in that specific provider. Following provider are currently supported. You can choose from:

    As explained before, for each provider, the appropriate security settings has to be filled in. For example for AWS you need to define the access and secret key, for GCP you need to define a service account.

    A provider can be marked as temporary. This is helpful if you wish to store your recordings for a short period, and want to use it for processing purpose only. A benefit of doing this is reducing costs (if you host in the public cloud).

    One or more providers can be configured to centralise your storage.

    One or more providers can be configured to centralise your storage.

    Queues

    Events or messages are generated each time a recording was uploaded to Kerberos Storage. These messages can be send to one ore more message brokers such as Apache Kafka or AWS SQS. From the interface you can setup the connection, and once configured events will flow to your predefined message brokers.

    An example or usecase of Queues is already discussed at the beginning of this page. Another usecase is the development of our Kerberos Cloud offering. Each time a Kerberos Cloud customer is sending recordings to his or her Kerberos Cloud profile, it is stored inside Kerberos Storage, and thus in one of our predefined providers. After storing successfully, a real-time message is send into our private Kafka broker, which is starting a chain of processing in sequence but also in parallel:

    • Metadata storage in MongoDB,
    • Notifications,
    • Classification with Tensorflow,
    • Counting algorithms,
    • and much more.
    Kerberos Vault can be configured to send events to message brokers to create real-time apps of ML models.

    Kerberos Vault can be configured to send events to message brokers to create real-time apps of ML models.

    Accounts

    Having setup a Provider and a Queue, you also need to configure an account to interact with Kerberos Storage in a safe context. Creating an account allow you to do this. An account is the access point for end users to interact with your Kerberos Storage instance. On the Account page you can create one or more accounts and specify credentials for authentication and specific setting for authorization.

    • Allowed providers,
    • Provider directory
    • Public Key,
    • Secret Key,
    • Day limit (the number of days a recording is stored.)

    So just a short recap, an account allows something or someone to interact with Kerberos Storage, and store data in the authorized Providers and in an directory, the Provider directory, inside that Provider.

    As explained before, you can choose in which directory, the Provider directory, an account can store the recordings. By defining a Provider directory you limit an account to have only access to this directory. On the other hand if you want to give an account more flexibility, and thus grant more access, you can use the * value for the Provider directory parameter. The latter will allow an account to write, in any subdirectory in the Provider.

    Once an account is created it can be used in Kerberos Enterprise (and soon Kerberos Open Source) to persist your data from your Kerberos Enterprise agent into your own Provider.

    One or more accounts can be created to secure your storage access.

    One or more accounts can be created to secure your storage access.

    Media

    Once a recording is stored inside a specific Provider it will show up on the Media page. The Media page is an overview, list page, of all your recordings being uploaded to a Provider. It is used for quickly reviewing activity as for recycling, for the latter read more at the next paragraph.

    All uploaded recordings are visualised through the media page.

    All uploaded recordings are visualised through the media page.

    Recycle

    Storing recordings in a Provider is one thing, making sure you manage the storage capacity of your Provider properly is also important. Storage might need to be recycled after a while because of several reasons:

    • maybe the data is no longer relevant,
    • due to security or compliance,
    • reducing costs, etc.

    To make this possible Kerberos Storage comes with a configurable recycle deployment, which you can run next to your Kerberos Storage deployment. Learn more about recycling here.

    Edit this page on GitHub

    ← First things first
    Installation →
    \ No newline at end of file diff --git a/vault/index.html b/vault/index.html index 157e56f..f706c2d 100644 --- a/vault/index.html +++ b/vault/index.html @@ -1,6 +1,6 @@ -Enterprise - Kerberos Docs
    - +Enterprise - Kerberos Docs
    + Kerberos Docs
    \ No newline at end of file +
    \ No newline at end of file diff --git a/vault/index.xml b/vault/index.xml index dfe72b1..7928f1a 100644 --- a/vault/index.xml +++ b/vault/index.xml @@ -1,12 +1,12 @@ -Enterprise onhttps://staging.doc.kerberos.live/vault/Recent content in Enterprise onHugo -- gohugo.ioen-USTue, 06 Oct 2020 08:49:15 +0000First things firsthttps://staging.doc.kerberos.live/vault/first-things-first/Tue, 06 Oct 2020 08:49:31 +0000https://staging.doc.kerberos.live/vault/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. +Enterprise onhttps://doc.kerberos.io/vault/Recent content in Enterprise onHugo -- gohugo.ioen-USTue, 06 Oct 2020 08:49:15 +0000First things firsthttps://doc.kerberos.io/vault/first-things-first/Tue, 06 Oct 2020 08:49:31 +0000https://doc.kerberos.io/vault/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.Get Startedhttps://staging.doc.kerberos.live/vault/get-started/Tue, 06 Oct 2020 08:49:31 +0000https://staging.doc.kerberos.live/vault/get-started/Once you&rsquo;ve installed Kerberos Storage, you will have the Kerberos Storage web app running. This web app allows you to administrate Kerberos Storage. You can add storage providers, queues, accounts, and more from a single interface. Isn&rsquo;t that great. -Despite exposing a web app, Kerberos Storage also ships with a number of API&rsquo;s. These API&rsquo;s are exposed as, Swagger documentation, and can be used for extension and integration usecases. Think about following usecase.Installationhttps://staging.doc.kerberos.live/vault/installation/Tue, 06 Oct 2020 08:49:31 +0000https://staging.doc.kerberos.live/vault/installation/Just like Kerberos Enterprise, Kerberos Vault can be installed where Kubernetes can be installed. This means that it can run at the Edge - Baremetal -, in the cloud - VMs - or at Kubernetes service providers - SAAS - such as GCP, Azure, AWS, DigitalOcean, and the list goes on. -Although you might except Kubernetes at the Edge or Kubernetes in the cloud, there are no differences, well sorry to say there are.Cloud Installationhttps://staging.doc.kerberos.live/vault/installation-cloud/Tue, 06 Oct 2020 08:49:31 +0000https://staging.doc.kerberos.live/vault/installation-cloud/If not already the case, start by installing a Kubernetes cluster. This can be done on one of the hyperscalers (AWS, GCP or Azure), cloud providers (Digital Ocean, Scaleway, etc) or on-premise in your own private network. -Prerequisites Kerberos Vault is the storage component for Kerberos Enterprise. It is used to store your recordings at a central place, in the storage system you prefer. Next to that it can be used for extension and integration capabilities.Edge Installationhttps://staging.doc.kerberos.live/vault/installation-edge/Tue, 06 Oct 2020 08:49:31 +0000https://staging.doc.kerberos.live/vault/installation-edge/Welcome to the Kerberos Vault Edge installation. This is the way to go if you want to install Kerberos Vault on your Baremetal infrastructure or inside your Private Cloud. +Kerberos Vault In addition to that you have the option to Bring Your Own Storage (BYOS), using Kerberos Vault.Get Startedhttps://doc.kerberos.io/vault/get-started/Tue, 06 Oct 2020 08:49:31 +0000https://doc.kerberos.io/vault/get-started/Once you&rsquo;ve installed Kerberos Storage, you will have the Kerberos Storage web app running. This web app allows you to administrate Kerberos Storage. You can add storage providers, queues, accounts, and more from a single interface. Isn&rsquo;t that great. +Despite exposing a web app, Kerberos Storage also ships with a number of API&rsquo;s. These API&rsquo;s are exposed as, Swagger documentation, and can be used for extension and integration usecases. Think about following usecase.Installationhttps://doc.kerberos.io/vault/installation/Tue, 06 Oct 2020 08:49:31 +0000https://doc.kerberos.io/vault/installation/Just like Kerberos Enterprise, Kerberos Vault can be installed where Kubernetes can be installed. This means that it can run at the Edge - Baremetal -, in the cloud - VMs - or at Kubernetes service providers - SAAS - such as GCP, Azure, AWS, DigitalOcean, and the list goes on. +Although you might except Kubernetes at the Edge or Kubernetes in the cloud, there are no differences, well sorry to say there are.Cloud Installationhttps://doc.kerberos.io/vault/installation-cloud/Tue, 06 Oct 2020 08:49:31 +0000https://doc.kerberos.io/vault/installation-cloud/If not already the case, start by installing a Kubernetes cluster. This can be done on one of the hyperscalers (AWS, GCP or Azure), cloud providers (Digital Ocean, Scaleway, etc) or on-premise in your own private network. +Prerequisites Kerberos Vault is the storage component for Kerberos Enterprise. It is used to store your recordings at a central place, in the storage system you prefer. Next to that it can be used for extension and integration capabilities.Edge Installationhttps://doc.kerberos.io/vault/installation-edge/Tue, 06 Oct 2020 08:49:31 +0000https://doc.kerberos.io/vault/installation-edge/Welcome to the Kerberos Vault Edge installation. This is the way to go if you want to install Kerberos Vault on your Baremetal infrastructure or inside your Private Cloud. Store your recordings at the edge with Kerberos Vault Before we can actual start installing the different deployments in our cluster, we need to make sure we have one available. -Prerequisites Kerberos Vault is the storage component for Kerberos Enterprise.Providershttps://staging.doc.kerberos.live/vault/providers/Tue, 06 Oct 2020 08:49:31 +0000https://staging.doc.kerberos.live/vault/providers/Kerberos Storage allows you to attach one or more (and different) storage providers. These providers could be in the cloud like S3, Google Cloud Storage or Azure blob storage, or providers on premise such as Minio. -Depending on your use case: Kerberos Storage Cloud or Kerberos Storage Edge, you will opt for a specific storage provider. For example in the case Kerberos Storage Edge, it makes sense to store your recordings also at the edge.Recyclehttps://staging.doc.kerberos.live/vault/recycle/Tue, 06 Oct 2020 08:49:31 +0000https://staging.doc.kerberos.live/vault/recycle/Next to storing your recordings, recycling up is also important. You have to avoid your disk being filled up and locking up the entire system and cluster, or you simply have to reduce cost. To make this possible we offer a recycle service called Kerberos Storage Recycle, which you can use to remove recordings based on different rules. -Recycling rules Different recycling rules can be configured in the Kerberos Storage app.Releaseshttps://staging.doc.kerberos.live/vault/releases/releases/Tue, 06 Oct 2020 08:49:31 +0000https://staging.doc.kerberos.live/vault/releases/releases/A license can be obtained by requesting a contract offert a cedric@verstraeten.io. Once agreed, a license will be generated on the Kerberos License server. +Prerequisites Kerberos Vault is the storage component for Kerberos Enterprise.Providershttps://doc.kerberos.io/vault/providers/Tue, 06 Oct 2020 08:49:31 +0000https://doc.kerberos.io/vault/providers/Kerberos Storage allows you to attach one or more (and different) storage providers. These providers could be in the cloud like S3, Google Cloud Storage or Azure blob storage, or providers on premise such as Minio. +Depending on your use case: Kerberos Storage Cloud or Kerberos Storage Edge, you will opt for a specific storage provider. For example in the case Kerberos Storage Edge, it makes sense to store your recordings also at the edge.Recyclehttps://doc.kerberos.io/vault/recycle/Tue, 06 Oct 2020 08:49:31 +0000https://doc.kerberos.io/vault/recycle/Next to storing your recordings, recycling up is also important. You have to avoid your disk being filled up and locking up the entire system and cluster, or you simply have to reduce cost. To make this possible we offer a recycle service called Kerberos Storage Recycle, which you can use to remove recordings based on different rules. +Recycling rules Different recycling rules can be configured in the Kerberos Storage app.Releaseshttps://doc.kerberos.io/vault/releases/releases/Tue, 06 Oct 2020 08:49:31 +0000https://doc.kerberos.io/vault/releases/releases/A license can be obtained by requesting a contract offert a cedric@verstraeten.io. Once agreed, a license will be generated on the Kerberos License server. EULA This agreement (or “EULA”) is a legal agreement between the person, company or organization (“You”) that has licensed a software product (Kerberos Storage) and Verstraeten.io (“Licensor” or “Application Provider”). The Product is to be obtained only through Docker Hub (https://hub.docker.com), and by obtaining a purchased license. \ No newline at end of file diff --git a/vault/installation-cloud/index.html b/vault/installation-cloud/index.html index af3d361..9ece451 100644 --- a/vault/installation-cloud/index.html +++ b/vault/installation-cloud/index.html @@ -1,10 +1,10 @@ -Cloud Installation - Kerberos DocsCloud Installation - Kerberos Docs
    - + Prerequisites Kerberos Vault is the storage component for Kerberos Enterprise. It is used to store your recordings at a central place, in the storage system you prefer. Next to that it can be used for extension and integration capabilities.">
    + Kerberos Docs

    Cloud Installation

    If not already the case, start by installing a Kubernetes cluster. This can be done on one of the hyperscalers (AWS, GCP or Azure), cloud providers (Digital Ocean, Scaleway, etc) or on-premise in your own private network.

    Prerequisites

    Kerberos Vault is the storage component for Kerberos Enterprise. It is used to store your recordings at a central place, in the storage system you prefer. Next to that it can be used for extension and integration capabilities. Learn more about Kerberos Vault here.

    To use Kerberos Vault, you will need to have Kerberos Enterprise installed, and deployments running. Independent from that one can also use the Kerberos Vault API /swagger/index.html to send recordings from a custom build VMS.

    Installation

    Similar to Kerberos Enterprise, Kerberos Vault, requires some initial components to be installed. If you will run Kerberos Vault in the same cluster as where you have Kerberos Enterprise running, there is not much to do.

    Bring your own storage using Kerberos Vault

    Bring your own storage using Kerberos Vault

    However if you plan to run Kerberos Vault in a different cluster (which is perfectly possible), you will need to make sure you complete the initial setup of Kerberos Enterprise installation. To be more specific you will need the following components running:

    • Helm
    • MongoDB
    • Traefik

    Once this is done start by cloning the configurations from our Github repo.

    git clone https://github.com/kerberos-io/storage
+

    Cloud Installation

    If not already the case, start by installing a Kubernetes cluster. This can be done on one of the hyperscalers (AWS, GCP or Azure), cloud providers (Digital Ocean, Scaleway, etc) or on-premise in your own private network.

    Prerequisites

    Kerberos Vault is the storage component for Kerberos Enterprise. It is used to store your recordings at a central place, in the storage system you prefer. Next to that it can be used for extension and integration capabilities. Learn more about Kerberos Vault here.

    To use Kerberos Vault, you will need to have Kerberos Enterprise installed, and deployments running. Independent from that one can also use the Kerberos Vault API /swagger/index.html to send recordings from a custom build VMS.

    Installation

    Similar to Kerberos Enterprise, Kerberos Vault, requires some initial components to be installed. If you will run Kerberos Vault in the same cluster as where you have Kerberos Enterprise running, there is not much to do.

    Bring your own storage using Kerberos Vault

    Bring your own storage using Kerberos Vault

    However if you plan to run Kerberos Vault in a different cluster (which is perfectly possible), you will need to make sure you complete the initial setup of Kerberos Enterprise installation. To be more specific you will need the following components running:

    • Helm
    • MongoDB
    • Traefik

    Once this is done start by cloning the configurations from our Github repo.

    git clone https://github.com/kerberos-io/storage

    Storage

    Similar to Kerberos Enterprise, Kerberos Vault is managed through a web app. It allows you to add storage providers (S3, minio, etc), add queues for messaging, accounts for security and much more. It also comes with API’s, which you can use to interact and retrieve information from Kerberos Vault. All is documented in the form of Swagger APIs /swagger/index.html.

    Before installing Kerberos Vault, open the ./storage/yaml/deployment.yaml configuration file. At the bottom file you will find two endpoints, similar to the Traefik config file below. Update the domain names to your own domain, and add these to your DNS server or /etc/hosts file (and point to the same IP as the Traefik EXTERNAL-IP).

        spec:
       rules:
 -->   - host: storage.domain.com
@@ -39,5 +39,5 @@ NAME                              READY   STATUS    RESTARTS   AGE
 kerberos-storage-6f5c877d7c-hf77p 1/1     Running   0          2d11h
 mongodb-55566dc65c-xgmns          2/2     Running   0          4d13h
 traefik-7d566ccc47-mwslb          1/1     Running   0          4d12h
-

    Access the system

    Once everything is configured correctly your cluster and DNS or /etc/hosts file, you should be able to access the Storage application. By navigating to the Storage domain storage.domain.com in your browser you will see the Storage login page showing up.

    Once successfully installed Kerberos Vault, it will show you the login page.

    Once successfully installed Kerberos Vault, it will show you the login page.

    Edit this page on GitHub

    ← Installation
    Edge Installation →
    \ No newline at end of file +

    Access the system

    Once everything is configured correctly your cluster and DNS or /etc/hosts file, you should be able to access the Storage application. By navigating to the Storage domain storage.domain.com in your browser you will see the Storage login page showing up.

    Once successfully installed Kerberos Vault, it will show you the login page.

    Once successfully installed Kerberos Vault, it will show you the login page.

    Edit this page on GitHub

    ← Installation
    Edge Installation →
    \ No newline at end of file diff --git a/vault/installation-edge/index.html b/vault/installation-edge/index.html index 4ae46b8..ce83e25 100644 --- a/vault/installation-edge/index.html +++ b/vault/installation-edge/index.html @@ -1,14 +1,14 @@ -Edge Installation - Kerberos DocsEdge Installation - Kerberos Docs
    - +Prerequisites Kerberos Vault is the storage component for Kerberos Enterprise.">
    + Kerberos Docs

    Edge Installation

    Welcome to the Kerberos Vault Edge installation. This is the way to go if you want to install Kerberos Vault on your Baremetal infrastructure or inside your Private Cloud.

    Store your recordings at the edge with Kerberos Vault

    Store your recordings at the edge with Kerberos Vault

    Before we can actual start installing the different deployments in our cluster, we need to make sure we have one available.

    Prerequisites

    Kerberos Vault is the storage component for Kerberos Enterprise. It is used to store your recordings at a central place, in the storage system you prefer. Next to that it can be used for extension and integration capabilities. Learn more about Kerberos Vault here.

    To use Kerberos Vault, you will need to have Kerberos Enterprise installed, and deployments running. Independent from that one can also use the Kerberos Vault API /swagger/index.html to send recordings from a custom build VMS.

    Installation

    Similar to Kerberos Enterprise, Kerberos Vault, requires some initial components to be installed. If you will run Kerberos Vault in the same cluster as where you have Kerberos Enterprise running, there is not much to do.

    However if you plan to run Kerberos Vault in a different cluster (which is perfectly possible), you will need to make sure you complete the initial setup of Kerberos Enterprise Edge installation. To be more specific you will need the following components running:

    • Helm
    • Calico
    • MetalLB
    • MongoDB
    • Traefik

    Once this is done start by cloning the configurations from our Github repo.

    git clone https://github.com/kerberos-io/storage
+

    Edge Installation

    Welcome to the Kerberos Vault Edge installation. This is the way to go if you want to install Kerberos Vault on your Baremetal infrastructure or inside your Private Cloud.

    Store your recordings at the edge with Kerberos Vault

    Store your recordings at the edge with Kerberos Vault

    Before we can actual start installing the different deployments in our cluster, we need to make sure we have one available.

    Prerequisites

    Kerberos Vault is the storage component for Kerberos Enterprise. It is used to store your recordings at a central place, in the storage system you prefer. Next to that it can be used for extension and integration capabilities. Learn more about Kerberos Vault here.

    To use Kerberos Vault, you will need to have Kerberos Enterprise installed, and deployments running. Independent from that one can also use the Kerberos Vault API /swagger/index.html to send recordings from a custom build VMS.

    Installation

    Similar to Kerberos Enterprise, Kerberos Vault, requires some initial components to be installed. If you will run Kerberos Vault in the same cluster as where you have Kerberos Enterprise running, there is not much to do.

    However if you plan to run Kerberos Vault in a different cluster (which is perfectly possible), you will need to make sure you complete the initial setup of Kerberos Enterprise Edge installation. To be more specific you will need the following components running:

    • Helm
    • Calico
    • MetalLB
    • MongoDB
    • Traefik

    Once this is done start by cloning the configurations from our Github repo.

    git clone https://github.com/kerberos-io/storage

    Storage

    Similar to Kerberos Enterprise, Kerberos Vault is managed through a web app. It allows you to add storage providers (S3, minio, etc), add queues for messaging, accounts for security and much more. It also comes with API’s, which you can use to interact and retrieve information from Kerberos Vault. All is documented in the form of Swagger APIs /swagger/index.html.

    Before installing Kerberos Vault, open the ./storage/yaml/deployment.yaml configuration file. At the bottom file you will find two endpoints, similar to the Traefik config file below. Update the domain names to your own domain, and add these to your DNS server or /etc/hosts file (and point to the same IP as the Traefik EXTERNAL-IP).

        spec:
       rules:
 -->   - host: storage.domain.com
@@ -35,5 +35,5 @@ NAME                              READY   STATUS    RESTARTS   AGE
 kerberos-storage-6f5c877d7c-hf77p 1/1     Running   0          2d11h
 mongodb-55566dc65c-xgmns          2/2     Running   0          4d13h
 traefik-7d566ccc47-mwslb          1/1     Running   0          4d12h
-

    Access the system

    Once everything is configured correctly your cluster and DNS or /etc/hosts file, you should be able to access the Storage application. By navigating to the Storage domain storage.domain.com in your browser you will see the Storage login page showing up.

    Once successfully installed Kerberos Vault, it will show you the login page.

    Once successfully installed Kerberos Vault, it will show you the login page.

    Edit this page on GitHub

    ← Cloud Installation
    Providers →
    \ No newline at end of file +

    Access the system

    Once everything is configured correctly your cluster and DNS or /etc/hosts file, you should be able to access the Storage application. By navigating to the Storage domain storage.domain.com in your browser you will see the Storage login page showing up.

    Once successfully installed Kerberos Vault, it will show you the login page.

    Once successfully installed Kerberos Vault, it will show you the login page.

    Edit this page on GitHub

    ← Cloud Installation
    Providers →
    \ No newline at end of file diff --git a/vault/installation/index.html b/vault/installation/index.html index 774f969..ad658e8 100644 --- a/vault/installation/index.html +++ b/vault/installation/index.html @@ -1,8 +1,8 @@ -Installation - Kerberos DocsInstallation - Kerberos Docs
    - +Although you might except Kubernetes at the Edge or Kubernetes in the cloud, there are no differences, well sorry to say there are.">
    + Kerberos Docs

    Installation

    Just like Kerberos Enterprise, Kerberos Vault can be installed where Kubernetes can be installed. This means that it can run at the Edge - Baremetal -, in the cloud - VMs - or at Kubernetes service providers - SAAS - such as GCP, Azure, AWS, DigitalOcean, and the list goes on.

    Although you might except Kubernetes at the Edge or Kubernetes in the cloud, there are no differences, well sorry to say there are. As Kubernetes service providers implemented features such as LoadBalancers, Persistent Volumes, and others, they have automated and integrated a huge portion of the Kubernetes stack with their related PAAS services. To be more concrete if you are running a Kubernetes Cluster on GCP, you will use the LoadBalancing and Storage services from GCP.

    Kerberos Vault can be installed everywhere your Kubernetes cluster can be installed.

    Kerberos Vault can be installed everywhere your Kubernetes cluster can be installed.

    Compared to Kubernetes at the Edge, there are no predefined LoadBalancers, Storage capabilities, and more. This means more administration work for you, but - with great power comes great responsibility - so no worries. In the end there are alternative functionalties available, for features which you find out-of-the-box at the Kubernetes service providers, you just have to spend more time on configuring and installing those services/pods/deployments yourself.

    Installation on a Kubernetes Service Provider

    Installing Kerberos Vault, just like Kerberos Enterprise, on a Kubernetes Service Provider (Azure, GCP, AWS) is straight forward, as you can create a Kubernetes cluster in a few clicks, get access to public Load Balancers, storage and more. Running Kerberos Vault in such a cluster is just a matter of copy-pasting some configuration (yaml) files, and executing some kubectl apply commands.

    Bring your own storage using Kerberos Vault

    Bring your own storage using Kerberos Vault

    Install Kerberos Vault on a Kubernetes Service Provider by following this step-by-step installation guide.

    Installation in Private cloud or Baremetal

    No need to install Kerberos Vault on a Kubernetes Service Provider, you could install it on your own Kubernetes cluster in your private cloud, or even better inside your own premise. The closer you bring Kerberos Vault to your surveillance infrastructure, and Kerberos Enterprise, the more benefits you will experience (low latency, low bandwidth, etc).

    Store your recordings at the edge with Kerberos Vault

    Store your recordings at the edge with Kerberos Vault

    In contradiction to the Kubernetes Service Provider, you will have some work todo. Setting up Kubernetes Cluster, play with MetalLB, Persistent Volumes and claims. Don’t be scared, it’s pretty straight forward as well. You can’t simple expect a: click, click, 💥 approach.

    Install Kerberos Vault on a Private cloud or Baremetal by following this step-by-step installation guide.

    Edit this page on GitHub

    ← Get Started
    Cloud Installation →
    \ No newline at end of file +

    Installation

    Just like Kerberos Enterprise, Kerberos Vault can be installed where Kubernetes can be installed. This means that it can run at the Edge - Baremetal -, in the cloud - VMs - or at Kubernetes service providers - SAAS - such as GCP, Azure, AWS, DigitalOcean, and the list goes on.

    Although you might except Kubernetes at the Edge or Kubernetes in the cloud, there are no differences, well sorry to say there are. As Kubernetes service providers implemented features such as LoadBalancers, Persistent Volumes, and others, they have automated and integrated a huge portion of the Kubernetes stack with their related PAAS services. To be more concrete if you are running a Kubernetes Cluster on GCP, you will use the LoadBalancing and Storage services from GCP.

    Kerberos Vault can be installed everywhere your Kubernetes cluster can be installed.

    Kerberos Vault can be installed everywhere your Kubernetes cluster can be installed.

    Compared to Kubernetes at the Edge, there are no predefined LoadBalancers, Storage capabilities, and more. This means more administration work for you, but - with great power comes great responsibility - so no worries. In the end there are alternative functionalties available, for features which you find out-of-the-box at the Kubernetes service providers, you just have to spend more time on configuring and installing those services/pods/deployments yourself.

    Installation on a Kubernetes Service Provider

    Installing Kerberos Vault, just like Kerberos Enterprise, on a Kubernetes Service Provider (Azure, GCP, AWS) is straight forward, as you can create a Kubernetes cluster in a few clicks, get access to public Load Balancers, storage and more. Running Kerberos Vault in such a cluster is just a matter of copy-pasting some configuration (yaml) files, and executing some kubectl apply commands.

    Bring your own storage using Kerberos Vault

    Bring your own storage using Kerberos Vault

    Install Kerberos Vault on a Kubernetes Service Provider by following this step-by-step installation guide.

    Installation in Private cloud or Baremetal

    No need to install Kerberos Vault on a Kubernetes Service Provider, you could install it on your own Kubernetes cluster in your private cloud, or even better inside your own premise. The closer you bring Kerberos Vault to your surveillance infrastructure, and Kerberos Enterprise, the more benefits you will experience (low latency, low bandwidth, etc).

    Store your recordings at the edge with Kerberos Vault

    Store your recordings at the edge with Kerberos Vault

    In contradiction to the Kubernetes Service Provider, you will have some work todo. Setting up Kubernetes Cluster, play with MetalLB, Persistent Volumes and claims. Don’t be scared, it’s pretty straight forward as well. You can’t simple expect a: click, click, 💥 approach.

    Install Kerberos Vault on a Private cloud or Baremetal by following this step-by-step installation guide.

    Edit this page on GitHub

    ← Get Started
    Cloud Installation →
    \ No newline at end of file diff --git a/vault/providers/index.html b/vault/providers/index.html index ef9d273..383168a 100644 --- a/vault/providers/index.html +++ b/vault/providers/index.html @@ -1,10 +1,10 @@ -Providers - Kerberos DocsProviders - Kerberos Docs
    - +Depending on your use case: Kerberos Storage Cloud or Kerberos Storage Edge, you will opt for a specific storage provider. For example in the case Kerberos Storage Edge, it makes sense to store your recordings also at the edge.">
    + Kerberos Docs

    Providers

    Kerberos Storage allows you to attach one or more (and different) storage providers. These providers could be in the cloud like S3, Google Cloud Storage or Azure blob storage, or providers on premise such as Minio.

    Depending on your use case: Kerberos Storage Cloud or Kerberos Storage Edge, you will opt for a specific storage provider. For example in the case Kerberos Storage Edge, it makes sense to store your recordings also at the edge. The accomplish this you could for example setup a Minio instance.

    Below you can find a detailed step-by-step guide to setup different storage providers.

    Prerequisites

    This installation guide assumes you have setup Kerberos Storage properly.

    Installation Minio

    Minio is the recommended solution if you want to persist your data at the edge. To setup minio you just have to install a few components. Let’s start with getting the configuration files (if not already done) for setting up Minio.

    git clone https://github.com/kerberos-io/storage
+

    Providers

    Kerberos Storage allows you to attach one or more (and different) storage providers. These providers could be in the cloud like S3, Google Cloud Storage or Azure blob storage, or providers on premise such as Minio.

    Depending on your use case: Kerberos Storage Cloud or Kerberos Storage Edge, you will opt for a specific storage provider. For example in the case Kerberos Storage Edge, it makes sense to store your recordings also at the edge. The accomplish this you could for example setup a Minio instance.

    Below you can find a detailed step-by-step guide to setup different storage providers.

    Prerequisites

    This installation guide assumes you have setup Kerberos Storage properly.

    Installation Minio

    Minio is the recommended solution if you want to persist your data at the edge. To setup minio you just have to install a few components. Let’s start with getting the configuration files (if not already done) for setting up Minio.

    git clone https://github.com/kerberos-io/storage

    Now we have the configrations available, let’s use start with creating a local-storage volume using ./storage/yaml/minio/volume.yaml file. When opening the file we should focus on following attributes.

      spec:
     capacity:
 -->   storage: 20Gi
@@ -39,5 +39,5 @@ kubectl apply -f ./storage/yaml/minio/volume.yaml
             serviceName: minio
             servicePort: 9000

    Adapt the hostname to your needs, and apply the deployment.yaml file when appropriate.

    kubectl apply -f ./storage/yaml/minio/deployment.yaml
-

    You should now see Minio being installed, and able to access it from your favourite web browser. You can use with the credentials you have defined in the deployment.yaml file.

    When installing at the edge, the preferred installation method is MinIO.

    When installing at the edge, the preferred installation method is MinIO.

    Edit this page on GitHub

    ← Edge Installation
    Recycle →
    \ No newline at end of file +

    You should now see Minio being installed, and able to access it from your favourite web browser. You can use with the credentials you have defined in the deployment.yaml file.

    When installing at the edge, the preferred installation method is MinIO.

    When installing at the edge, the preferred installation method is MinIO.

    Edit this page on GitHub

    ← Edge Installation
    Recycle →
    \ No newline at end of file diff --git a/vault/recycle/index.html b/vault/recycle/index.html index e8bee9a..0e8128d 100644 --- a/vault/recycle/index.html +++ b/vault/recycle/index.html @@ -1,13 +1,13 @@ -Recycle - Kerberos DocsRecycle - Kerberos Docs
    - +Recycling rules Different recycling rules can be configured in the Kerberos Storage app.">
    + Kerberos Docs

    Recycle

    Next to storing your recordings, recycling up is also important. You have to avoid your disk being filled up and locking up the entire system and cluster, or you simply have to reduce cost. To make this possible we offer a recycle service called Kerberos Storage Recycle, which you can use to remove recordings based on different rules.

    Recycling rules

    Different recycling rules can be configured in the Kerberos Storage app. Based on those rules, the recycle service, will or will not remove a recording from your providers.

    Account day limit

    When creating an Account on the Kerberos Storage app, you have the option to specify the day limit for that account. This day limit tells the recycle service, if it is time or not to remove the recording.

    You can remove your recordings by specifying the day limit field.

    You can remove your recordings by specifying the day limit field.

    Prerequisites

    This installation guide assumes you have setup Kerberos Storage properly.

    Installation

    Modify the MongoDB credentials, as you did for the Kerberos Storage yaml file.

        - name: MONGODB_USERNAME
+

    Recycle

    Next to storing your recordings, recycling up is also important. You have to avoid your disk being filled up and locking up the entire system and cluster, or you simply have to reduce cost. To make this possible we offer a recycle service called Kerberos Storage Recycle, which you can use to remove recordings based on different rules.

    Recycling rules

    Different recycling rules can be configured in the Kerberos Storage app. Based on those rules, the recycle service, will or will not remove a recording from your providers.

    Account day limit

    When creating an Account on the Kerberos Storage app, you have the option to specify the day limit for that account. This day limit tells the recycle service, if it is time or not to remove the recording.

    You can remove your recordings by specifying the day limit field.

    You can remove your recordings by specifying the day limit field.

    Prerequisites

    This installation guide assumes you have setup Kerberos Storage properly.

    Installation

    Modify the MongoDB credentials, as you did for the Kerberos Storage yaml file.

        - name: MONGODB_USERNAME
       value: "root"
     - name: MONGODB_PASSWORD
 -->   value: "xxxxxxxxxx"

    Execute following script to deploy the recycle job.

    git clone https://github.com/kerberos-io/storage
-kubectl apply -f ./storage/yaml/deployment-cleanup.yaml

    Edit this page on GitHub

    ← Providers
    Releases →
    \ No newline at end of file +kubectl apply -f ./storage/yaml/deployment-cleanup.yaml

    Edit this page on GitHub

    ← Providers
    Releases →
    \ No newline at end of file diff --git a/vault/releases/releases/index.html b/vault/releases/releases/index.html index 0deacb9..592a669 100644 --- a/vault/releases/releases/index.html +++ b/vault/releases/releases/index.html @@ -1,8 +1,8 @@ -Releases - Kerberos DocsReleases - Kerberos Docs
    - +EULA This agreement (or “EULA”) is a legal agreement between the person, company or organization (“You”) that has licensed a software product (Kerberos Storage) and Verstraeten.io (“Licensor” or “Application Provider”). The Product is to be obtained only through Docker Hub (https://hub.docker.com), and by obtaining a purchased license.">
    + Kerberos Docs

    Releases

    A license can be obtained by requesting a contract offert a cedric@verstraeten.io. Once agreed, a license will be generated on the Kerberos License server.

    EULA

    This agreement (or “EULA”) is a legal agreement between the person, company or organization (“You”) that has licensed a software product (Kerberos Storage) and Verstraeten.io (“Licensor” or “Application Provider”). The Product is to be obtained only through Docker Hub (https://hub.docker.com), and by obtaining a purchased license. By installing and/or using any Product provided by the Licensor, You are confirming your acceptance of this agreement and you are agreeing to become bound by the terms of this agreement.

    This EULA shall apply only to a Product supplied by the Licensor herewith regardless of whether other software or platform is referred to or described herein.

    The Products transacted through the Services are licensed, not sold, to You for use only under the terms of this license. The Application Provider reserves all rights not expressly granted to You. The Product that is subject to this license is referred to in this license as the “Licensed Application.” The Licensed Application is to be used on any operating system or machine (on-premise/cloud) and the aforementioned devices are referenced in this license as “Devices”.

    a. Scope of License: This license granted to You for the Licensed Application by Application Provider is limited to a non-transferable license to use the Licensed Application on any Devices that You own or control and as permitted by the Usage Rules. This license does not allow You to use the Licensed Application on any Devices that You do not own or control, and You may not distribute or make the Licensed Application available over a network where it could be used by multiple devices at the same time. You may not rent, lease, lend, sell, redistribute or sublicense the Licensed Application. You may not copy (except as expressly permitted by this license and the Usage Rules), decompile, reverse engineer, disassemble, attempt to derive the source code of, modify, or create derivative works of the Licensed Application, any updates, or any part thereof (except as and only to the extent any foregoing restriction is prohibited by applicable law or to the extent as may be permitted by the licensing terms governing use of any open sourced components included with the Licensed Application). Any attempt to do so is a violation of the rights of the Application Provider and its licensors. If You breach this restriction, You may be subject to prosecution and damages. The terms of the license will govern any upgrades provided by Application Provider that replace and/or supplement the original Product, unless such upgrade is accompanied by a separate license in which case the terms of that license will govern.

    b. Consent to Use of Data: You agree that Application Provider may collect and use technical data and related information, including but not limited to technical information about Your device, system and application software, and peripherals, that is gathered periodically to facilitate the provision of software updates, product support and other services to You (if any) related to the Licensed Application. Application Provider may use this information, as long as it is in a form that does not personally identify You, to improve its products or to provide services or technologies to You.

    c. Termination. The license is effective until terminated by You or Application Provider. Your rights under this license will terminate automatically without notice from the Application Provider if You fail to comply with any term(s) of this license. Upon termination of the license, You shall cease all use of the Licensed Application, and destroy all copies, full or partial, of the Licensed Application.

    d. Services; Third Party Materials. The Licensed Application may enable access to Application Provider’s and third party services and web sites (collectively and individually, “Services”). Use of the Services may require Internet access and that You accept additional terms of service.

    You understand that by using any of the Services, You may encounter content that may be deemed offensive, indecent, or objectionable, which content may or may not be identified as having explicit language, and that the results of any search or entering of a particular URL may automatically and unintentionally generate links or references to objectionable material. Nevertheless, You agree to use the Services at Your sole risk and that the Application Provider shall not have any liability to You for content that may be found to be offensive, indecent, or objectionable.

    Certain Services may display, include or make available content, data, information, applications or materials from third parties (“Third Party Materials”) or provide links to certain third party web sites. By using the Services, You acknowledge and agree that the Application Provider is not responsible for examining or evaluating the content, accuracy, completeness, timeliness, validity, copyright compliance, legality, decency, quality or any other aspect of such Third Party Materials or web sites. The Application Provider does not warrant or endorse and does not assume and will not have any liability or responsibility to You or any other person for any third-party Services, Third Party Materials or web sites, or for any other materials, products, or services of third parties. Third Party Materials and links to other web sites are provided solely as a convenience to You. Financial information displayed by any Services is for general informational purposes only and is not intended to be relied upon as investment advice. Before executing any securities transaction based upon information obtained through the Services, You should consult with a financial professional. Location data provided by any Services is for basic navigational purposes only and is not intended to be relied upon in situations where precise location information is needed or where erroneous, inaccurate or incomplete location data may lead to death, personal injury, property or environmental damage. Neither the Application Provider, nor any of its content providers, guarantees the availability, accuracy, completeness, reliability, or timeliness of stock information or location data displayed by any Services.

    You agree that any Services contain proprietary content, information and material that is protected by applicable intellectual property and other laws, including but not limited to copyright, and that You will not use such proprietary content, information or materials in any way whatsoever except for permitted use of the Services. No portion of the Services may be reproduced in any form or by any means. You agree not to modify, rent, lease, loan, sell, distribute, or create derivative works based on the Services, in any manner, and You shall not exploit the Services in any unauthorized way whatsoever, including but not limited to, by trespass or burdening network capacity. You further agree not to use the Services in any manner to harass, abuse, stalk, threaten, defame or otherwise infringe or violate the rights of any other party, and that the Application Provider is not in any way responsible for any such use by You, nor for any harassing, threatening, defamatory, offensive or illegal messages or transmissions that You may receive as a result of using any of the Services.

    In addition, third party Services and Third Party Materials that may be accessed from, displayed on or linked to from the Devices are not available in all languages or in all countries. The Application Provider makes no representation that such Services and Materials are appropriate or available for use in any particular location. To the extent You choose to access such Services or Materials, You do so at Your own initiative and are responsible for compliance with any applicable laws, including but not limited to applicable local laws. The Application Provider, and its licensors, reserve the right to change, suspend, remove, or disable access to any Services at any time without notice. In no event will the Application Provider be liable for the removal of or disabling of access to any such Services. The Application Provider may also impose limits on the use of or access to certain Services, in any case and without notice or liability.

    e. No Warranty: You expressly acknowledge and agree that use of the licensed application is at your sole risk and that the entire risk as to satisfactory quality, performance, accuracy and effort is with you. To the maximum extent permitted by applicable law, the license application and any services performed or provided by the licensed application (“services”) are provided “as is” and “as available,” with all faults and without warranty of any kind, and application provider hereby disclaims all warranties and conditions with respect to the licensed application and any services, either express, implied or statutory, including, but not limited to, the implied warranties and/or conditions of merchantability, of satisfactory quality, of fitness for a particular purpose, of accuracy, of quiet enjoyment, and non-infringement of third party rights. Application provider does not warrant against interference with your enjoyment of the licensed application, that the functions contained in, or services performed or provided by, the licensed application will meet your requirements, that the operation of the licensed application or services will be uninterrupted or error-free, or that effects in the licensed application or services will be corrected. No oral or written information or advice given by application provider or its authorized representative shall create a warranty. Should the licensed application or services prove defective, you assume the entire cost of all necessary servicing, repair or correction. Some jurisdictions do not allow the exclusion of implied warranties or limitations on applicable statutory rights of a consumer, so the above exclusion and limitations may not apply to you.

    f. Limitation of Liability. To the extent not prohibited by law, in no event shall application provider be liable for personal injury, or any incidental, special, indirect or consequential damages whatsoever, including, without limitation, damages for loss of profits, loss of data, business interruption or any other commercial damages or losses, arising out of or related to your use or inability to use the licensed application, however caused, regardless of the theory of liability (contract, tort or otherwise) and even if application provider has been advised of the possibility of such damages. Some jurisdictions do not allow the limitation of liability for personal injury, or of incidental or consequential damages, so this limitation may not apply to you.

    In no event shall Application Provider’s total liability to you for all damages (other than as may be required by applicable law in cases involving personal injury) exceed the amount of fifty dollars ($50.00). The foregoing limitations will apply even if the above stated remedy fails of its essential purpose.

    g. You may not use or otherwise export or re-export the Licensed Application except as authorized by United States law and the laws of the jurisdiction in which the Licensed Application was obtained. In particular, but without limitation, the Licensed Application may not be exported or re-exported (a) into any U.S. embargoed countries or (b) to anyone on the U.S. Treasury Department’s list of Specially Designated Nationals or the U.S. Department of Commerce Denied Person’s List or Entity List. By using the Licensed Application, you represent and warrant that you are not located in any such country or on any such list. You also agree that you will not use these products for any purposes prohibited by United States law, including, without limitation, the development, design, manufacture or production of nuclear, missiles, or chemical or biological weapons.

    h. The Licensed Application and related documentation are “Commercial Items”, as that term is defined at 48 C.F.R. §2.101, consisting of “Commercial Computer Software” and “Commercial Computer Software Documentation”, as such terms are used in 48 C.F.R. §12.212 or 48 C.F.R. §227.7202, as applicable. Consistent with 48 C.F.R. §12.212 or 48 C.F.R. §227.7202-1 through 227.7202-4, as applicable, the Commercial Computer Software and Commercial Computer Software Documentation are being licensed to U.S. Government end users (a) only as Commercial Items and (b) with only those rights as are granted to all other end users pursuant to the terms and conditions herein. Unpublished-rights reserved under the copyright laws of the United States.

    i. The laws of the State of Belgium, excluding its conflicts of law rules, govern this license and your use of the Licensed Application. Your use of the Licensed Application may also be subject to other local, state, national, or international laws.

    Edit this page on GitHub

    ← Recycle
    \ No newline at end of file +

    Releases

    A license can be obtained by requesting a contract offert a cedric@verstraeten.io. Once agreed, a license will be generated on the Kerberos License server.

    EULA

    This agreement (or “EULA”) is a legal agreement between the person, company or organization (“You”) that has licensed a software product (Kerberos Storage) and Verstraeten.io (“Licensor” or “Application Provider”). The Product is to be obtained only through Docker Hub (https://hub.docker.com), and by obtaining a purchased license. By installing and/or using any Product provided by the Licensor, You are confirming your acceptance of this agreement and you are agreeing to become bound by the terms of this agreement.

    This EULA shall apply only to a Product supplied by the Licensor herewith regardless of whether other software or platform is referred to or described herein.

    The Products transacted through the Services are licensed, not sold, to You for use only under the terms of this license. The Application Provider reserves all rights not expressly granted to You. The Product that is subject to this license is referred to in this license as the “Licensed Application.” The Licensed Application is to be used on any operating system or machine (on-premise/cloud) and the aforementioned devices are referenced in this license as “Devices”.

    a. Scope of License: This license granted to You for the Licensed Application by Application Provider is limited to a non-transferable license to use the Licensed Application on any Devices that You own or control and as permitted by the Usage Rules. This license does not allow You to use the Licensed Application on any Devices that You do not own or control, and You may not distribute or make the Licensed Application available over a network where it could be used by multiple devices at the same time. You may not rent, lease, lend, sell, redistribute or sublicense the Licensed Application. You may not copy (except as expressly permitted by this license and the Usage Rules), decompile, reverse engineer, disassemble, attempt to derive the source code of, modify, or create derivative works of the Licensed Application, any updates, or any part thereof (except as and only to the extent any foregoing restriction is prohibited by applicable law or to the extent as may be permitted by the licensing terms governing use of any open sourced components included with the Licensed Application). Any attempt to do so is a violation of the rights of the Application Provider and its licensors. If You breach this restriction, You may be subject to prosecution and damages. The terms of the license will govern any upgrades provided by Application Provider that replace and/or supplement the original Product, unless such upgrade is accompanied by a separate license in which case the terms of that license will govern.

    b. Consent to Use of Data: You agree that Application Provider may collect and use technical data and related information, including but not limited to technical information about Your device, system and application software, and peripherals, that is gathered periodically to facilitate the provision of software updates, product support and other services to You (if any) related to the Licensed Application. Application Provider may use this information, as long as it is in a form that does not personally identify You, to improve its products or to provide services or technologies to You.

    c. Termination. The license is effective until terminated by You or Application Provider. Your rights under this license will terminate automatically without notice from the Application Provider if You fail to comply with any term(s) of this license. Upon termination of the license, You shall cease all use of the Licensed Application, and destroy all copies, full or partial, of the Licensed Application.

    d. Services; Third Party Materials. The Licensed Application may enable access to Application Provider’s and third party services and web sites (collectively and individually, “Services”). Use of the Services may require Internet access and that You accept additional terms of service.

    You understand that by using any of the Services, You may encounter content that may be deemed offensive, indecent, or objectionable, which content may or may not be identified as having explicit language, and that the results of any search or entering of a particular URL may automatically and unintentionally generate links or references to objectionable material. Nevertheless, You agree to use the Services at Your sole risk and that the Application Provider shall not have any liability to You for content that may be found to be offensive, indecent, or objectionable.

    Certain Services may display, include or make available content, data, information, applications or materials from third parties (“Third Party Materials”) or provide links to certain third party web sites. By using the Services, You acknowledge and agree that the Application Provider is not responsible for examining or evaluating the content, accuracy, completeness, timeliness, validity, copyright compliance, legality, decency, quality or any other aspect of such Third Party Materials or web sites. The Application Provider does not warrant or endorse and does not assume and will not have any liability or responsibility to You or any other person for any third-party Services, Third Party Materials or web sites, or for any other materials, products, or services of third parties. Third Party Materials and links to other web sites are provided solely as a convenience to You. Financial information displayed by any Services is for general informational purposes only and is not intended to be relied upon as investment advice. Before executing any securities transaction based upon information obtained through the Services, You should consult with a financial professional. Location data provided by any Services is for basic navigational purposes only and is not intended to be relied upon in situations where precise location information is needed or where erroneous, inaccurate or incomplete location data may lead to death, personal injury, property or environmental damage. Neither the Application Provider, nor any of its content providers, guarantees the availability, accuracy, completeness, reliability, or timeliness of stock information or location data displayed by any Services.

    You agree that any Services contain proprietary content, information and material that is protected by applicable intellectual property and other laws, including but not limited to copyright, and that You will not use such proprietary content, information or materials in any way whatsoever except for permitted use of the Services. No portion of the Services may be reproduced in any form or by any means. You agree not to modify, rent, lease, loan, sell, distribute, or create derivative works based on the Services, in any manner, and You shall not exploit the Services in any unauthorized way whatsoever, including but not limited to, by trespass or burdening network capacity. You further agree not to use the Services in any manner to harass, abuse, stalk, threaten, defame or otherwise infringe or violate the rights of any other party, and that the Application Provider is not in any way responsible for any such use by You, nor for any harassing, threatening, defamatory, offensive or illegal messages or transmissions that You may receive as a result of using any of the Services.

    In addition, third party Services and Third Party Materials that may be accessed from, displayed on or linked to from the Devices are not available in all languages or in all countries. The Application Provider makes no representation that such Services and Materials are appropriate or available for use in any particular location. To the extent You choose to access such Services or Materials, You do so at Your own initiative and are responsible for compliance with any applicable laws, including but not limited to applicable local laws. The Application Provider, and its licensors, reserve the right to change, suspend, remove, or disable access to any Services at any time without notice. In no event will the Application Provider be liable for the removal of or disabling of access to any such Services. The Application Provider may also impose limits on the use of or access to certain Services, in any case and without notice or liability.

    e. No Warranty: You expressly acknowledge and agree that use of the licensed application is at your sole risk and that the entire risk as to satisfactory quality, performance, accuracy and effort is with you. To the maximum extent permitted by applicable law, the license application and any services performed or provided by the licensed application (“services”) are provided “as is” and “as available,” with all faults and without warranty of any kind, and application provider hereby disclaims all warranties and conditions with respect to the licensed application and any services, either express, implied or statutory, including, but not limited to, the implied warranties and/or conditions of merchantability, of satisfactory quality, of fitness for a particular purpose, of accuracy, of quiet enjoyment, and non-infringement of third party rights. Application provider does not warrant against interference with your enjoyment of the licensed application, that the functions contained in, or services performed or provided by, the licensed application will meet your requirements, that the operation of the licensed application or services will be uninterrupted or error-free, or that effects in the licensed application or services will be corrected. No oral or written information or advice given by application provider or its authorized representative shall create a warranty. Should the licensed application or services prove defective, you assume the entire cost of all necessary servicing, repair or correction. Some jurisdictions do not allow the exclusion of implied warranties or limitations on applicable statutory rights of a consumer, so the above exclusion and limitations may not apply to you.

    f. Limitation of Liability. To the extent not prohibited by law, in no event shall application provider be liable for personal injury, or any incidental, special, indirect or consequential damages whatsoever, including, without limitation, damages for loss of profits, loss of data, business interruption or any other commercial damages or losses, arising out of or related to your use or inability to use the licensed application, however caused, regardless of the theory of liability (contract, tort or otherwise) and even if application provider has been advised of the possibility of such damages. Some jurisdictions do not allow the limitation of liability for personal injury, or of incidental or consequential damages, so this limitation may not apply to you.

    In no event shall Application Provider’s total liability to you for all damages (other than as may be required by applicable law in cases involving personal injury) exceed the amount of fifty dollars ($50.00). The foregoing limitations will apply even if the above stated remedy fails of its essential purpose.

    g. You may not use or otherwise export or re-export the Licensed Application except as authorized by United States law and the laws of the jurisdiction in which the Licensed Application was obtained. In particular, but without limitation, the Licensed Application may not be exported or re-exported (a) into any U.S. embargoed countries or (b) to anyone on the U.S. Treasury Department’s list of Specially Designated Nationals or the U.S. Department of Commerce Denied Person’s List or Entity List. By using the Licensed Application, you represent and warrant that you are not located in any such country or on any such list. You also agree that you will not use these products for any purposes prohibited by United States law, including, without limitation, the development, design, manufacture or production of nuclear, missiles, or chemical or biological weapons.

    h. The Licensed Application and related documentation are “Commercial Items”, as that term is defined at 48 C.F.R. §2.101, consisting of “Commercial Computer Software” and “Commercial Computer Software Documentation”, as such terms are used in 48 C.F.R. §12.212 or 48 C.F.R. §227.7202, as applicable. Consistent with 48 C.F.R. §12.212 or 48 C.F.R. §227.7202-1 through 227.7202-4, as applicable, the Commercial Computer Software and Commercial Computer Software Documentation are being licensed to U.S. Government end users (a) only as Commercial Items and (b) with only those rights as are granted to all other end users pursuant to the terms and conditions herein. Unpublished-rights reserved under the copyright laws of the United States.

    i. The laws of the State of Belgium, excluding its conflicts of law rules, govern this license and your use of the Licensed Application. Your use of the Licensed Application may also be subject to other local, state, national, or international laws.

    Edit this page on GitHub

    ← Recycle
    \ No newline at end of file