From 47cb15d1661dd6f3294773944559e2aa60d2822e Mon Sep 17 00:00:00 2001
From: xnought <bertuccd@oregonstate.edu>
Date: Fri, 3 May 2024 12:11:56 -0700
Subject: [PATCH] docs: deployment

---
 README.md          |  1 +
 docs/deployment.md | 41 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 42 insertions(+)
 create mode 100644 docs/deployment.md

diff --git a/README.md b/README.md
index fa447a1..96e280a 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,7 @@ In collaboration with the [Venom Biochemistry & Molecular Biology Laboratory](ht
 	- [`frontend.md`](./docs/frontend.md) for the **frontend** architecture and help
 	- [`backend.md`](./docs/backend.md) for the **backend** architecture and help
 	- [`auth.md`](./docs/auth.md) for how we did authentication 
+	- [`deployment.md`](./docs/deployment.md) for how to deploy to the internet
 
 ## ️⚡️ Quick Start
 
diff --git a/docs/deployment.md b/docs/deployment.md
new file mode 100644
index 0000000..ea9703f
--- /dev/null
+++ b/docs/deployment.md
@@ -0,0 +1,41 @@
+# Deployment
+
+To deploy venome we use the Oregon State [Center for Quantitative Life Sciences (CQLS)](https://cqls.oregonstate.edu/) servers. They have a linux virtual machine that we can ssh into and expose our application to the internet.
+
+## `ssh`ing into the our VM
+
+**1. Make an account through CQLS**
+
+First you need to have an account through CQLS. So first sign up https://shell.cqls.oregonstate.edu/access/ to get access. I'd reccomend you make the CQLS username just your ONID one.
+
+Once you make an account, ask Nate or Michael to email the admin (Ken) about adding you to our venome linux VM. Otherwise, you won't have access.
+
+**2. `ssh`**
+
+You'll need to `ssh` into a few servers to get in. `your_assigned_port` is an integer and should be given to you upon registration of your CQLS account through email. `your_cqls_username` is simply your CQLS username you entered when registering.
+
+First 
+
+```bash
+ssh -p your_assigned_port your_cqls_username@shell.cqls.oregonstate.edu
+```
+and enter your CQLS password
+
+Then once you are in
+
+```bash
+ssh hpc.cqls.oregonstate.edu
+```
+and enter your OSU ONID password, not your CQLS password this time.
+
+Then finally
+
+```bash
+ssh venome-pvt
+```
+and enter your OSU ONID password again.
+
+✅ Success you are in!
+
+
+