Skip to content

Deployment

Janell Huyck edited this page Sep 15, 2023 · 7 revisions

AAEC App Deployment Guide

Welcome to the AAEC App Deployment Guide. This guide covers deployments for both QA and Production environments.


Quick Overview: QA vs. Production

Feature QA Production
Server libappstest.libraries.uc.edu libapps.libraries.uc.edu
Web URL QA Web URL Production Web URL
Config File config/deploy/qa.rb config/deploy/production.rb
Deploy Command cap qa deploy cap production deploy

Common Deployment Procedures

Step 1: The .env.production.local File

This hidden file contains important settings for deployment. Retrieve it from the config vault under the "aaec" folder. IMPORTANT: Never commit this file to GitHub; include it in your .gitignore.

Step 2: Choose Your Branch or Commit

Specify the version of the code you want to deploy by editing config/deploy/qa.rb for QA or config/deploy/production.rb for Production. Modify the line set :branch, '...' to the desired branch or commit.

Step 3: Push to GitHub

Ensure your selected branch or commit is pushed to GitHub before proceeding with the deployment.

Step 4: Open Terminal

Navigate to your project directory in the terminal.

Step 5: Run the Deploy Command

Run cap qa deploy for QA deployment or cap production deploy for Production deployment.

Step 6: Enter Apache Credentials

When prompted, enter the username "apache". The password can be found in the config vault, under a file named "Server and deploy credentials.md".

Step 7: Verify the Deployment

If there are no error messages in the terminal, the deployment is successful. Confirm by navigating to the respective Web URL for your deployment type.


That's it! You're now equipped to deploy the AAEC app to both QA and Production environments. Feel free to reach out if you have further questions.