Merge branch 'develop' into 2.0
@@ -11,7 +11,7 @@
|
||||
|
||||
As burgalary is very common, we believe that video surveillance is a **trivial tool** in our daily lifes which helps us to **feel** a little 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** camera's, recorders and software solutions which are mainly **outdated** and **difficult** to install and use. Kerberos.io's goal is to solve these problems and to provide every human being in this world to have its own **ecological**, **affordable**, **easy-to-use** and **innovative** surveillance solution.
|
||||
Nowadays we have a myriad of **expensive** camera's, recorders and software solutions which are mainly **outdated** and **difficult** to install and use. Kerberos.io's goal is to solve these problems and to provide every human being in this world to have its own **ecological**, **affordable**, **easy-to-use** and **innovative** surveillance solution. Read more about [**our strategy here**](/strategy).
|
||||
|
||||
<a name="what-is-kerberos-io"></a>
|
||||
## What's Kerberos.io?
|
||||
@@ -46,7 +46,7 @@ Kerberos.io comes with **a bunch of features**, below you can find a short list
|
||||
* Fluent and **responsive overview** (Smartphone, Tablet and PC) of snapshots by day and hour.
|
||||
* System information (CPU, disk, network, etc).
|
||||
* Use [**Kerberos.cloud**](https://cloud.kerberos.io) to view your activity from anywhere in the world.
|
||||
* **Multiple cameras** with Docker or Raspbian.
|
||||
* **Multiple cameras** with Docker or Raspbian; read more about the [**best practices**](/best_practices).
|
||||
* **REST API** to control Kerberos.io from your custom solution/program.
|
||||
* **Cross-browser support**: IE, Chrome, Safari, Firefox.
|
||||
|
||||
|
||||
|
Before Width: | Height: | Size: 58 KiB |
|
Before Width: | Height: | Size: 19 KiB |
BIN
2_scorpi.png
|
Before Width: | Height: | Size: 340 KiB |
42
2_strategy.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# Strategy
|
||||
|
||||
In this section we'll explain the strategy of Kerberos.io in terms of goals, design/architecture and user experience.
|
||||
|
||||
## Mission
|
||||
|
||||
As you may have read on the [**Getting started**](/getting_started) page, Kerbers.io's goal is to be an easy to use video surveillance system which works on almost **every system/device**, with almost **every camera**, and that in just a few minutes.
|
||||
|
||||
Before Kerberos.io was designed or we even thought about it, we've found a lot of different surveillance solutions available in the market, of which **most of them are commercialized**. The free surveillance solutions, were mostly outdated and weren't synced with the bleeding edge technologies that we see nowadays.
|
||||
|
||||
We at Kerberos.io want to do something about it. Creating a video surveillance solution with bleeding edge technologies, available for everyone in this world, is our mission. With Kerberos.io we even want to **challenge commercial surveillance solutions**, by showing them how powerful an open source community is.
|
||||
|
||||
You only live once (YOLO), and therefore we want to give this world, with all the people living on it, something to **protect itself against all the bad things** strolling in our streets. We want to protect your families, properties and the things you care for. We **are a team** of hobbiest, professionals and people that want to move forward.
|
||||
|
||||
## Architecture
|
||||
|
||||
Here you'll find the thoughts we had, and still have, while developing and architecturing Kerberos.io. These are the results of what Kerberos.io nowadays is.
|
||||
|
||||
<a name="one-vs-multi"></a>
|
||||
### The one vs multi camera support discussion
|
||||
|
||||
The most common question we get is the following:
|
||||
|
||||
*I want to connect multiple cameras to Kerberos.io is it possible?*
|
||||
|
||||
The answer that we give is:
|
||||
|
||||
*Yes, it's possible because a lot of people asked for it, but we don't recommend it at all.*
|
||||
|
||||
So this might be a strange answer, but why don't we recommend it? The core idea of Kerberos.io is that it's easy to use, isolated and developed with clean code. We at Kerberos.io don't believe that a surveillance system which can configure **N** cameras is or can be intuitive for an end user, in terms of visualization and configuration. Besides user experience this will also **face its technical limitations when scaling** the solution with a lot of cameras; this can cause weird, unexpected and hard to debug deviations.
|
||||
|
||||
Kerberos.io **embraces the concept of isolation**. Every camera should have its own isolated environment, so a processing unit (server, Raspberry Pi, Docker container, etc) per camera. By using this concept you have **the benefit of spreading risk**: if one processing unit goes down, the other ones stay operational. We think the best way to manage your cameras is to have **the ability to pin point** them, and **replace** them **without affecting any other** cameras.
|
||||
|
||||
On the other hand we **don't see a lot of benefits** (others than saving some money) **in practice** for connecting multiple cameras to a single processing unit. For example if you would be using USB cameras, it would be **rare to use them at exactly the same place**. When you're in this situation you probably need to pick a better place or position to install the camera and its processing unit. When running a lot of IP cameras, **running a Raspberry Pi** or other board, **for every single IP camera is overkill**, in this situation we strongly recommend to deploy Docker containers, so they are still virtually seperated processing units. Using **a single machine**, Raspberry Pi or other board **to manage all your IP cameras** without seperate virtual processing units (Docker) **is against the concept of isolation**.
|
||||
|
||||
This is **our vision about one vs multi camera support**, however we are aware that situations might exist where multi camera support is the best option, and that's also the reason why we've made it possible. You can use the Armbian, Raspbian or Docker installation to make this possible. For more information when to use which scenario, read the [**best practices**](/best_practices) page.
|
||||
|
||||
### Security
|
||||
|
||||
Security is Kerberos.io's number 1. When installing Kerberos.io, we **don't force** the system or user **to expose ports**. The idea is that Kerberos.io is used and **managed within a local network**, and **doesn't need internet access** to work properly. However a user can, at own risk, decide to make Kerberos.io public by enabling port forwarding on the router, so he or she is able to view the media remotely; a better option would be to setup a VPN tunnel, so the information is encrypted.
|
||||
|
||||
When you want to access your media online, we strongly [**recommend to use Kerberos.cloud**](https://cloud.kerberos.io) for making it public. With Kerberos.cloud we encrypt all your data and only make it available for a short period (minutes). Read more [**about Kerberos.cloud here**](/addons/Cloud).
|
||||
|
Before Width: | Height: | Size: 30 KiB After Width: | Height: | Size: 30 KiB |
|
Before Width: | Height: | Size: 31 KiB After Width: | Height: | Size: 31 KiB |
@@ -4,7 +4,7 @@
|
||||
|
||||
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
|
||||
|
||||
@@ -21,4 +21,4 @@ Kerberos.io can also be installed on other boards by following the [**Armbian**]
|
||||
|
||||
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.
|
||||
|
||||

|
||||

|
||||
52
4_best_practices.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# Best practices
|
||||
|
||||
Kerberos.io can be **used for many different purposes**: nanny cam, baby monitor, site monitor, parking monitor, pet monitor, vacation monitor, people counting, real-time monitoring, recording, and the list goes on. Kerberos.io also gives you **a lot of possible ways to install it** on the devices your prefer. You can install it on your local Linux system e.g. Ubuntu, Raspbian, Armbian, Docker and by using our own OS, named KiOS.
|
||||
|
||||
Having all these different scenarios, ways to install and possible combinations, **it might be hard to find the best setup** for your specific situation. On this page we will discuss a couple of scenarios, and which solution/setup is the best pratice/match for each one of them.
|
||||
|
||||
One of the strategies Kerberos.io follows is **the concept of isolation**. Read more about it on the [**strategy page**](/strategy) and the [**one vs multi camera support**](/strategy#one-vs-multi) discussion for a complete understanding of the best practices.
|
||||
|
||||
## IP cameras
|
||||
|
||||
This is the most common scenario. Nowadays if you want to buy a camera, there is a 90% chance that it will be an IP camera.
|
||||
|
||||
IP cameras have outnumbered the video camera industry, they come with many different flavours and technologies (e.g. ONVIF). Typically a user will **buy one or more IP cameras**, **position them** at various places at home or work, and **install a video surveillance system** to manage them; e.g. Kerberos.io.
|
||||
|
||||
### Desire
|
||||
|
||||
What we often see is that users ask for, or desire to have, one single application where they can access and manage all there different IP cameras. This desire may look obvious at first sight, but has **limitations on the long run**.
|
||||
|
||||
Many video surveillance solutions, other than Kerberos.io, uses the approach previously described. However this approach is against the Kerberos.io strategy/philosophy, read more about it on the [**strategy page**](/strategy) and the [**one vs multi camera support**](/strategy#one-vs-multi) discussion.
|
||||
|
||||
### Best practice
|
||||
|
||||
When you have an enterprise environment, or just have a lot of IP cameras (>2), you [**should consider to use Docker**](/installation/Multi-camera/Docker). When using **Kerberos.io with Docker**, you create an individual virtual processing units, **a Docker container**, for each camera.
|
||||
|
||||
By using this approach the management of your cameras is transparant and you have the ability to pin point them by an IP address (or port). Next to that you will have **a highly scalable solution**, when new cameras are installed you create new containers for each camera. When processing a lot of cameras you can eventually use **Docker swarm** to load balance containers over multiple systems.
|
||||
|
||||
### Dont's
|
||||
|
||||
What we often see is that users want to use a single Raspberry Pi or other board, to manage multiple IP cameras. Though this is possible with the Raspbian or Armbian installation, we don't recommend this when processing a lot of IP cameras (>2), due to:
|
||||
|
||||
* limited resources (CPU and RAM),
|
||||
* visualization and configuration in the web interface is not intuitive,
|
||||
* and unreliably for network drops.
|
||||
|
||||
When using only one or two IP cameras you can consider to use a multi camera approach with Raspbian or Armbian. In this case a Docker setup can be overkill.
|
||||
|
||||
## Local cameras (e.g. USB camera)
|
||||
|
||||
One of the goals of Kerberos.io is to be a cheap and ecologic video surveillance solution. With Kerberos.io you can **reuse your old USB cameras**, and combine them with a board (Raspberry Pi or other) to use them as a professional surveillance system.
|
||||
|
||||
### Desire
|
||||
|
||||
Just the like the IP camera scenario, users want to have a single application where they can manage all their cameras. The same philosophy applies here, Kerberos.io recommends the concept of **isolation**. Though with USB cameras it might be more useful to connect multiple cameras as they require a machine or board to process them; the processing unit needs to be at the same place of the camera. You **don't have the possibility to use Docker** when using USB cameras.
|
||||
|
||||
### Best practice
|
||||
|
||||
If you consider to connect multiple local cameras to a processing unit (server, Raspberry Pi or other board), you should take into account following points:
|
||||
|
||||
* Did you positioned your cameras properly?
|
||||
* Has the second (or other) camera a lot of value? Maybe can you give it a better position somewhere else.
|
||||
|
||||
In most of the cases a second or third camera can be of a lot of value e.g. a 360° view. However in most of the cases this is totally overkill and you should better use it at a completely other position.
|
||||
@@ -2,6 +2,8 @@
|
||||
|
||||
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.
|
||||
|
||||
Before you decide which installation method you will use, it might be interesting to read about our [**best practices**](/best_practices) and the [**one vs multi camera support**](/strategy#one-vs-multi) discussion.
|
||||
|
||||
## 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).
|
||||
|
||||