Skip to content

ncsa/ShieldPK12

Repository files navigation

SHIELD K-12 Playbook

mainScreen.png visit https://shield-k12-playbook.ncsa.illinois.edu


How to Run

For local development

  • runsh exec.sh

For deployment

Deploy with domain name and SSL

  1. ssh into your remote machine
  2. Make suer you already install git, cron, docker:
  3. git clone this repository git clone https://github.com/ncsa/ShieldPK12.git
  4. Initialize SSL certificate by run sh init-letsencrypt.sh, please change the domain name to ones that you own. Right now this domain is pointing towards shield-k12-playbook.ncsa.illinois.edu. Check init-letsencrypt. sh for more details.
  5. To see if the whole stack comes together by running command docker-compose up
  6. To shut down the running app, run command docker-compose down
  7. Important note: you can run cronjob to automatically redploy if there is any change on the code repository. To do so, follows the below steps:
    • Change which git branch to monitor by modifying the BRANCH variable in redeploy.sh script.
      • E.g. point to the current branch: BRANCH=$(git branch --show-current)
      • E.g. point to the master branch BRANCH=master
    • Place */5 * * * * (cd /home/ubuntu/ShieldPK12 && sh redeploy.sh > redeploy.log) into a text file, e.g. job.txt
    • Then run command crontab job.txt. You can check if cronjob in place by crontab -l

Deploy without SSL

In case you do not own a domain name yet, or just want to deploy the test/develop version of the app, you can deploy without SSL:

  1. Follow step 1 - 3 in previous section
  2. Run command docker-compose -f docker-compose_wo_ssl.yml up --build -d.
  3. Then you can access the web app at http://{hostIP}. See the custom docker compose file docker-compose_wo_ssl.yml for more details.

Tutorials and Useful Links

About

Shield Playbook for K to 12

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors