Add installation instructions, manual outline.

This commit is contained in:
Kaitlyn Parkhurst 2021-07-20 08:05:18 -07:00
parent dd8c61238b
commit 1bc282bf48
2 changed files with 42 additions and 4 deletions

View file

@ -27,7 +27,7 @@
state: present
- name: Add the ansible key.
ansible.builtin.apt_key:
apt_key:
keyserver: keyserver.ubuntu.com
id: 93C4A3FD7BB9C367

View file

@ -1,3 +1,38 @@
## Guide
### Installation
MeshMage can be fully installed and configured with Ansible. From a machine with Ansible and git installed, fork MeshMage and go into the Ansible directory.
```bash
git clone https://github.com/symkat/MeshMage.git
cd MeshMage/Ansible
```
MeshMage should be installed on a Debian 10 machine. You will need ssh access to `root@` on the target node for Ansible to access it. Replace the IP address `10.0.0.1` with the IP address of your Debian 10 machine; don't remove the comma inside the single-quotes.
```bash
ansible-playbook -i '10.0.0.1,' playbooks/install-meshmage.yml
```
The installation process usually takes about 30 minutes to run.
### Creating the first user account
### Creating a network
### Creating a node
### Creating an SSH key
### Setting up a Linux node
### Setting up a macOS node
### Setting up a Windows node
---
## Setting Up Development Environment
### Debian 10
@ -56,8 +91,7 @@ The previous 4 steps were all done as root. For this step, you'll need to login
```bash
cpanm App::plx App::opan App::Dex Carton Dist::Zilla
GIT_SSH_COMMAND="ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no" \
git clone git@github.com:symkat/MeshMage.git
git clone https://github.com/symkat/MeshMage.git
cd MeshMage/DB
dzil build
cd ../Web
@ -65,13 +99,17 @@ plx --init
plx --config libspec add 00tilde.ll $HOME/perl5
plx --config libspec add 40dblib.dir ../DB/lib
plx opan init
plx opan add ../DB/MeshMage-DB-0.001.tar.gz
plx opan add ../DB/MeshMage-DB-1.tar.gz
plx opan merge
plx opan carton install
```
Now you will want to copy Web/meshmage.yml.sample to Web/meshmage.yml and fill out the config file.
```bash
cp Web/meshmage.yml.sample Web/meshmage.yml
```
6. Run The App
You'll want to grab a second shell to start the DB. Make sure you're in the top level directory of MeshMage.