diff --git a/config/production/config.toml b/config/production/config.toml index 35c8364..0914051 100644 --- a/config/production/config.toml +++ b/config/production/config.toml @@ -1,4 +1,4 @@ baseurl = "https://staging.doc.kerberos.live/" canonifyURLs = true -docsRepo = "https://github.com/h-enk/doks" +docsRepo = "https://github.com/kerberos-io/documentation" editPage = true \ No newline at end of file diff --git a/content/enterprise/first-things-first/index.md b/content/enterprise/first-things-first/index.md index e58dd84..94be05c 100644 --- a/content/enterprise/first-things-first/index.md +++ b/content/enterprise/first-things-first/index.md @@ -19,7 +19,7 @@ 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. -Independent from that 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. +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. @@ -38,7 +38,7 @@ The major key differentiators compared to to other solutions are: 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. - +{{< figure src="../../prologue/deployments/onpremise-more-then-5.svg" alt="When you start having bigger deployments it's recommended to go with a Kubernetes approach." caption="When you start having bigger deployments it's recommended to go with a Kubernetes approach." class="stretch">}} 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). @@ -50,7 +50,7 @@ By having the power to add nodes to your cluster, you can anticipate to the ever 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. - +{{< figure src="../../prologue/deployments/cloud-more-then-5.svg" alt="As previous mentioned you could process them in a Kubernetes cluster in the cloud." caption="As previous mentioned you could process them in a Kubernetes cluster in the cloud." class="stretch">}} ## Licensing diff --git a/static/images/factory/kerberos-factory-add-bulk-deployment-excel.png b/content/enterprise/get-started/add-bulk-deployment-excel.png similarity index 100% rename from static/images/factory/kerberos-factory-add-bulk-deployment-excel.png rename to content/enterprise/get-started/add-bulk-deployment-excel.png diff --git a/static/images/factory/deployment-configuration.gif b/content/enterprise/get-started/deployment-configuration.gif similarity index 100% rename from static/images/factory/deployment-configuration.gif rename to content/enterprise/get-started/deployment-configuration.gif diff --git a/static/images/factory/kerberos-factory-deployments.png b/content/enterprise/get-started/deployments.png similarity index 100% rename from static/images/factory/kerberos-factory-deployments.png rename to content/enterprise/get-started/deployments.png diff --git a/static/images/factory/kerberos-enterprise-to-cloud.gif b/content/enterprise/get-started/enterprise-to-hub.gif similarity index 100% rename from static/images/factory/kerberos-enterprise-to-cloud.gif rename to content/enterprise/get-started/enterprise-to-hub.gif diff --git a/static/images/factory/global-configuration.gif b/content/enterprise/get-started/global-configuration.gif similarity index 100% rename from static/images/factory/global-configuration.gif rename to content/enterprise/get-started/global-configuration.gif diff --git a/content/enterprise/get-started/index.md b/content/enterprise/get-started/index.md index 3bf62f1..d2a001d 100644 --- a/content/enterprise/get-started/index.md +++ b/content/enterprise/get-started/index.md @@ -26,7 +26,8 @@ Important to note is that this web app is relying on the Golang Kubernetes SDK, Once you open a browser, and navigate to the Factory web application (see installation for the url), you will land on the login page. -
+{{< figure src="login.gif" alt="Login into the Kerberos Enterprise agent interface." caption="Login into the Kerberos Enterprise agent interface." class="stretch">}} + The default username password of the Factory web applications is: @@ -41,7 +42,8 @@ On the overview page you will find an intuitive overview of the different pages 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. -
+{{< figure src="overview.gif" alt="Review your Docker or Kubernetes agents." caption="Review your Docker or Kubernetes agents." class="stretch">}} + ## Kubernetes @@ -55,19 +57,19 @@ On the left menu you will find the Kubernetes section. In this section 3 sub men 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. -
+{{< figure src="nodes.png" alt="Get an entire list of nodes which are connected to your Kubernetes cluster." caption="Get an entire list of nodes which are connected to your Kubernetes cluster." class="stretch">}} ## 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. -
+{{< figure src="deployments.png" alt="Get a list of all your Kerberos Enterprise agents." caption="Get a list of all your Kerberos Enterprise agents." class="stretch">}} ### Adding a new deployment There are two options to add a new deployment, single deployments and bulk deployment. -
+{{< figure src="single-bulk-deployment.gif" alt="Get a list of all your Kerberos Enterprise agents." caption="Get a list of all your Kerberos Enterprise agents." class="stretch">}} - single deployment @@ -79,13 +81,13 @@ 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. -
+{{< figure src="add-bulk-deployment-excel.png" alt="Add a Kerberos Enterprise agent through a deployment." caption="Add a Kerberos Enterprise agent through a deployment." class="stretch">}} ### 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. -
+{{< figure src="deployment-configuration.gif" alt="Once you created the Kerberos Enterprise agent, you can configure the agent." caption="Once you created the Kerberos Enterprise agent, you can configure the agent." class="stretch">}} Following settings can be changed: @@ -101,7 +103,7 @@ Configuration can be specified on a Kerberos Enterprise agent level, this means 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. -
+{{< figure src="global-configuration.gif" alt="You can specify the configurations on a global level, so all agents will inherit from that." caption="You can specify the configurations on a global level, so all agents will inherit from that." class="stretch">}} ### Upgrade or reboot a Kerberos Enterprise agent @@ -109,13 +111,13 @@ At Kerberos.io we have fast development cycles, which means that new versions wi 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. -
+{{< figure src="upgrade-reboot.gif" alt="You can specify the configurations on a global level, so all agents will inherit from that." caption="You can specify the configurations on a global level, so all agents will inherit from that." class="stretch">}} ## 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. -
+{{< figure src="pods.png" alt="When creating a deployment, a Kubernetes pod has created and assigned to a node." caption="When creating a deployment, a Kubernetes pod has created and assigned to a node." class="stretch">}} ## Storage and video management @@ -129,11 +131,11 @@ Kerberos Enterprise stores its recordings locally for a short amount of time. Th 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). -
+{{< figure src="../../prologue/deployments/deployment-hub-vault.svg" alt="Kerberos Vault allows you to centralise your recordings and build integrations." caption="Kerberos Vault allows you to centralise your recordings and build integrations." class="stretch">}} -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. Once selected you need to fill-in the credentials from your Kerberos Vault account. +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. Typically this is in the following format: `http(s)://api.yourdomain.com/storage`. Where `api.yourdomain.com` should match your Kerberos Vault API endpoint. +- 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. @@ -143,7 +145,7 @@ To connect one or more Kerberos Enterprise agents to your Kerberos Vault instanc - Secret Access Key: this should match the secret access key of one of your Kerberos Vault accounts. -
+{{< figure src="storage-setup.gif" alt="Using Kerberos Vault you can bring your own storage, and store the recordings of your agents in your own storage provider." caption="Using Kerberos Vault you can bring your own storage, and store the recordings of your agents in your own storage provider." class="stretch">}} ### Kerberos Hub @@ -153,7 +155,7 @@ You have two choices when using Kerberos Hub, either you send your recordings fr Select the Kerberos Hub option, and copy-paste the credentials from your Kerberos Hub subscription. -
+{{< figure src="enterprise-to-hub.gif" alt="By linking your Enterprise agent to Kerberos Hub, your recordings and livestreams will become available online." caption="By linking your Enterprise agent to Kerberos Hub, your recordings and livestreams will become available online." class="stretch">}} - Region: this is the region where your recordings will be stored. Only `eu-west-1` for now (will change, on the roadmap). diff --git a/static/images/factory/login.gif b/content/enterprise/get-started/login.gif similarity index 100% rename from static/images/factory/login.gif rename to content/enterprise/get-started/login.gif diff --git a/static/images/factory/kerberos-factory-nodes.png b/content/enterprise/get-started/nodes.png similarity index 100% rename from static/images/factory/kerberos-factory-nodes.png rename to content/enterprise/get-started/nodes.png diff --git a/static/images/factory/docker-kubernetes.gif b/content/enterprise/get-started/overview.gif similarity index 100% rename from static/images/factory/docker-kubernetes.gif rename to content/enterprise/get-started/overview.gif diff --git a/static/images/factory/kerberos-factory-pods.png b/content/enterprise/get-started/pods.png similarity index 100% rename from static/images/factory/kerberos-factory-pods.png rename to content/enterprise/get-started/pods.png diff --git a/static/images/factory/single-bulk-deployment.gif b/content/enterprise/get-started/single-bulk-deployment.gif similarity index 100% rename from static/images/factory/single-bulk-deployment.gif rename to content/enterprise/get-started/single-bulk-deployment.gif diff --git a/static/images/factory/kerberos-enterprise-storage-setup.gif b/content/enterprise/get-started/storage-setup.gif similarity index 100% rename from static/images/factory/kerberos-enterprise-storage-setup.gif rename to content/enterprise/get-started/storage-setup.gif diff --git a/static/images/factory/upgrade-reboot.gif b/content/enterprise/get-started/upgrade-reboot.gif similarity index 100% rename from static/images/factory/upgrade-reboot.gif rename to content/enterprise/get-started/upgrade-reboot.gif diff --git a/content/opensource/get-started/dashboard.png b/content/opensource/get-started/dashboard.png index c1cbb2c..fca7a38 100644 Binary files a/content/opensource/get-started/dashboard.png and b/content/opensource/get-started/dashboard.png differ diff --git a/static/images/opensource/kerberos-opensource-cloud.png b/content/opensource/get-started/hub-connection.png similarity index 100% rename from static/images/opensource/kerberos-opensource-cloud.png rename to content/opensource/get-started/hub-connection.png diff --git a/content/opensource/get-started/index.md b/content/opensource/get-started/index.md index 20d6bf2..d2ea2e8 100644 --- a/content/opensource/get-started/index.md +++ b/content/opensource/get-started/index.md @@ -19,19 +19,19 @@ Once you've installed Kerberos Open Source, you will have access to the web appl 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. - +{{< figure src="welcome.png" alt="The landing page after successfully installing Kerberos Opensource." caption="The landing page after successfully installing Kerberos Opensource." class="stretch">}} ## 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**. - +{{< figure src="login.png" alt="After setting up the system you can proceed to login." caption="After setting up the system you can proceed to login." class="stretch">}} ## 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. -{{< figure src="dashboard.png" alt="Dashboard" caption="This is my caption">}} +{{< figure src="dashboard.png" alt="The dashboard gives you a high-level overview of what has been happening." caption="The dashboard gives you a high-level overview of what has been happening." class="stretch">}} ## Media @@ -39,31 +39,31 @@ By selecting a specific day from the left navigation, or choosing the date picke 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. - - - +{{< figure src="media.png" alt="The media page gives an overview of your recordings (grouped into sequences) for that specific day." caption="The media page gives an overview of your recordings (grouped into sequences) for that specific day." class="stretch">}} +{{< figure src="media-detail.png" alt="By drilling down into a sequence, you will see all the related recordings." caption="By drilling down into a sequence, you will see all the related recordings." class="stretch">}} ## 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. - +{{< figure src="settings.png" alt="The settings page allows you to modify and tweak the camera and motion settings." caption="The settings page allows you to modify and tweak the camera and motion settings." class="stretch">}} ### 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). - +{{< figure src="region-of-interest.png" alt="The region of interest allows you to inspect a specific region of the camera." caption="The region of interest allows you to inspect a specific region of the camera." class="stretch">}} ### 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 Cloud](/cloud) credentials in the storage section, your recordings will be synced to our cloud solution. +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](/hub/first-things-first) credentials in the storage section, your recordings will be synced to our cloud solution. + +{{< figure src="hub-connection.png" alt="The region of interest allows you to inspect a specific region of the camera." caption="The region of interest allows you to inspect a specific region of the camera." class="stretch">}} - ## 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. - \ No newline at end of file +{{< figure src="system.png" alt="The system pages show you the current status of your agent." caption="The system pages show you the current status of your agent." class="stretch">}} diff --git a/static/images/opensource/kerberos-opensource-login.png b/content/opensource/get-started/login.png similarity index 100% rename from static/images/opensource/kerberos-opensource-login.png rename to content/opensource/get-started/login.png diff --git a/static/images/opensource/kerberos-opensource-media-detail.png b/content/opensource/get-started/media-detail.png similarity index 100% rename from static/images/opensource/kerberos-opensource-media-detail.png rename to content/opensource/get-started/media-detail.png diff --git a/static/images/opensource/kerberos-opensource-media.png b/content/opensource/get-started/media.png similarity index 100% rename from static/images/opensource/kerberos-opensource-media.png rename to content/opensource/get-started/media.png diff --git a/static/images/opensource/kerberos-opensource-motion.png b/content/opensource/get-started/region-of-interest.png similarity index 100% rename from static/images/opensource/kerberos-opensource-motion.png rename to content/opensource/get-started/region-of-interest.png diff --git a/static/images/opensource/kerberos-opensource-settings.png b/content/opensource/get-started/settings.png similarity index 100% rename from static/images/opensource/kerberos-opensource-settings.png rename to content/opensource/get-started/settings.png diff --git a/static/images/opensource/kerberos-opensource-system.png b/content/opensource/get-started/system.png similarity index 100% rename from static/images/opensource/kerberos-opensource-system.png rename to content/opensource/get-started/system.png diff --git a/static/images/opensource/kerberos-opensource-welcome.png b/content/opensource/get-started/welcome.png similarity index 100% rename from static/images/opensource/kerberos-opensource-welcome.png rename to content/opensource/get-started/welcome.png diff --git a/static/images/opensource/kerberos-opensource-balena-create.png b/content/opensource/installation/balena-create.png similarity index 100% rename from static/images/opensource/kerberos-opensource-balena-create.png rename to content/opensource/installation/balena-create.png diff --git a/static/images/opensource/kerberos-opensource-balena-push.png b/content/opensource/installation/balena-push.png similarity index 100% rename from static/images/opensource/kerberos-opensource-balena-push.png rename to content/opensource/installation/balena-push.png diff --git a/static/images/opensource/kerberos-opensource-balena-signup.png b/content/opensource/installation/balena-signup.png similarity index 100% rename from static/images/opensource/kerberos-opensource-balena-signup.png rename to content/opensource/installation/balena-signup.png diff --git a/static/images/opensource/kerberos-opensource-balena-updating.png b/content/opensource/installation/balena-updating.png similarity index 100% rename from static/images/opensource/kerberos-opensource-balena-updating.png rename to content/opensource/installation/balena-updating.png diff --git a/static/images/opensource/kerberos-opensource-dashboard.png b/content/opensource/installation/dashboard.png similarity index 100% rename from static/images/opensource/kerberos-opensource-dashboard.png rename to content/opensource/installation/dashboard.png diff --git a/static/images/etcher-install.png b/content/opensource/installation/etcher-install.png similarity index 100% rename from static/images/etcher-install.png rename to content/opensource/installation/etcher-install.png diff --git a/content/opensource/installation/index.md b/content/opensource/installation/index.md index 8088d48..0ff8ed0 100644 --- a/content/opensource/installation/index.md +++ b/content/opensource/installation/index.md @@ -44,7 +44,7 @@ KiOS is compiled using Buildroot, the project can be found on [following Github 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! - +{{< figure src="kios-install.gif" alt="Using the KiOS installer, you can easily deploy the Kerberos Opensource agent to your Raspberry Pi." caption="Using the KiOS installer, you can easily deploy the Kerberos Opensource agent to your Raspberry Pi." class="stretch">}} Download the correct installer for your OS below: @@ -58,7 +58,7 @@ If you love Etcher, or the Kerberos installer is not working as expected, you ca 2. flash it to your SD card with Etcher, 3. and edit some configuration files at the boot directory. - +{{< figure src="etcher-install.png" alt="You could also install using the Etcher installer." caption="You could also install using the Etcher installer." class="stretch">}} 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. @@ -96,7 +96,7 @@ static_dns="" Once you've finished the installation using either the KiOS installer or Etcher, you can put the SD card into your Raspberry Pi and turn it on. Please note that the first time you boot KiOS it can take about 2 mins before the system is operational. When KiOS is ready you can open your favorite browser and type in the IP address of your Raspberry Pi. This will open the Kerberos agent's front-end, which you can access with the username: root and password: root. - +{{< figure src="dashboard.png" alt="After successful installation you should land on the starting page." caption="After successful installation you should land on the starting page." class="stretch">}} ### Access the Raspberry Pi @@ -189,14 +189,14 @@ Before getting into the details, you can [find a more detailed tutorial at this Before moving on, make sure you have registered on [Balena](https://www.balena.io). - - +{{< figure src="balena-signup.png" alt="Creating a Balena Cloud account to onboard your Kerberos Opensource agent." caption="Creating a Balena Cloud account to onboard your Kerberos Opensource agent." class="stretch">}} ### 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](https://www.balena.io/etcher/). - +{{< figure src="balena-create.png" alt="After signed up, create an application for your Kerberos Opensource agent." caption="After signed up, create an application for your Kerberos Opensource agent." class="stretch">}} + ### 3. Connect @@ -269,4 +269,4 @@ Now we created our two files, we can publish the Kerberos container to balena (o 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 ;) - +{{< figure src="balena-push.png" alt="Once created you can push the Kerberos Opensource agent to your Balenca Cloud app." caption="Once created you can push the Kerberos Opensource agent to your Balenca Cloud app." class="stretch">}} \ No newline at end of file diff --git a/static/images/kios-install.gif b/content/opensource/installation/kios-install.gif similarity index 100% rename from static/images/kios-install.gif rename to content/opensource/installation/kios-install.gif diff --git a/static/images/machinery/algorithm.png b/content/opensource/machinery/algorithm.png similarity index 100% rename from static/images/machinery/algorithm.png rename to content/opensource/machinery/algorithm.png diff --git a/static/images/machinery/differential_images.png b/content/opensource/machinery/differential-images.png similarity index 100% rename from static/images/machinery/differential_images.png rename to content/opensource/machinery/differential-images.png diff --git a/static/images/machinery/hull.png b/content/opensource/machinery/hull.png similarity index 100% rename from static/images/machinery/hull.png rename to content/opensource/machinery/hull.png diff --git a/content/opensource/machinery/index.md b/content/opensource/machinery/index.md index c2937b6..e857532 100644 --- a/content/opensource/machinery/index.md +++ b/content/opensource/machinery/index.md @@ -28,7 +28,7 @@ The steps belong to a four passway; illustrated on the image below. In each cycl 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. -

