ddmal/simssadb_django repository overview

⁠docker-simssadb

Docker wrapper for ELVIS-Project/simssadb⁠.

⁠Servers

Production: https://db.simssa.ca⁠
Staging: https://db.staging.simssa.ca⁠ (need to be on McGill network/VPN)

⁠Installation

• First you must install docker

  • For Mac
    • brew cask install docker
    • pip install docker compose
  • For Ubuntu https://docs.docker.com/install/linux/docker-ce/ubuntu/⁠

• To View the site with no modifications

  • Execute from the root of the repository: docker compose up
  • Go to http://127.0.0.1:1337 on your web browser

• To work on the Django project,

  • You require the submodules: git clone --recurse-submodules [email protected]:DDMAL/docker-simssadb.git
  • Check if you have the latest branch in the django/simssadb folder execute git pull origin develop
    • If the latest has a different hash than the one referenced in this repository, make sure to commit the latest hash to this repository.
  • execute the following command from the root of the repository: docker compose -f build.yml build. Alternatively, try running sudo docker compose up if errors appear.
  • In another terminal window, execute:

  # This will give you a new shell
  docker compose exec django bash
  
  # In the new shell, type the following
  /machine/start
  

  Copy

Note: Make sure you have the correct image tags when pulling. Cross check with Docker Hub and edit the tags in docker-compose.yml.

⁠Deployment

To deploy changes made locally to production/staging:

• Make sure Docker Hub built the images correctly: ddmal/simssadb_django, ddmal/simssadb_postgres, ddmal/simssadb_nginx
• ssh into the staging or production server. Information on how to access them can be found on https://wiki.internal.simssa.ca⁠
• Find where the current docker-simssadb repo is. It's normally in /srv/webapps/
• Make sure you have the correct docker image tags and run sudo docker compose up

Note: Make sure to check for unused images, build caches, old volumes etc.