Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated deploy production branch note #177

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 32 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,38 @@

## 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@<IP address for Heimdallr>:/home/webuser/mimic-website.git`

* Optional: Check if the command above ran correctly,
Run command: `git remote -v`
should return:
Mimic-production webuser@<IP address for Heimdallr>:/home/webuser/mimic-website.git (fetch)
Mimic-production webuser@<IP address for Heimdallr>:/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 sshcsail="sshuttle -r <LCP username>@heimdallr.csail.mit.edu <IP address for Heimdallr>/24"`

Run command: `sshcsail`

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`


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought you were going to add an "Expected errors" section. I think we can wait to fix the errors until someone has some extra time. If you are getting errors and the deployment is still working, I think it's best to mention them here though.

Copy link
Contributor

@briangow briangow May 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@SichengH , I see your update but it's better to give some specific keywords from the expected errors that we are getting. Is this possible?


* Note:
Your public key (for the machine you're pushing from) must be in the webuser group


## Issues with the website or MIMIC

Expand Down