Skip to content

Commit caaccc3

Browse files
authored
chore: Integrated SSL configuration for HTTPS into environment configuration gt file. Updated README accordingly. (#213)
1 parent 31d09df commit caaccc3

File tree

3 files changed

+11
-1
lines changed

3 files changed

+11
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ Here are the steps:
203203
2. Run `mkcert -install` to install the generated certificate in your trust store. After installed, restart your browser.
204204
3. Now you can start the development session as follows:
205205
```zsh
206-
HTTPS=true SSL_CRT_FILE=localhost.pem SSL_KEY_FILE=localhost-key.pem npm start
206+
HTTPS=true npm start
207207
```
208208
4. Open https://localhost:3000/ to view your development session rendered to the browser.
209209

@@ -221,6 +221,11 @@ Similarly, some local environment variables must be specified in order to ensure
221221
- Use `npm run local` to develop locally **without** authentication enabled
222222
- Use `npm start` to develop locally **with** authentication
223223
- If environment variables are not configured, you will be prompted to provide them
224+
- Provide the `pem` files as follows when configuring the environment variables:
225+
```zsh
226+
SSL_CRT_FILE=localhost.pem
227+
SSL_KEY_FILE=localhost-key.pem
228+
```
224229

225230
## 🎉Acknowledgements
226231
Many thanks to the [UMass Lowell Cloud Computing Club](https://umasslowellclubs.campuslabs.com/engage/organization/cloudcomputingclub) members, our faculty advisor [Dr. Johannes Weis](https://www.uml.edu/sciences/computer-science/people/weis-johannes.aspx), and the [UMass Lowell Computer Science Department](https://www.uml.edu/Sciences/computer-science/) for their support and guidance.

env_config/.gt/dev.gt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,5 @@ AUTHORITY
99
CLIENT_ID
1010
REDIRECT_URI
1111
SCOPE
12+
SSL_CRT_FILE
13+
SSL_KEY_FILE

env_config/configure_dev.sh

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ if [ -f "$env_file" ]; then
3333
else
3434
# If the file does not exist, prompt for and create it
3535
. ./env_config/process_gt.sh "$gt_file" "$env_file"
36+
37+
# Then validate immediately
38+
. ./env_config/validate_vars.sh "$gt_file" "$env_file"
3639
fi
3740

3841
set -a

0 commit comments

Comments
 (0)