Browse Source

Update offline deployment README

pull/1322/head
Johann Frei 3 years ago
parent
commit
af060a5dd9
1 changed files with 7 additions and 2 deletions
  1. 9
      offline_deployment/README.md

9
offline_deployment/README.md

@ -1,7 +1,7 @@
# Doccano Offline Deployment # Doccano Offline Deployment
## Use Case ## 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. 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: Run the following steps on VM 1:
1. Clone this repository 1. Clone this repository
2. Run the scripts `offline_01_*.sh` in ascending order 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 Now, move over to VM 2
3. Copy the repository folder from VM 1 to VM 2 3. Copy the repository folder from VM 1 to VM 2
4. Run the scripts `offline_02_*.sh` in ascending order 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 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` 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.
Loading…
Cancel
Save