From 68647f20fa42a94fee593036c3abf1dede599ecd Mon Sep 17 00:00:00 2001 From: Erland A Syafiq Date: Tue, 18 Jun 2024 13:03:10 -0400 Subject: [PATCH] Updated environment variables docs --- README.md | 2 +- docs/assets/.env.template | 4 ++-- docs/env-file.md | 6 +++--- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4a4dd15..c065b76 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ The VTMUNC website is hosted on an Amazon EC2 instance, which serves as the core ## Table Of Contents: - [🚀 Set Up](#-set-up) -- [⚙️ Environment Variables File](docs/env-file.md) +- [⚙️ Environment Variables](docs/env-file.md) - [📂 Project Overview](docs/project-overview.md) - [📙 Site Overview](docs/site-overview.md) - [🎨 Style Guide](docs/style-guide.md) diff --git a/docs/assets/.env.template b/docs/assets/.env.template index 172510e..f24aa26 100644 --- a/docs/assets/.env.template +++ b/docs/assets/.env.template @@ -2,6 +2,6 @@ AWS_DYNAMODB_ACCESS_KEY_ID= AWS_DYNAMODB_SECRET_ACCESS_KEY= AWS_DEFAULT_REGION= BACKEND_URL= -USERNAME= -PASSWORD= +ADMIN_USERNAME= +ADMIN_PASSWORD= JWT_SECRET= \ No newline at end of file diff --git a/docs/env-file.md b/docs/env-file.md index cd074d7..32a1e96 100644 --- a/docs/env-file.md +++ b/docs/env-file.md @@ -1,4 +1,4 @@ -# ⚙️ Environment Variables File +# ⚙️ Environment Variables This file defines environment variables used by VTMUNC. Note, that this env file is seperate from the environment variables for GitHub, where you need to paste in this environment variable file as a variable called ENV_FILE. Find out more from the [deployment docs](./deployment.md#-step-7-set-environment-variables-in-github) @@ -12,8 +12,8 @@ Never, commit .env files to any remote repository, including GitHub. Only share | AWS_DYNAMODB_SECRET_ACCESS_KEY | Your AWS DynamoDB secret access key. Refer to "Obtaining AWS Credentials Securely" to obtain this value. | `sb0lasoiwkdouwedfes` (fake) | | AWS_DEFAULT_REGION | The default AWS region your application will use | `us-east1` | | BACKEND_URL | The URL of your backend API | `localhost:3000/api` | -| USERNAME | The admin username | `randomemail@gmail.com` (fake) | -| PASSWORD | The admin password | `randOMPassWordForMUN&283` (fake) | +| ADMIN_USERNAME | The admin username | `randomemail@gmail.com` (fake) | +| ADMIN_PASSWORD | The admin password | `randOMPassWordForMUN&283` (fake) | | JWT_SECRET | A secret key used for generating JSON Web Tokens (JWTs) for authentication. | `okmasfq;eiuidf` (fake) | ## Obtaining AWS Credentials Securely