Skip to content

Commit

Permalink
add technology diagrams and more descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
metakermit committed Dec 25, 2015
1 parent d4557c5 commit b9ac13e
Show file tree
Hide file tree
Showing 5 changed files with 39 additions and 8 deletions.
Binary file added doc/technology/img/architecture.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/technology/img/pagekite.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/technology/img/startup.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
45 changes: 39 additions & 6 deletions doc/technology/technology.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,38 @@
# Technology

*In this document we give a high level technical overview of CloudFleet.*
In this document we give a high level technical overview of CloudFleet. Using
CloudFleet consists of three main components:

- the Blimp hardware - a physical machine used as your Blimp
- the Blimp software - the open source software running on your Blimp
- CloudFleet services - a set of online services we provide to make the setup
and usage of your Blimp easy and safe

You can get a pre-packaged CloudFleet Blimp from us or you can install the Blimp
on your own hardware or VM.

## Hardware

Raspberry Pi 2 Model B. Specification:
Hardware changes fast, so it's possible that these specs might change soon,
but this is the current hardware overview.
The main hardware platform supported for our Blimp is a Raspberry Pi 2 Model B.
The machine's specification is:

- 900MHz quad-core ARM Cortex-A7 CPU
- 1GB RAM

Additional components
Additional components that we package with the Blimp are:

- Custom case with CloudFleet branding
- 8 GB boot Micro SD card
- 16 GB storage USB
- Encryption USB key
- Ethernet & power cables

We also test our software on Debian amd64 VMs, we have some Solidrun Cuboxes
that mostly work and we are open to patches if
you would like to add support for some other hardware platforms.

## Software

### Openness
Expand All @@ -27,11 +43,27 @@ Explain the open source part, the license, transparency.

Explain the general architecture with Docker containers for automatic upgrades.

![architecture diagram](img/architecture.png)

### Startup Workflow

Explain the first startup workflow and that the private encryption key gets
generated only when the user first boots their Blimp

![](img/startup.png)

### Access

#### Domain

#### Pagekite

No port forwarding setup necessary! We want CloudFleet to be a plug-and-play
experience. To make this work we partnered with the developers of
[Pagekite](pagekite.net).

![](img/pagekite.png)

### Security Overview

#### HTTPS Connection
Expand Down Expand Up @@ -65,6 +97,7 @@ optional.

- explain the CloudFleet services on a high level and why we charge for them

- domain
- pagekite
- 0-knowledge backups
- domain registration
- software upgrades & security patches
- pagekite for global access
- zero-knowledge backups
2 changes: 0 additions & 2 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,3 @@ Documentation:
:maxdepth: 2

doc/technology/technology.md
.. Optional purely-security-related information
.. doc/security/security.md

0 comments on commit b9ac13e

Please sign in to comment.