diff --git a/README.md b/README.md index 02d1f1d0..86d27ea1 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,41 @@ ## Note on deploying the website -Automatic builds have not yet been implemented. +1. Add mimic-production to remote + After the pull request of the new material is merged into the main branch of mimic-website, pull down the latest version of main to your local repo. Run the following command after filling in the IP address for server Heimdallr: + + `git remote add mimic-production webuser@:/home/webuser/mimic-website.git` + + * Optional: Check if the command above ran correctly, + Run command: `git remote -v` + should return: + mimic-production webuser@:/home/webuser/mimic-website.git (fetch) + mimic-production webuser@:/home/webuser/mimic-website.git (push) + origin https://www.github.com/MIT-LCP/mimic-website (fetch) + origin https://www.github.com/MIT-LCP/mimic-website (push) + +2. Sshuttle into the production server + + Run the following command after filling in the LCP username and IP address: `alias sshholyoke="sshuttle -r @helios.mit.edu "` + + Run command: `sshholyoke` + + Should return: “client: Connected” after you enter your password + +3. Push development + + In another terminal from your mimic-website repo: + + Run command: `git push mimic-production` + + + * Note: + Your public key (for the machine you're pushing from) must be in the webuser group + + Currently, some minor errors exist related to reading git log. If error messages show up after push to mimic-production, website deployment might still be successful. It is always good practice to check the website after deployment. + + Error message is "Failed to read Git log: fatal: not a git repository: '.'". ## Issues with the website or MIMIC -Please raise issues related to the website or MIMIC-III in the [mimic-code repository](https://github.com/mit-lcp/mimic-code). \ No newline at end of file +Please raise issues related to the website or MIMIC-III in the [mimic-code repository](https://github.com/mit-lcp/mimic-code).