> For the complete documentation index, see [llms.txt](https://ciusji.gitbook.io/elixirnote/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ciusji.gitbook.io/elixirnote/guides/built-in-services/elixirnote-hub.md).

# ElixirNote Hub

## TOC

* [Introduction](#introduction)
* [Installation Guice](#installation-guice)
* [Getting Started](#getting-started)
* [Technical Reference](#technical-reference)
* [Administrators Guice](#administrators-guice)
* [API Reference](#api-reference)
* [RBAC Reference](#rbac-reference)
* [FAQ](#faq)

## Introduction

[ElixirHub](https://github.com/ElixirNote/elixirhub) is the best way to serve  [ElixirNote](https://github.com/ElixirNote/elixirnote) for multiple users. It can be used in a class of students, a corporate data science group, or a scientific research group. It is a multi-user **Hub** that spawns, manages, and proxies multiple instances of the single-user ElixirNote server.

To make life easier, ElixirHub has distributions. Be sure to take a look at them before continuing with the configuration of the broad original system of ElixirHub. Today, you can find two main cases:

1. If you need a simple case for a small number of users (0-100) and a single server takes a look at The Littlest ElixirNote distribution.
2. If you need to allow for even more users, a dynamic amount of servers can be used on a cloud, take a look at the Zero to ElixirHub with Kubernetes.

Four subsystems make up JupyterHub:

* a **Hub** (tornado process) that is the heart of ElixrHub
* a **configurable HTTP proxy** (node-http-proxy) that receives the requests from the client’s browser
* multiple **single-user ElixrNote servers** (Python/IPython/tornado) that are monitored by Spawners
* an **authentication class** that manages how users can access the system

## Installation Guice

## Getting Started

## Technical Reference

## Administrators Guice

## API Reference

## RBAC Reference

## FAQ