Skip to content

Commit

Permalink
add installation section
Browse files Browse the repository at this point in the history
  • Loading branch information
cjdcordeiro committed Mar 22, 2018
1 parent d35679c commit 98533b1
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 1 deletion.
3 changes: 2 additions & 1 deletion documentation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@ Welcome to the mF2C documentation!
:hidden:

introduction.rst
installation/index.rst
user_guide/index.rst
developer_guide/index.rst
developer_guide/index.rst
11 changes: 11 additions & 0 deletions documentation/installation/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Installation
============

This section demonstrates the steps required to install the mF2C
system in different types of devices and architectures.

.. toctree::
:maxdepth: 1
:hidden:

ubuntu
62 changes: 62 additions & 0 deletions documentation/installation/ubuntu.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
Ubuntu
======

Installing with Docker
----------------------

To install mF2C with Docker, you must ensure that your Ubuntu
machine is at least equipped with Docker and Docker Compose. As `sudo`:

1. prepare the environment (https://docs.docker.com/install/linux/docker-ce/ubuntu/#set-up-the-repository)

```bash
# remove previous installations
apt-get remove -y docker docker-engine docker-ce docker.io
apt-get update
apt-get install -y \
apt-transport-https \
ca-certificates \
curl \
software-properties-common
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
apt-key fingerprint 0EBFCD88
```

1a. for x86_64 / amd64:

```bash
add-apt-repository \
"deb [arch=amd64] https://download.docker.com/linux/ubuntu \
$(lsb_release -cs) \
stable"
```

1a. for armhf:

```bash
add-apt-repository \
"deb [arch=armhf] https://download.docker.com/linux/ubuntu \
$(lsb_release -cs) \
stable"
```

2. install Docker

```bash
apt-get update
apt-get install -y docker-ce
```

3. install Docker Compose (https://docs.docker.com/compose/install/#install-compose)

```bash
curl -L https://github.com/docker/compose/releases/download/1.20.0/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
chmod +x /usr/local/bin/docker-compose
```

0 comments on commit 98533b1

Please sign in to comment.