swarmlab-hybrid/README.md

<img align="right" width="300" height="300" src="https://git.swarmlab.io:3000/zeus/swarmlab-hybrid/raw/branch/master/docs/images/hybrid-1.png">

### Welcome to Swarmlab.io
  

**Swarmlab** is a powerful collaboration tool that connects tutors and students 

**in a unique all-in-one environment that gets work done fast and easily**
  
  

#### **Ready-to-Use Virtual Labs one click away.**
  
  
### Table of contents
  
1. [Features](#introduction)
2. [System requirements ](#paragraph1)
    1. [Sub paragraph](#subparagraph1)
3. [Installation](#paragraph2)
4. [More info](#paragraph2)

### Features <a name="introduction"></a>


**Share your exercises and content as a tutor and access it as student on demand**

> ##### On demand Labrooms
> 
> * Optimized for both Students and Tutors
> * Tutors bootstrap their labrooms using our tools
> * Students can join the created labrooms according to their interrests
> * Following the lead of a cloud based world, we use git for tutors to create, distribute and run their lessons.
>


### System requirements <a name="paragraph1"></a>
  
  
**Before** you create and configure a hybrid deployment using the swarmlab-agent client, your Local Machines need to meet certain requirements.
  

> If you don't meet those requirements, you won't be able to complete the steps within the swarmlab-agent client and you won't be able to configure a hybrid deployment between your Local Enviroment and Swarmlab Online Enviroment.
   

- A Linux Server (Virtual or Physical) 	
 - You must have super user privileges (sudo)
- Docker Engine- Community version 18 or later is required. 	
 -  Docker Engine is supported on x86_64 (or amd64), armhf, and arm64 architectures.
- RAM
 - Absolute minimum to run the daemon and some very light containers - 512MB
 - Minimum for “comfortable” usage – 2GB
- CPU
 - Minimum: 2
 - Recommended 4+
- Disk Space
 - 10 GB for internal requirements.
 - The amount of additional disk space required for load file staging, persistence, or backups depends on the size of the data to be loaded.

> Docker uses a hypervisor with a VM, and the host server must support virtualization. 




#### Prerequisites <a name="subparagraph1"></a>

### Installation <a name="paragraph2"></a>
  
<br />
<p align="center">
  <p align="center">
1. Register for a free online account
2. Clone the repo
   ```sh
   git clone https://git.swarmlab.io:3000/zeus/swarmlab-hybrid.git
   ```
3. Install it!
   ```sh
   cd swarmlab-hybrid

   ./install.sh
   ```
4. Open URL __http://localhost:3088__ in browser
5. Get a free API Key at  **Settings->Enable the Swarmlab hybrid** Menu




1. Get a free API Key at [https://example.com](https://example.com)
2. Clone the repo
   ```sh
   git clone https://git.swarmlab.io:3000/zeus/swarmlab-hybrid.git
   ```
3. Install it!
   ```sh
   cd swarmlab-hybrid
   ./install.sh
   ```
4. Enter your API in `config.js`
   ```JS
   const API_KEY = 'ENTER YOUR API';
   ```



  </p>
</p>


### More Info <a name="paragraph2"></a>

You can find our docs in *docs* Directory

The Swarmlab docs are in AsciiDoc (similar to markdown), PDF and html format

  
Asciidoc add-on can be found here:

http://docs.swarmlab.io/SwarmLab-HowTos/labs/Howtos/doclive/asciidoc.adoc.html#_setup_live_preview_using_a_web_browser