documentation/hub/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.66b8eed6c9f69ef6d95494a2beaeffec5a82aed3d13d73d78f0277a85237bdd8e053756075755103fc2465950ff036dc2dd9c3e66fdc7890d608884fef1b8615.css integrity="sha512-Zrju1sn2nvbZVJSivq7/7FqCrtPRPXPXjwJ3qFI3vdjgU3VgdXVRA/wkZZUP8DbcLdnD5m/ceJDWCIhP7xuGFQ==" 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 Started4 - 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/hub/get-started/><meta name=twitter:card content="summary_large_image"><meta name=twitter:image content="/doks.png"><meta name=twitter:title content="Get Started4"><meta name=twitter:description content="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."><meta name=twitter:site content="@henkverlinde"><meta name=twitter:creator content="@henkverlinde"><meta property="og:title" content="Get Started4"><meta property="og:description" content="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."><meta property="og:type" content="article"><meta property="og:url" content="/hub/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":"Hub","item":"https:\/\/staging.doc.kerberos.live\/\/hub\/"},{"@type":"ListItem","position":4,"name":"Get Started","item":"https:\/\/staging.doc.kerberos.live\/\/hub\/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="hub 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 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>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><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 active" 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>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></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=#what-is-changing>What is changing?</a></li><li><a href=#faq>FAQ</a><ul><li><a href=#1-why-a-mono-repo>1. Why a mono repo?</a></li><li><a href=#2-why-a-change-in-technologies>2. Why a change in technologies?</a></li><li><a href=#3-what-is-the-difference-with-kerberos-enterprise>3. What is the difference with Kerberos Enterprise?</a></li><li><a href=#4-when-are-we-going-to-be-able-to-install-the-first-version>4. When are we going to be able to install the first version?</a></li><li><a href=#5-change-in-license>5. Change in License</a></li></ul></li></ul></nav></div></nav><main class="docs-content col-lg-11 col-xl-9"><h1>Get Started4</h1><p class=lead></p><p>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 <a href=https://github.com/kerberos-io/machinery>machinery</a> and <a href=https://github.com/kerberos-io/web>web</a> 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 <a href=https://github.com/kerberos-io/opensource/tree/develop>develop branch</a> and <a href=https://github.com/kerberos-io/opensource/projects/1>project overview</a>.</p><h2 id=what-is-changing>What is changing?<a href=#what-is-changing class=anchor aria-hidden=true>#</a></h2><p>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.</p><p><img src=../public/images/kerberos-agent-v2-v3.png alt="Kerberos Open Source v2 - vs - v3"></p><h2 id=faq>FAQ<a href=#faq class=anchor aria-hidden=true>#</a></h2><h3 id=1-why-a-mono-repo>1. Why a mono repo?<a href=#1-why-a-mono-repo class=anchor aria-hidden=true>#</a></h3><p>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&rsquo;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.</p><p>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.</p><h3 id=2-why-a-change-in-technologies>2. Why a change in technologies?<a href=#2-why-a-change-in-technologies class=anchor aria-hidden=true>#</a></h3><p>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.</p><p>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.</p><h3 id=3-what-is-the-difference-with-kerberos-enterprise>3. What is the difference with Kerberos Enterprise?<a href=#3-what-is-the-difference-with-kerberos-enterprise class=anchor aria-hidden=true>#</a></h3><p>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.</p><p>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.</p><h3 id=4-when-are-we-going-to-be-able-to-install-the-first-version>4. When are we going to be able to install the first version?<a href=#4-when-are-we-going-to-be-able-to-install-the-first-version class=anchor aria-hidden=true>#</a></h3><p>We plan to ship the <strong>first version by the end of Q1</strong>, afterwards we will add more and more features as usual.</p><h3 id=5-change-in-license>5. Change in License<a href=#5-change-in-license class=anchor aria-hidden=true>#</a></h3><p>Kerberos Open Source (v3) is now available under the MIT license.</p><p class=edit-page><a href=https://github.com/kerberos-io/documentation/blob/master/content/hub/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/hub/first-things-first/><div class="card my-1"><div class="card-body py-2">&larr; First things first4</div></div></a><a class=ms-auto href=https://staging.doc.kerberos.live/hub/installation/><div class="card my-1"><div class="card-body py-2">Installation4 &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.54e29cb9feadd3a6ad979851533d6f746fb778ac1313ca52b5a92d29043c4fbce8a241c4352a3f2f2cd7fa49bb84196b3b93fe373befc0ed4edb17ca1bdc9909.js integrity="sha512-VOKcuf6t06atl5hRUz1vdG+3eKwTE8pStaktKQQ8T7zookHENSo/LyzX+km7hBlrO5P+NzvvwO1O2xfKG9yZCQ==" crossorigin=anonymous defer></script></body></html>