me/breccia-mapper
1
0
Fork 0
mirror of https://github.com/Southampton-RSG/breccia-mapper.git synced 2026-03-03 11:27:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Add "choosing how to deploy" section

Browse Source 
Also tidy up formatting and remove old comments
This commit is contained in:
Matthew Grove
2023-02-10 16:00:21 +00:00
parent ced86f308b
commit ccea25133c
1 changed files with 23 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
docs/source/deployment.md
View File

@@ -1,9 +1,15 @@
# Deployment
The BRECcIA Network Mapper can be deployed in a variety of ways, most of which utilise Docker. The BRECcIA Network Mapper can be deployed in a variety of ways, most of which utilise Docker.
Ansible deployment has been tested on RHEL7 and RHEL8. Ansible deployment has been tested on RHEL7 and RHEL8.
## Choosing How to Deploy
# Ansible If you are an organisation deploying the app on a server, [Ansible](#ansible) is recommended. If Ansible is not used with your server, [Docker Compose](#docker-compose) or [][Vagrant](#vagrant) are recommended.
If you are an individual deploying the app on your local machine, [Docker Desktop](#docker-desktop) is recommended. However, if you are planning on making the app accessible to other people (outside your computer), we advise deploying the app on a server.
## Ansible
Prerequisites: Prerequisites:
@@ -15,22 +21,10 @@ Deployment with Ansible has been tested on RHEL7 and RHEL8, but is compatible wi
To deploy the BRECcIA Network Mapper with Ansible: To deploy the BRECcIA Network Mapper with Ansible:
<!-- -------------------------------------------------------
NOTES
pull deploy folder only
navigate to folder
copy icon to icon-192x192.png in folder
copy example.env to .env and edit
copy inventory.example.yml to inventory.yml and edit
edit playbook if superuser desired
run playbook
set provision_superuser to false if was changed
------------------------------------------------------- -->
1. Download and extract the deployment files from [the latest release](https://github.com/Southampton-RSG/breccia-mapper/releases/latest): 1. Download and extract the deployment files from [the latest release](https://github.com/Southampton-RSG/breccia-mapper/releases/latest):
```bash ```bash
curl https://github.com/Southampton-RSG/breccia-mapper/releases/latest/download/deploy-ansible.tar | tar xzv && cd deploy-ansible curl https://github.com/Southampton-RSG/breccia-mapper/releases/latest/download/deploy-ansible.tar | tar xzv && cd network-mapper
``` ```
2. Copy your logo (192x192 pixels) to `icon-192x192.png` in this folder. 2. Copy your logo (192x192 pixels) to `icon-192x192.png` in this folder.
@@ -49,9 +43,9 @@ set provision_superuser to false if was changed
``` ```
6. Edit this file to reflect your Ansible setup: 6. Edit this file to reflect your Ansible setup:
- Use your server's hostname instead of `example.com` - Use your server's hostname instead of `example.com`
7. If you would like a new superuser to be provisioned (e.g. during initial install), edit the `provision_superuser` variable in `playbook.yml` to `true`. 7. If you would like a new superuser to be provisioned (e.g. during initial install), edit the `provision_superuser` variable in `playbook.yml` to `true`.
- Then change the `superuser_*` options below it as desired. - Then change the `superuser_*` options below it as desired.
8. Run the Ansible playbook `playbook.yml` with this inventory file using: 8. Run the Ansible playbook `playbook.yml` with this inventory file using:
```bash ```bash
@@ -66,7 +60,7 @@ If you changed the `provision_superuser` variable in `playbook.yml` to `true`, r
::: :::
# Docker Compose ## Docker Compose
Prerequisites: Prerequisites:
@@ -76,23 +70,12 @@ Prerequisites:
Deployment with Docker has been tested on RHEL7, RHEL8, and Ubuntu 22.04 LTS Deployment with Docker has been tested on RHEL7, RHEL8, and Ubuntu 22.04 LTS
::: :::
<!-- -------------------------------------------------------
NOTES
create folder
pull docker compose file and example.env only
copy icon to icon-192x192.png in folder
copy example.env to .env and edit
touch db file? (is this needed?)
run docker compose up -d
create superuser if desired
------------------------------------------------------- -->
To deploy the BRECcIA Network Mapper with Docker: To deploy the BRECcIA Network Mapper with Docker:
1. Download and extract the deployment files from [the latest release](https://github.com/Southampton-RSG/breccia-mapper/releases/latest): 1. Download and extract the deployment files from [the latest release](https://github.com/Southampton-RSG/breccia-mapper/releases/latest):
```bash ```bash
curl https://github.com/mgrove36/Southampton-RSG/releases/latest/download/deploy-docker.tar | tar xzv && cd deploy-docker curl https://github.com/mgrove36/Southampton-RSG/releases/latest/download/deploy-docker.tar | tar xzv && cd network-mapper
``` ```
2. Copy your logo (192x192 pixels) to `icon-192x192.png` in this folder. 2. Copy your logo (192x192 pixels) to `icon-192x192.png` in this folder.
@@ -125,30 +108,19 @@ To deploy the BRECcIA Network Mapper with Docker:
If you don't create a superuser when you first deploy the app, you will be unable to log in. If you don't create a superuser when you first deploy the app, you will be unable to log in.
::: :::
# Vagrant ## Vagrant
Prerequisites: Prerequisites:
- [Vagrant](https://www.vagrantup.com/) - [Vagrant](https://www.vagrantup.com/)
- [Ansible](https://www.ansible.com/) - [Ansible](https://www.ansible.com/)
<!-- -------------------------------------------------------
NOTES
pull deploy folder only
navigate to folder
copy icon to icon-192x192.png in folder
copy example.env to .env and edit
edit playbook if superuser desired
run vagrant up and/or vagrant provision
set provision_superuser to false if was changed
------------------------------------------------------- -->
To deploy the BRECcIA Network Mapper with Vagrant: To deploy the BRECcIA Network Mapper with Vagrant:
1. Download and extract the deployment files from [the latest release](https://github.com/Southampton-RSG/breccia-mapper/releases/latest): 1. Download and extract the deployment files from [the latest release](https://github.com/Southampton-RSG/breccia-mapper/releases/latest):
```bash ```bash
curl https://github.com/mgrove36/Southampton-RSG/releases/latest/download/deploy-vagrant.tar | tar xzv && cd deploy-vagrant curl https://github.com/mgrove36/Southampton-RSG/releases/latest/download/deploy-vagrant.tar | tar xzv && cd network-mapper
``` ```
2. Copy your logo (192x192 pixels) to `icon-192x192.png` in this folder. 2. Copy your logo (192x192 pixels) to `icon-192x192.png` in this folder.
@@ -160,12 +132,12 @@ To deploy the BRECcIA Network Mapper with Vagrant:
4. Edit this file as desired. Note that some variables are required. 4. Edit this file as desired. Note that some variables are required.
5. If you would like a new superuser to be provisioned (e.g. during initial install), edit the `provision_superuser` variable in `playbook.yml` to `true`. 5. If you would like a new superuser to be provisioned (e.g. during initial install), edit the `provision_superuser` variable in `playbook.yml` to `true`.
- Then change the `superuser_*` options below it as desired. - Then change the `superuser_*` options below it as desired.
6. To change where the app is accessible from, edit the `config.vm.network` line in `Vagrantfile`. 6. To change where the app is accessible from, edit the `config.vm.network` line in `Vagrantfile`.
- By default, the app is accessible only from `http://localhost:8080`. - By default, the app is accessible only from `http://localhost:8080`.
- To make it available from any IP address, replace `host: 8080, host_ip: "127.0.0.1"` with `host: 8080`. - To make it available from any IP address, replace `host: 8080, host_ip: "127.0.0.1"` with `host: 8080`.
- To change the port the app is available on, edit `host: 8080`. - To change the port the app is available on, edit `host: 8080`.
- More details are available in the [Vagrant docs](https://developer.hashicorp.com/vagrant/docs/networking). - More details are available in the [Vagrant docs](https://developer.hashicorp.com/vagrant/docs/networking).
6. Start the virtual machine: 6. Start the virtual machine:
```bash ```bash
@@ -183,4 +155,7 @@ To deploy the BRECcIA Network Mapper with Vagrant:
To stop the virtual machine, run `vagrant halt` in this directory. More commands are explained in the [Vagrant docs](https://developer.hashicorp.com/vagrant/docs/cli). To stop the virtual machine, run `vagrant halt` in this directory. More commands are explained in the [Vagrant docs](https://developer.hashicorp.com/vagrant/docs/cli).
::: :::
<!-- # Build From Source --> ## Docker Desktop
Coming soon.