documentation/opensource/get-started/index.html

<!doctype html><html lang=en-us><head><meta charset=utf-8><meta http-equiv=x-ua-compatible content="ie=edge"><meta name=viewport content="width=device-width,initial-scale=1,shrink-to-fit=no"><link rel=preload as=font href=https://staging.doc.kerberos.live/fonts/vendor/jost/jost-v4-latin-regular.woff2 type=font/woff2 crossorigin><link rel=preload as=font href=https://staging.doc.kerberos.live/fonts/vendor/jost/jost-v4-latin-700.woff2 type=font/woff2 crossorigin><link rel=stylesheet href=https://staging.doc.kerberos.live/main.799ad8a214a46edc7d96cb6b86537ea1d93bd8f2be7514a9051856a4d4ac688f84831f58319654203c49b5b5a31bd5b7642232877a7a61195ada8e13b4b607cf.css integrity="sha512-eZrYohSkbtx9lstrhlN+odk72PK+dRSpBRhWpNSsaI+Egx9YMZZUIDxJtbWjG9W3ZCIyh3p6YRla2o4TtLYHzw==" crossorigin=anonymous><noscript><style>img.lazyload{display:none}</style></noscript><meta name=robots content="index, follow"><meta name=googlebot content="index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1"><meta name=bingbot content="index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1"><title>Get started - Kerberos.io</title><meta name=description content="Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default."><link rel=canonical href=https://staging.doc.kerberos.live/opensource/get-started/><meta name=twitter:card content="summary_large_image"><meta name=twitter:image content="/doks.png"><meta name=twitter:title content="Get started"><meta name=twitter:description content="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.
Login page When you&rsquo;ve finished the welcome page, you will be redirected to the login page from now one."><meta name=twitter:site content="@henkverlinde"><meta name=twitter:creator content="@henkverlinde"><meta property="og:title" content="Get started"><meta property="og:description" content="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.
Login page When you&rsquo;ve finished the welcome page, you will be redirected to the login page from now one."><meta property="og:type" content="article"><meta property="og:url" content="/opensource/get-started/"><meta property="og:image" content="/doks.png"><meta property="article:published_time" content="2020-10-06T08:49:31+00:00"><meta property="article:modified_time" content="2020-10-06T08:49:31+00:00"><meta property="og:site_name" content="Kerberos.io"><meta property="article:publisher" content="https://www.facebook.com/verlinde.henk"><meta property="article:author" content="https://www.facebook.com/verlinde.henk"><meta property="og:locale" content="en_US"><script type=application/ld+json>{"@context":"http://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/staging.doc.kerberos.live\/"},{"@type":"ListItem","position":3,"name":"Opensource","item":"https:\/\/staging.doc.kerberos.live\/\/opensource\/"},{"@type":"ListItem","position":4,"name":"Get Started","item":"https:\/\/staging.doc.kerberos.live\/\/opensource\/get-started\/"}]}</script><meta name=theme-color content="#fff"><link rel=apple-touch-icon sizes=180x180 href=https://staging.doc.kerberos.live/apple-touch-icon.png><link rel=icon type=image/png sizes=32x32 href=https://staging.doc.kerberos.live/favicon-32x32.png><link rel=icon type=image/png sizes=16x16 href=https://staging.doc.kerberos.live/favicon-16x16.png><link rel=manifest href=https://staging.doc.kerberos.live/site.webmanifest></head><body class="opensource single"><div class="header-bar fixed-top"></div><header class="navbar fixed-top navbar-expand-md navbar-light"><div class=container><input class="menu-btn order-0" type=checkbox id=menu-btn>
<label class="menu-icon d-md-none" for=menu-btn><span class=navicon></span></label><a class="navbar-brand order-1 order-md-0 me-auto" href=https://staging.doc.kerberos.live/>Kerberos.io</a>
<button id=mode class="btn btn-link order-2 order-md-4" type=button aria-label="Toggle mode">
<span class=toggle-dark><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-moon"><path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"/></svg></span><span class=toggle-light><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-sun"><circle cx="12" cy="12" r="5"/><line x1="12" y1="1" x2="12" y2="3"/><line x1="12" y1="21" x2="12" y2="23"/><line x1="4.22" y1="4.22" x2="5.64" y2="5.64"/><line x1="18.36" y1="18.36" x2="19.78" y2="19.78"/><line x1="1" y1="12" x2="3" y2="12"/><line x1="21" y1="12" x2="23" y2="12"/><line x1="4.22" y1="19.78" x2="5.64" y2="18.36"/><line x1="18.36" y1="5.64" x2="19.78" y2="4.22"/></svg></span></button><ul class="navbar-nav social-nav order-3 order-md-5"><li class=nav-item><a class=nav-link href=https://twitter.com/getdoks><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-twitter"><path d="M23 3a10.9 10.9.0 01-3.14 1.53 4.48 4.48.0 00-7.86 3v1A10.66 10.66.0 013 4s-4 9 5 13a11.64 11.64.0 01-7 2c9 5 20 0 20-11.5a4.5 4.5.0 00-.08-.83A7.72 7.72.0 0023 3z"/></svg><span class="ms-2 visually-hidden">Twitter</span></a></li><li class=nav-item><a class=nav-link href=https://github.com/h-enk/doks><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-github"><path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37.0 00-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44.0 0020 4.77 5.07 5.07.0 0019.91 1S18.73.65 16 2.48a13.38 13.38.0 00-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07.0 005 4.77 5.44 5.44.0 003.5 8.55c0 5.42 3.3 6.61 6.44 7A3.37 3.37.0 009 18.13V22"/></svg><span class="ms-2 visually-hidden">GitHub</span></a></li></ul><div class="collapse navbar-collapse order-4 order-md-1"><ul class="navbar-nav main-nav me-auto order-5 order-md-2"><li class=nav-item><a class=nav-link href=https://staging.kerberos.live>Products</a></li><li class=nav-item><a class=nav-link href=https://staging.kerberos.live>Blog</a></li><li class=nav-item><a class=nav-link href=https://staging.doc.kerberos.live/prologue/introduction/>Docs & Guides</a></li><li class=nav-item><a class=nav-link href=https://staging.kerberos.live>About & Contact</a></li></ul><div class="break order-6 d-md-none"></div><form class="navbar-form flex-grow-1 order-7 order-md-3"><input id=userinput class="form-control is-search" type=search placeholder="Search docs..." aria-label="Search docs..." autocomplete=off><div id=suggestions class="shadow bg-white rounded"></div></form></div></div></header><div class="wrap container" role=document><div class=content><div class="row flex-xl-nowrap"><div class="col-lg-5 col-xl-4 docs-sidebar"><nav class=docs-links aria-label="Main navigation"><h3>Prologue</h3><ul class=list-unstyled><li><a class=docs-link href=https://staging.doc.kerberos.live/prologue/introduction/>Introduction</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/prologue/quick-start/>Quick Start</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/prologue/how/>How it works</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/prologue/deployments/>Deployments</a></li></ul><h3>Opensource v2</h3><ul class=list-unstyled><li><a class=docs-link href=https://staging.doc.kerberos.live/opensource/first-things-first/>First things first</a></li><li><a class="docs-link active" href=https://staging.doc.kerberos.live/opensource/get-started/>Get started</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/opensource/installation/>Installation</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/opensource/installation-advanced/>Advanced Installation</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/opensource/releases/>Release notes</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/opensource/license/>License</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/opensource/upgrade/>Upgrade</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/opensource/contribute/>Contribute</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/opensource/machinery/>Machinery</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/opensource/web/>Web</a></li></ul><h3>Opensource v3</h3><ul class=list-unstyled><li><a class=docs-link href=https://staging.doc.kerberos.live/opensourcev3/announcement/>Announcement</a></li></ul><h3>Enterprise</h3><ul class=list-unstyled><li><a class=docs-link href=https://staging.doc.kerberos.live/enterprise/first-things-first/>First things first2</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/enterprise/get-started/>Get Started2</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/enterprise/installation/>Installation2</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/enterprise/installation-cloud/>Cloud Installation</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/enterprise/installation-edge/>Edge Installation</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/enterprise/releases/>Releases2</a></li></ul><h3>Vault</h3><ul class=list-unstyled><li><a class=docs-link href=https://staging.doc.kerberos.live/vault/first-things-first/>First things first3</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/vault/get-started/>Get Started3</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/vault/installation/>Installation3</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/vault/installation-cloud/>Cloud Installation3</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/vault/installation-edge/>Edge Installation3</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/vault/providers/>Providers</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/vault/recycle/>Recycle</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/vault/releases/>Releases3</a></li></ul><h3>Hub</h3><ul class=list-unstyled><li><a class=docs-link href=https://staging.doc.kerberos.live/hub/first-things-first/>First things first4</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/hub/get-started/>Get Started4</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/hub/installation/>Installation4</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/hub/releases/>Releases4</a></li></ul><h3>help</h3><ul class=list-unstyled><li><a class=docs-link href=https://staging.doc.kerberos.live/help/how-to-update/>How to Update</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/help/troubleshooting/>Troubleshooting</a></li><li><a class=docs-link href=https://staging.doc.kerberos.live/help/faq/>FAQ</a></li></ul></nav></div><nav class="docs-toc d-none d-xl-block col-xl-3" aria-label="Secondary navigation"><div class=page-links><h3>On this page</h3><nav id=TableOfContents><ul><li><a href=#welcome-page>Welcome page</a></li><li><a href=#login-page>Login page</a></li><li><a href=#dashboard>Dashboard</a></li><li><a href=#media>Media</a></li><li><a href=#settings>Settings</a><ul><li><a href=#region-of-interest>Region of interest</a></li><li><a href=#storage>Storage</a></li></ul></li><li><a href=#system>System</a></li></ul></nav></div></nav><main class="docs-content col-lg-11 col-xl-9"><h1>Get started</h1><p class=lead></p><p>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.</p><h2 id=welcome-page>Welcome page<a href=#welcome-page class=anchor aria-hidden=true>#</a></h2><p>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.</p><p><img src=../../public/images/opensource/kerberos-opensource-welcome.png alt=OpenSource></p><h2 id=login-page>Login page<a href=#login-page class=anchor aria-hidden=true>#</a></h2><p>When you&rsquo;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 <strong>root</strong>, and the password is <strong>root</strong>.</p><p><img src=../../public/images/opensource/kerberos-opensource-login.png alt=OpenSource></p><h2 id=dashboard>Dashboard<a href=#dashboard class=anchor aria-hidden=true>#</a></h2><p>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.</p><p><img src=../../public/images/opensource/kerberos-opensource-dashboard.png alt=OpenSource></p><h2 id=media>Media<a href=#media class=anchor aria-hidden=true>#</a></h2><p>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.</p><p>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.</p><p><img src=../../public/images/opensource/kerberos-opensource-media.png alt=OpenSource></p><p><img src=../../public/images/opensource/kerberos-opensource-media-detail.png alt=OpenSource></p><h2 id=settings>Settings<a href=#settings class=anchor aria-hidden=true>#</a></h2><p>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.</p><p><img src=../../public/images/opensource/kerberos-opensource-settings.png alt=OpenSource></p><h3 id=region-of-interest>Region of interest<a href=#region-of-interest class=anchor aria-hidden=true>#</a></h3><p>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).</p><p><img src=../../public/images/opensource/kerberos-opensource-motion.png alt=OpenSource></p><h3 id=storage>Storage<a href=#storage class=anchor aria-hidden=true>#</a></h3><p>Storing your recordings on your device is fine, on the other hand you might want to make it available remotely. By giving your <a href=https://staging.doc.kerberos.live/cloud>Kerberos Cloud</a> credentials in the storage section, your recordings will be synced to our cloud solution.</p><p><img src=../../public/images/opensource/kerberos-opensource-cloud.png alt=OpenSource></p><h2 id=system>System<a href=#system class=anchor aria-hidden=true>#</a></h2><p>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.</p><p><img src=../../public/images/opensource/kerberos-opensource-system.png alt=OpenSource></p><p class=edit-page><a href=https://github.com/kerberos-io/documentation/blob/master/content/opensource/get-started.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class="docs-navigation d-flex justify-content-between"><a href=https://staging.doc.kerberos.live/opensource/first-things-first/><div class="card my-1"><div class="card-body py-2">&larr; First things first</div></div></a><a class=ms-auto href=https://staging.doc.kerberos.live/opensource/installation/><div class="card my-1"><div class="card-body py-2">Installation &rarr;</div></div></a></div></main></div></div></div><script src=https://staging.doc.kerberos.live/js/highlight.min.8cdbefd08ec63ef25f4b2510ae50c13b3d9ed43e25a15ddb55f14c33130e68cf8be3131ccf2d087c49f5f21fe88c2f0e2715a21f936047d0d0b85dc48cb864b9.js integrity="sha512-jNvv0I7GPvJfSyUQrlDBOz2e1D4loV3bVfFMMxMOaM+L4xMczy0IfEn18h/ojC8OJxWiH5NgR9DQuF3EjLhkuQ==" crossorigin=anonymous defer></script><script src=https://staging.doc.kerberos.live/main.min.89223fc6eee34e2dc10266cff3c7fc87949c595388f775ec6e93132410cef77e5ff7f24a81db03c9b9eb6d2e6d75ea5a7d22945c574b65dfeb426f65af771230.js integrity="sha512-iSI/xu7jTi3BAmbP88f8h5ScWVOI93XsbpMTJBDO935f9/JKgdsDybnrbS5tdepafSKUXFdLZd/rQm9lr3cSMA==" crossorigin=anonymous defer></script><script src=https://staging.doc.kerberos.live/index.min.480488c17c876cc5485b2874fb16ec336811c75700b9897acfac80cbb4e677ee315f4295e018ea4c419f3031b7dfc6171a5269ae25d1cdd4ab3847f033affd61.js integrity="sha512-SASIwXyHbMVIWyh0+xbsM2gRx1cAuYl6z6yAy7Tmd+4xX0KV4BjqTEGfMDG338YXGlJpriXRzdSrOEfwM6/9YQ==" crossorigin=anonymous defer></script></body></html>