Skip to content

Latest commit

 

History

History
177 lines (108 loc) · 4.92 KB

README.md

File metadata and controls

177 lines (108 loc) · 4.92 KB
Raw

Installing MIMO with Docker

This will install the MIMO Community Edition on a single host. It will setup the following components:

  • MIMO API
  • MIMO Dashboard
  • MIMO Splash Pages

It will also generate SSL certificates using Let's Encrypt.

Requirements

  • FQDN - a domain name - MIMO needs a fully qualified domain, like wisp.services
  • Linux server - see requirements below
  • Working DNS

Hardware Requirements

  • Singal or dual core CPU (dual core recommended)
  • 2 GB RAM minimum (with swap) 4Gb is preferred!
  • 64 bit Linux compatible with Docker
  • 10 GB disk space minimum

Create a new server

Instructions for each provider to follow...

We recommend Digital Ocean but you can use whoever you want. You can use this link to get $10 off your first server ;)

Domain Name

MIMO will NOT work without a domain name - you cannot use MIMO with an IP.

If you don't have a domain name, there's a gazillion places online for you to get one from. We recommend Namecheap. They're cheap & reliable.

If you do have a domain name, all you need to do is add the records below to your DNS.

DNS records

Find the public IP address for your newly created server. This needs to be the publicly available IP address.

Add the following A-records to your DNS records:

  • api
  • admin
  • dashboard
  • splash

Before you start the installation (after you created a server), you must update your DNS. For example, if your public IP address is 1.2.3.4 and your chosen domain is wisp.services you need the following records:

api.wisp.services - 1.2.3.4
admin.wisp.services - 1.2.3.4
dashboard.wisp.services - 1.2.3.4
splash.wisp.services - 1.2.3.4

Make sure these resolve before you start the installation.

We recommend using Cloudflare for your DNS however it's up to you who you chose. If you're using Cloudflare, you will need to disable their firewall before the installation. You can reactivate this afterwards.

Firewall

Ports 80 and 443 must be allowed - update your firewall settings to ensure these are open and accessible.

Email Server

MIMO requires a functioning SMTP / Email server. You can use whoever you want but we recommend one of the following:

  • SendGrid
  • Mailgun
  • Elastic Email

Once you've created your account, save the credentials as you'll need them during the installation process.

We do not recommend using Gmail's SMTP server or your own one. The ones above are cheap and reliable.

Let's Encrypt

Your MIMO installation will be secured using Let's Encrypt certificates. During the installation process, you will need to enter an email address for the Let's Encrypt service. This must be a functioning email.

Install MIMO!

Follow the instructions below to get the MIMO Community Edition installed.

Login to your server

bla bla bla

Using your favourite shell, including putty or ssh, login to your newly created server:

ssh root@ip-address

If you're using Digital Ocean, you will need to update your password.

Install Docker and Git

Run the following to install Docker on your server.

wget -qO- https://get.docker.com/ | sh

This installs Docker & Git on your machine. You may need to install Git manually.

Check they were installed correctly. Git:

git version
git version 2.7.4

Docker:

docker --version
Docker version 18.05.0-ce, build f150324

The exact versions may differ.

If either failed, please re-install. The git installation guide can be found here:

https://git-scm.com/book/en/v2/Getting-Started-Installing-Git

Install MIMO

Make sure you have your domain. You will also need your email server credentials for this installation.

If you don't enter valid email credentials, your installation will fail!!

sudo -s
mkdir /var/mimo
git clone https://github.com/mimolabs/mimo-docker.git /var/mimo
cd /var/mimo
./docker-install.sh

You must enter valid SMTP credentials otherwise your MIMO installation won't work.

After the installation has completed, you should receive a welcome message.

The installation can take ages.

Finishing Up

The email that was sent includes a magic link that will allow you to complete the installation. If you did not get the email, please check your spam and ensure you set the correct SMTP credentials.

Troubleshooting

If you see any errors, you can re-run the installer with debug mode enabled:

DEBUG=1 ./docker-install.sh

This will run the instller in the foreground - you should be able to see any errors in the terminal.

Common Problems

You've run in the foreground and can see a message saying out of space, or similar.

This happens if you've got too many Docker images on your machine.

The simplest way is to remove all the MIMO images and re-build:

docker-compose down --rmi all
./docker-install.sh

License

See license file