diff --git a/breccia_mapper/settings.py b/breccia_mapper/settings.py index 7ea3b92..3a3d8fe 100644 --- a/breccia_mapper/settings.py +++ b/breccia_mapper/settings.py @@ -355,10 +355,10 @@ CONSTANCE_CONFIG = { '', 'Parent project name'), 'PROJECT_LONG_NAME': ( - 'Project Relationship Mapper', + 'Project Network Mapper', 'Project long name'), 'PROJECT_SHORT_NAME': ( - 'Relationship Mapper', + 'Network Mapper', 'Project short name'), 'PROJECT_LEAD': ( 'Project Lead', diff --git a/deploy/playbook.yml b/deploy/playbook.yml index af2ba8b..b34a7c4 100644 --- a/deploy/playbook.yml +++ b/deploy/playbook.yml @@ -11,7 +11,7 @@ register: vagrant_dir vars: - project_name: relationship-mapper + project_name: network-mapper project_dir: /srv/{{ project_name }} project_src_dir: "{{ project_dir }}/src" provision_superuser: false @@ -46,7 +46,7 @@ - name: Clone / update from source repos ansible.builtin.git: # repo: 'https://github.com/Southampton-RSG/breccia-mapper.git' - repo: 'https://github.com/mgrove36/breccia-relationship-mapper.git' + repo: 'https://github.com/mgrove36/breccia-network-mapper.git' dest: '{{ project_src_dir }}' version: dev # master accept_hostkey: yes @@ -105,5 +105,5 @@ - name: Display warning about new superuser debug: msg: - - "[WARNING] A superuser has been provisioned with the username \"{{ superuser_username }}\" and password that was provided. This user has unlimited access to the relationship mapper." + - "[WARNING] A superuser has been provisioned with the username \"{{ superuser_username }}\" and password that was provided. This user has unlimited access to the network mapper." when: provision_superuser \ No newline at end of file diff --git a/deploy/templates/docker-compose.yml.j2 b/deploy/templates/docker-compose.yml.j2 index eaaabdc..c491585 100755 --- a/deploy/templates/docker-compose.yml.j2 +++ b/deploy/templates/docker-compose.yml.j2 @@ -2,8 +2,8 @@ version: '3.1' services: server: - image: breccia-relationship-mapper - container_name: relationship-mapper-server + image: breccia-network-mapper + container_name: network-mapper-server build: {{ project_src_dir }} ports: - 8000:8000 @@ -18,7 +18,7 @@ services: caddy: image: caddy:2 - container_name: relationship-mapper-caddy + container_name: network-mapper-caddy restart: unless-stopped ports: - 80:80 diff --git a/docker-compose.yml b/docker-compose.yml index f03ac58..9ff863e 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -2,8 +2,8 @@ version: '3.1' services: server: - image: breccia-relationship-mapper - container_name: relationship-mapper-server + image: breccia-network-mapper + container_name: network-mapper-server build: . ports: - 8000:8000 @@ -18,7 +18,7 @@ services: caddy: image: caddy:2 - container_name: relationship-mapper-caddy + container_name: network-mapper-caddy restart: unless-stopped ports: - 80:80 diff --git a/docs/source/conf.py b/docs/source/conf.py index baa12dc..b453e64 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -6,7 +6,7 @@ # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -project = 'BRECcIA Relationship Mapper' +project = 'BRECcIA Network Mapper' copyright = 'Matthew Grove, University of Southampton' author = 'Matthew Grove' release = '1.1' diff --git a/docs/source/deployment.md b/docs/source/deployment.md index b90586f..8534916 100644 --- a/docs/source/deployment.md +++ b/docs/source/deployment.md @@ -1,6 +1,6 @@ # Deployment -The BRECcIA Relationship 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. ## Development Deployment @@ -25,7 +25,7 @@ And then start the virtual machine using: vagrant up ``` -If you would like a new superuser to be provisioned when deploying the relationship mapper, change the following line in `playbook.yml`: +If you would like a new superuser to be provisioned when deploying the network mapper, change the following line in `playbook.yml`: ```yaml provision_superuser: false @@ -39,13 +39,13 @@ provision_superuser: true And change the `superuser_*` options below it as desired. -Then provision the virtual machine (deploying the relationship mapper) using: +Then provision the virtual machine (deploying the network mapper) using: ```bash vagrant provision ``` -This installs the relationship mapper and makes it available on the local machine at `http://localhost:8080`. +This installs the network mapper and makes it available on the local machine at `http://localhost:8080`. If you wish to make this accessible from other devices on your local network, replace the following line in `deploy/Vagrantfile`: ```ruby @@ -78,7 +78,7 @@ Prerequisites: Deployment with Ansible has been tested on RHEL7 and RHEL8, but is compatible with other Linux distributions with minor changes to the playbook (`deploy/playbook.yml`) ::: -To deploy the BRECcIA Relationship Mapper with Ansible: +To deploy the BRECcIA Network Mapper with Ansible: 1. Copy `settings.example.ini` to `settings.ini` 2. Edit this file as desired. Note there is no requirement to change any of these variables, but it is recommended. @@ -86,7 +86,7 @@ To deploy the BRECcIA Relationship Mapper with Ansible: 4. Edit this file to reflect your Ansible setup: - Use your server's hostname instead of `example.com` - Replace the secret key with some text known only to you -5. If you would like a new superuser to be provisioned for the relationship mapper (e.g. during initial install), edit the following line of `playbook.yml`: +5. If you would like a new superuser to be provisioned for the network mapper (e.g. during initial install), edit the following line of `playbook.yml`: ```yaml provision_superuser: false @@ -119,7 +119,7 @@ Prerequisites: Deployment with Docker has been tested on RHEL7, RHEL8, and Ubuntu 22.04 LTS ::: -To deploy the BRECcIA Relationship Mapper with Docker: +To deploy the BRECcIA Network Mapper with Docker: 1. Copy `deploy/settings.example.ini` to `breccia_mapper/settings.ini` 2. Edit this file as desired. Note there is no requirement to change any of these variables, but it is recommended. diff --git a/docs/source/index.md b/docs/source/index.md index e5ca773..2b4523f 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -1,6 +1,6 @@ -# BRECcIA Relationship Mapper documentation +# BRECcIA Network Mapper documentation -The BRECcIA Relationship Mapper is a web app designed to track and quantify the the relationships between personnel - primarily developed for use in research projects. It is designed for global use across many different organisations involved in a single project, and has been utilised as part of [BRECcIA](https://gcrf-breccia.com) itself. +The BRECcIA Network Mapper is a web app designed to track and quantify personnel networks & relationships - primarily developed for use in research projects. It is designed for global use across many different organisations involved in a single project, and has been utilised as part of [BRECcIA](https://gcrf-breccia.com) itself. This work was funded through the "Building REsearch Capacity for sustainable water and food security In drylands of sub-saharan Africa" (BRECcIA) project which is supported by UK Research and Innovation as part of the Global Challenges Research Fund, grant number NE/P021093/1.