mirror of
https://github.com/kerberos-io/documentation.git
synced 2026-08-23 15:18:31 +00:00
update documentation
This commit is contained in:
Cédric Verstraeten
@@ -16,7 +16,7 @@ Nowadays we have a myriad of **expensive** camera's, recorders and software solu
|
||||
<a name="what-is-kerberos-io"></a>
|
||||
## What's Kerberos.io?
|
||||
|
||||
Kerberos.io is a **low-budget** video surveillance solution, that uses computer vision algorithms to detect changes, and that can trigger other devices. Kerberos.io is open source so everyone can customize the source code to its needs and share it with the community under the [**CC-NC-ND license model**](/license). When deployed on the Raspberry Pi, it has a **green footprint** and it's **easy to install**; you only need to transfer the [**Kerberos.io OS (KIOS)**](/installation/KiOS) to your SD card and that's it.
|
||||
Kerberos.io is a **low-budget** video surveillance solution, that uses computer vision algorithms to detect changes, and that can trigger other devices. Kerberos.io is open source so everyone can customize the source code to its needs and share it with the community under the [**CC-NC-ND license model**](/license). When deployed on the Raspberry Pi or any other board, it has a **green footprint** and it's **easy to install**; you only need to transfer the [**Kerberos.io OS (KIOS)**](/installation/KiOS) to your SD card and that's it.
|
||||
|
||||
<iframe src="https://player.vimeo.com/video/163975947?autoplay=0&color=943633" style="width:100%; height: 400px;" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
|
||||
|
||||
@@ -59,4 +59,4 @@ Installing <b>Kerberos.io</b> to your IoT device, has never been so easy. By usi
|
||||
<img src="/images/kios-install.gif" style="border-radius: 0; margin: 0 0 10px 0; width: 100%;"/>
|
||||
</a>
|
||||
|
||||
By using the KiOS installer, you'll get <b>an easy to use GUI</b> which allows you to configure and **flash KiOS to your SD card**. Just download the installer, select a version, specify your network configurations, select your SD card and press the flash button; **it can't be easier**. If you **don't want to reflash you SD card**, you can run Kerberos.io on your [**Raspbian**](/installation/Raspbian) or [**Armbian**](/installation/armbian) installation, or as a [**Docker container**](/installation/Docker).
|
||||
By using the KiOS installer, you'll get <b>an easy to use GUI</b> which allows you to configure and **flash KiOS to your SD card**. Just download the installer, select a version, specify your network configurations, select your SD card and press the flash button; **it can't be easier**. If you **don't want to reflash you SD card**, you can run Kerberos.io on your existing [**Raspbian**](/installation/Raspbian) or [**Armbian**](/installation/armbian) installation, or if you like containers with [**Docker**](/installation/Docker).
|
||||
BIN
2_cameras.png
Normal file
BIN
2_cameras.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 30 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 19 KiB |
BIN
2_machines.png
Normal file
BIN
2_machines.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 31 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 23 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 33 KiB |
@@ -1,45 +1,24 @@
|
||||
# Requirements
|
||||
|
||||
## Which hardware do I need?
|
||||
## Which type of machines can you use?
|
||||
|
||||
Kerberos.io runs on every machine but its main goal is to run on a Raspberry Pi or any other board. We provide multiple ways (KIOS, Raspbian, Armbian, Docker, etc) to install Kerberos.io on the device your prefer. If you want to run Kerberos.io on a Raspberry Pi or any other board you'll first need to **buy some hardware**.
|
||||
Kerberos.io runs on every Linux based machine but its main goal is to run on a Raspberry Pi or other boards due to its low energy consumption. We provide multiple ways (KIOS, Raspbian, Armbian, Docker, etc) to install Kerberos.io on the device your prefer. If you will install Kerberos.io with Docker, or on your local Linux machine, nothing special should be purchased except a video camera.
|
||||
|
||||
|
||||
|
||||
### Raspberry Pi
|
||||
|
||||
As said, you can run Kerberos.io **on every Linux based machine**, however we recommend to run Kerberos.io on a **Raspberry Pi**, as it is a low-budget microcontroller which can you buy in almost every (online) electronic shop.
|
||||
|
||||
To simplify the lives of our Raspberry Pi users, Kerberos.io comes with a custom ARM OS called [**KIOS**](installation/KiOS) (Kerberos.io Operating System), which you can deploy to your Raspberry Pi in just a few minutes. Kerberos.io supports **all Raspberry Pi versions** (1, 2, 3 and Zero).
|
||||
|
||||
|
||||
We recommend to run Kerberos.io on a **Raspberry Pi**, as it is a very popluar microcontroller which can you buy in almost every (online) electronic shop. To simplify the lives of our Raspberry Pi users, Kerberos.io comes with a custom ARM OS called [**KIOS**](installation/KiOS) (Kerberos.io Operating System), which you can deploy to your Raspberry Pi in just a few minutes. Kerberos.io supports **all Raspberry Pi versions** (1, 2, 3 and Zero).
|
||||
|
||||
### What about other boards?
|
||||
|
||||
Kerberos.io can also be installed on other boards by following the [**Armbian**](/installation/armbian) installation. This is a short list of microcontrollers on which we have tested Kerberos.io using the Armbian OS:
|
||||
Kerberos.io can also be installed on other boards by following the [**Armbian**](/installation/armbian) installation. At the moment of writing we don't have support for KiOS, so the installation is a little bit harder. This is a short list of microcontrollers on which we have tested Kerberos.io using the Armbian OS:
|
||||
|
||||
* PCDuino3 Nano (Allwinner A20)
|
||||
* Orange Pi + (Allwinner H3)
|
||||
|
||||
### SD card
|
||||
|
||||
If you want to use your Raspberry Pi, you will need to have a SD card, on which an OS will be installed. Therefore you will need a **2GB or bigger SD card**.
|
||||
|
||||
|
||||
|
||||
### Power supply
|
||||
|
||||
You will need to have a **micro USB 5V** charger, to give the Raspberry Pi some juice.
|
||||
|
||||
|
||||
|
||||
### Camera
|
||||
## Which type of camera can you use?
|
||||
|
||||
Kerberos.io works with the full range of camera's. You can use an **USB-**, **IP-** or the **Raspberry Pi camera (v1.3 and v2.1)**. If you want to use an IP camera, we recommend to use the RTSP connection if available; note that it's possible that cheap IP cameras will not work properly.
|
||||
|
||||
|
||||
|
||||
|
||||
### Optional
|
||||
|
||||
You can use a **WIFI dongle** instead of an ethernet cable, but this is not required. We recommend the **Edimax** ew-7811un WIFI dongle; this is not necessary for the Raspberry Pi 3 as this is built-in.
|
||||
|
||||
|
||||
|
||||
@@ -1,35 +1,37 @@
|
||||
#First things first
|
||||
|
||||
The reason why you're on this page is because you want to know how to install Kerberos.io on your microcontroller, local working station, server or whatever Linux machine you prefer. The good news is that we have **different approaches** from basic to advanced; it depends on how you want to install it.
|
||||
The reason why you're on this page is because you want to know **how to install Kerberos.io** on your microcontroller, Docker, local working station, server or whatever Linux environment you prefer. The good news is that we have **different approaches** from basic to advanced; it depends on how you want to install it.
|
||||
|
||||
## Raspberry Pi (ARM)
|
||||
## Raspberry Pi
|
||||
|
||||
When deploying on the Raspberry Pi there are two possible solutions. You can use our custom OS, [**KiOS**](installation/KiOS) (Kerberos.io Operating System), which is production-ready or install it on an existing OS, [**Raspbian**](installation/Raspbian).
|
||||
|
||||
###KiOS
|
||||
|
||||
[KiOS](https://github.com/kerberos-io/kios) is a custom linux OS (created by buildroot) which runs Kerberos.io out-of-the-box. KiOS is **installed like every other OS** for the Raspberry Pi, you need to flash the OS (.img) to a SD card, update your network configration and you're up and running; no manual compilation or horrible configurations. This is the **most simple** and **basic** installation procedure.
|
||||
[KiOS](https://github.com/kerberos-io/kios) is a custom linux OS (created by buildroot) which runs Kerberos.io out-of-the-box. This is the **most simple** and **basic** installation procedure. Note that with KiOS you don't have multiple camera support.
|
||||
|
||||
<div style="float:right;margin-top:-15px;"><a href="installation/KiOS" style="color:#fff;background-color:#943633;border-radius:7px;padding:8px;">Install KiOS</a></div>
|
||||
|
||||
###Raspbian
|
||||
|
||||
If you already have a Raspberry Pi running with Raspbian, you probably don't want to reflash your SD-card. Therefore you can install the different parts of Kerberos.io (machinery and web) manual.
|
||||
If you already have a Raspberry Pi running with Raspbian, you probably **don't want to reflash your SD card**. Therefore you can install the different parts of Kerberos.io (machinery and web) manual.
|
||||
|
||||
<div style="float:right;margin-top:-15px;"><a href="installation/Raspbian" style="color:#fff;background-color:#943633;border-radius:7px;padding:8px;">Install on Raspbian</a></div>
|
||||
|
||||
## Other
|
||||
## Armbian supported boards
|
||||
|
||||
Kerberos.io can also be installed on a PC, Laptop or server. Similar to Raspbian, the different parts needs to be installed manually.
|
||||
If you have <a href="https://www.armbian.com/download/" target="_blank">**an Armbian supported board**</a>, you can follow the Armbian installation to transform it into a surveillance system.
|
||||
|
||||
###Docker
|
||||
<div style="float:right;margin-top:-15px;"><a href="installation/Armbian" style="color:#fff;background-color:#943633;border-radius:7px;padding:8px;">Install on Armbian</a></div>
|
||||
|
||||
A Docker image is available on the Docker Hub for the x86 architecture. By using docker-compose you can run Kerberos.io with a one-liner.
|
||||
##Docker
|
||||
|
||||
A Docker image is available on the Docker Hub for **x86 machines**. By using docker-compose you can run Kerberos.io with a one-liner.
|
||||
|
||||
<div style="float:right;margin-top:-15px;"><a href="installation/Docker" style="color:#fff;background-color:#943633;border-radius:7px;padding:8px;">Run on Docker</a></div>
|
||||
|
||||
###Advanced
|
||||
##Generic
|
||||
|
||||
This you will need to compile the machinery and install the web interface; It's a little bit more work.
|
||||
You can install Kerberos.io an Linux based OS like Ubuntu, Debian, OSX, etc. However we don't have a prepackaged solution, there fore you will need to compile the machinery and install the web interface.
|
||||
|
||||
<div style="float:right;margin-top:-15px;"><a href="installation/advanced" style="color:#fff;background-color:#943633;border-radius:7px;padding:8px;">Compile yourself</a></div>
|
||||
|
||||
Reference in New Issue
Block a user