+{{< figure src="project-structure.svg" alt="The Kerberos Opensource agent is composed out of different concepts." caption="The Kerberos Opensource agent is composed out of different concepts." class="stretch">}} 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: @@ -256,7 +256,7 @@ The delay value is used when the condition failed, so when the current time isn' The algorithm is the second step of the four passway. An algorithm will execute some kind of function on a sequence of images, and end up with a black and white image; just like the image below. An example of an algorithm would be one that does motion detection or one that would detect cats or dogs (using TensorFlow, ar any other Deep Learning framework). -
+{{< figure src="algorithm.png" alt="An algorithm allows us to find the pixels of interests." caption="An algorithm allows us to find the pixels of interests." class="stretch">}} The white pixels on the image will indicate the object of interest. For example, when looking for motion, the pixels that have been changed; it depends on what the algorithm is looking for. The black pixels are background pixels. @@ -281,13 +281,13 @@ This algorithm is a very simple method to detect motion; in terms of understandi To get a more technical explanation: the algoritm will substract 2 or more images, and once that is done it will end up with a black and white image. The white pixels will mark the pixels that where different/changed and the black pixels are the pixels that have not changed; background pixels. Please note that there are several different combinations of substracting images. However for the machinery, we will use the method of Collins et al. as this method erases the phenomenon "ghosting". -
+{{< figure src="differential-images.png" alt="The differential images algorithm takes a sequence of images to calculate motion." caption="The differential images algorithm takes a sequence of images to calculate motion." class="stretch">}} In the image above the method of Collins et al. is illustrated. For this method we will process three images. The images are a sequence (from left to right), so the first (A) image was taken before the second (B) one, and the second (B) before the third (C) one. Next we will do a first comparision (C-B) of the third (C) image and the second (B) image, and after that we will do a second comparison (C-A) of the third (C) image and first (A) image. After the comparison we will end up with two difference images (C-B) and (C-A); both will mark the white pixels as changed pixels and black as non-changed pixels. To finish the algorithm we will do a logical AND-operation of the two difference images; this will give us the final black and white image ((C-B)&&(C-A)). -The main idea of the Colins et al. method, is that it will erase "ghosting". In the last step we are doing a logical AND-operation, by doing this we will only keep the pixels, that changed in the first two images; therefore we can elimante false positives. +The main idea of the Colins et al. method, is that it will erase "ghosting". In the last step we are doing a logical AND-operation, by doing this we will only keep the pixels, that changed in the first two images; therefore we can eliminate false positives. #### Parameters @@ -364,7 +364,7 @@ The region parameter contains 4 values; x1, y1, x2 and y2 respectively. The valu This hull is a more complex expositor than the rectangle. A hull can be selected with the web, you can select one or more coordinates to create a flexible region. The coordinates can be adjusted afterwards and be removed by double clicking on the coordinate. You can expand the hull by removing the start coordinate, which is marked by the white bullet. -
+{{< figure src="hull.png" alt="A hull, or polygon, allows you to specify a region of interest." caption="A hull, or polygon, allows you to specify a region of interest." class="stretch">}} #### Parameters diff --git a/static/images/machinery/project-structure.svg b/content/opensource/machinery/project-structure.svg similarity index 100% rename from static/images/machinery/project-structure.svg rename to content/opensource/machinery/project-structure.svg diff --git a/static/images/web/dashboard.png b/content/opensource/web/dashboard.png similarity index 100% rename from static/images/web/dashboard.png rename to content/opensource/web/dashboard.png diff --git a/content/opensource/web/index.md b/content/opensource/web/index.md index 2b4d1e1..e27b7ee 100644 --- a/content/opensource/web/index.md +++ b/content/opensource/web/index.md @@ -25,27 +25,25 @@ We will shortly discuss the different pages that make up the web interface of Ke 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. -
+{{< figure src="dashboard.png" alt="The dashboard gives a high-level overview of your Kerberos Opensource agent." caption="The dashboard gives a high-level overview of your Kerberos Opensource agent." class="stretch">}} ### 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. -![web overview](../../public/images/web/overview.png) +{{< figure src="overview.png" alt="The media page gives an overview of your recordings (grouped into sequences) for that specific day." caption="The media page gives an overview of your recordings (grouped into sequences) for that specific day." class="stretch">}} ### 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. - - -![web settings](../../public/images/web/settings.png) +{{< figure src="settings.png" alt="The settings page allows you to modify and tweak the camera and motion settings." caption="The settings page allows you to modify and tweak the camera and motion settings." class="stretch">}} ### 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. -![web system](../../public/images/web/system.png) +{{< figure src="system.png" alt="The system pages show you the current status of your agent." caption="The system pages show you the current status of your agent." class="stretch">}} ## Project structure diff --git a/static/images/web/overview.png b/content/opensource/web/overview.png similarity index 100% rename from static/images/web/overview.png rename to content/opensource/web/overview.png diff --git a/static/images/web/settings.png b/content/opensource/web/settings.png similarity index 100% rename from static/images/web/settings.png rename to content/opensource/web/settings.png diff --git a/static/images/web/system.png b/content/opensource/web/system.png similarity index 100% rename from static/images/web/system.png rename to content/opensource/web/system.png diff --git a/content/opensourcev3/announcement/index.md b/content/opensourcev3/announcement/index.md index 861f83f..85012ae 100644 --- a/content/opensourcev3/announcement/index.md +++ b/content/opensourcev3/announcement/index.md @@ -19,7 +19,7 @@ Kerberos Open Source (v3) is the next generation of Kerberos.io, and is the succ 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. - +{{< figure src="opensource-version2-version3.svg" alt="The Opensource version 3 is a complete new rewrite of the version 2." caption="The Opensource version 3 is a complete new rewrite of the version 2." class="stretch">}} ## FAQ diff --git a/static/images/opensourcev3/opensource-version2-version3.svg b/content/opensourcev3/announcement/opensource-version2-version3.svg similarity index 100% rename from static/images/opensourcev3/opensource-version2-version3.svg rename to content/opensourcev3/announcement/opensource-version2-version3.svg diff --git a/static/images/access.png b/static/images/access.png deleted file mode 100644 index 104b8cd..0000000 Binary files a/static/images/access.png and /dev/null differ diff --git a/static/images/vendor/.gitkeep b/static/images/vendor/.gitkeep deleted file mode 100644 index e69de29..0000000