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

Merge pull request #126 from Southampton-RSG/dev

Browse Source 
Small fixes
This commit is contained in:
Matthew Grove
2023-03-25 15:42:57 +00:00
committed by GitHub
parent e7b57df077 74b6b3b27d
commit 50839f3240
2 changed files with 25 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
deploy/deploy-docker/Caddyfile Normal file
View File

@@ -0,0 +1,16 @@
:80 :443 {
root * /srv
file_server
@proxy_paths {
not path /static/*
not path /media/*
}
reverse_proxy @proxy_paths http://server:8000
log {
output stderr
format console
}
}

13
docs/source/1-deployment.md
View File

@@ -35,7 +35,7 @@ To deploy the BRECcIA Network Mapper with Ansible:
cp example.env .env cp example.env .env
``` ```
4. Edit this file as desired. Note that some variables are required. 4. Edit this file as desired. Note that some variables are required, and that `True` and `False` values must have correct capitalisation.
5. Copy `inventory.example.yml` to `inventory.yml`: 5. Copy `inventory.example.yml` to `inventory.yml`:
```bash ```bash
@@ -85,7 +85,7 @@ To deploy the BRECcIA Network Mapper with Docker:
cp example.env .env cp example.env .env
``` ```
4. Edit this file as desired. Note that some variables are required. 4. Edit this file as desired. Note that some variables are required, and that `True` and `False` values must have correct capitalisation.
5. Start the containers with the following command (you may need to use `sudo`): 5. Start the containers with the following command (you may need to use `sudo`):
```bash ```bash
@@ -124,7 +124,7 @@ To deploy the BRECcIA Network Mapper with Vagrant:
cp example.env .env cp example.env .env
``` ```
4. Edit this file as desired. Note that some variables are required. 4. Edit this file as desired. Note that some variables are required, and that `True` and `False` values must have correct capitalisation.
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`.
@@ -169,7 +169,7 @@ To deploy the BRECcIA Network Mapper with Docker Desktop:
2. Extract the zip file into an appropriate folder. 2. Extract the zip file into an appropriate folder.
3. Copy your logo (192x192 pixels) to `icon-192x192.png` in the `network-mapper` folder. 3. Copy your logo (192x192 pixels) to `icon-192x192.png` in the `network-mapper` folder.
4. Copy `example.env` to `.env` in this folder. 4. Copy `example.env` to `.env` in this folder.
5. Edit this file as desired. Note that some variables are required. 5. Edit this file as desired. Note that some variables are required, and that `True` and `False` values must have correct capitalisation.
- Variables are set with the following syntax, in this case setting the `DEBUG` variable to `False`: - Variables are set with the following syntax, in this case setting the `DEBUG` variable to `False`:
@@ -192,3 +192,8 @@ To deploy the BRECcIA Network Mapper with Docker Desktop:
Once the network mapper has been started for the first time with the above steps, it will appear in Docker Desktop (if installed). It can then be stopped/started again from here. Once the network mapper has been started for the first time with the above steps, it will appear in Docker Desktop (if installed). It can then be stopped/started again from here.
To stop it from the terminal, run
```bash
docker compose down
```