From af060a5dd9c5261f7bacad24201d532e55b4c809 Mon Sep 17 00:00:00 2001 From: Johann Frei Date: Wed, 21 Apr 2021 21:15:02 +0200 Subject: [PATCH] Update offline deployment README --- offline_deployment/README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/offline_deployment/README.md b/offline_deployment/README.md index 16521b78..b1168575 100644 --- a/offline_deployment/README.md +++ b/offline_deployment/README.md @@ -1,7 +1,7 @@ # Doccano Offline Deployment ## Use Case -These offline deployment scripts are suited for deploying Doccano on an air gapped Ubuntu 18.04/20.04 virtual machine (VM 2) with no internet connectivity. +These offline deployment scripts are suited for deploying Doccano on an air gapped Ubuntu 18.04/20.04 virtual machine (VM 2) with no internet connectivity (such as in clinical environments). The preparation requires another machine (VM 1) with internet access and `docker`/`docker-compose` preinstalled (with $USER in `docker` group) and running the same Ubuntu distribution as VM 2. @@ -12,12 +12,17 @@ The focus is primarily on the `docker-compose`-based production deployment. Run the following steps on VM 1: 1. Clone this repository 2. Run the scripts `offline_01_*.sh` in ascending order - Skip OR modify and run the script `offline_01_1_2-optional_use_https` + Skip OR modify and run the script `offline_01_1-optional_use_https` + Do NOT run these scripts as `sudo`! The scripts will ask for sudo-permissions when it is needed. Now, move over to VM 2 3. Copy the repository folder from VM 1 to VM 2 4. Run the scripts `offline_02_*.sh` in ascending order + Do NOT run these scripts as `sudo`! The scripts will ask for sudo-permissions when it is needed. 5. Make minor changes on `docker-compose.prod.yml` to change the admin credentials 6. Run `docker-compose -f docker-compose.prod.yml up` or use the script `offline_03_*.sh` +## Remarks + +The setup was tested on Ubuntu 18.04 machines. \ No newline at end of file