diff --git a/README.md b/README.md index 525f489..b06907b 100644 --- a/README.md +++ b/README.md @@ -6,15 +6,24 @@ This repo has been developed by the DevOps Lan&Wi-Fi to automate site creation o Run the following: -1. ```mkdir ~/mist_working_directory && ~/mist_working_directory/data_src && cd ~/mist_working_directory``` +1. Copy this in your terminal and paste to create the working directory. + +``` +mkdir -p ~/mist_working_directory/data_src && cd ~/mist_working_directory +``` -2. ```wget -O .env https://github.com/ministryofjustice/juniper-mist-integration/blob/main/example.env``` +2. Copy this in your terminal and paste + +``` +wget -O .env https://raw.githubusercontent.com/ministryofjustice/main/scope-creep-copy-button/example.env +``` 3. Configure .env file: You must either provide MIST_USERNAME and MIST_PASSWORD or MIST_API_TOKEN. If you opt for username and password MFA will be requested during runtime. All other inputs are mandatory: ORG_ID, SITE_GROUP_IDS , RF_TEMPLATE_ID + 4. Create a csv file named: `sites_with_clients.csv` within '~/mist_working_directory/data_src' Below is an [example](./example.sites_with_clients.csv) of how the CSV should be formatted. @@ -25,7 +34,17 @@ Test location 2,"102 Petty France, London SW1H 9AJ", FALSE, TRUE, 00000DD0000BC0 Test location 3,"Met Office, FitzRoy Road, Exeter, Devon, EX1 3PB", FALSE, FALSE, 00000DD0000BC0EEE000, 00000DD0000BC0EEE000 ``` -5. `docker run -it -v $(pwd)/data_src:/data_src --env-file .env docker pull ghcr.io/ministryofjustice/nvvs/juniper-mist-integration/app:latest` +or copy the example CSV with the following command to the data directory: + +``` +wget -O data_src/sites_with_clients.csv https://raw.githubusercontent.com/ministryofjustice/juniper-mist-integration/main/example.sites_with_clients.csv +``` + +5. Copy this in your terminal and paste to download and run the Dockerized tooling: + +``` +docker run -it -v $(pwd)/data_src:/data_src --env-file .env ghcr.io/ministryofjustice/nvvs/juniper-mist-integration/app:latest +``` ## Development setup