Skip to content

Latest commit

 

History

History
66 lines (44 loc) · 1.66 KB

README.md

File metadata and controls

66 lines (44 loc) · 1.66 KB

UF Open Source Club's Stack

This contains the Docker configs used to setup the clubs website, back-end, and admin portal.

It should reference the Dockerfile located in each of those repos. We will use Git Submodules to manage everything.

Getting Started

We will use Docker to develop test the code.

Installing

Install Docker and Docker compose.

From inside the club-stack directory, download the most up-to-date submodules' master branches with

git submodule update --init --remote

Running

To run the app

docker-compose up

And go to localhost:80 for the club website.

Once you are done, you can press "Ctrl-C" in the terminal or type

docker-compose down -v

Be sure to read the certbot-info file for information about the SSL Certificate configuration.

Deployment

When updating the project on the server, never run docker-compose down -v as that will bring down the website. Instead:

  1. Update the Git folder
    git pull
  2. Update the submodules (to their master branches)
    git submodule update --remote
  3. Rebuild the docker image
    docker-compose build
  4. Update the running container
    docker-compose up -d

Contributing

Please read CONTRIBUTING.md for how to work on the project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details