update user system section of readme (danny-avila#207)

jrd2017 · May 7, 2023 · bdcb7ac · bdcb7ac
1 parent 960e8c4
commit bdcb7ac
Showing 1 changed file with 41 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -312,7 +312,32 @@ set in docker-compose.yml file, under services - api - environment
 
 **First Time Setup**
 
-([danorlando](https://github.com/danorlando)) The first time you run the application, you should register a new account by clicking the "Sign up" link on the login page. The first account registered will be recieve an admin role. The admin account does not currently have extended functionality, but is valuable should you choose to create an admin dashboard for user management. 
+In order for the auth system to function properly, there are some environment variables that are needed. Note that this information is also included in the [/api/.env.example](https://github.com/danny-avila/chatgpt-clone/blob/main/api/.env.example) and [/client/.env.example](https://github.com/danny-avila/chatgpt-clone/blob/main/client/.env.example) files.
+
+In /api/.env, you will need to set the following variables:
+```bash
+JWT_SECRET_DEV=secret
+# Add a secure secret for production if deploying to live domain.
+JWT_SECRET_PROD=secret
+# Set the expiration delay for the secure cookie with the JWT token
+# Delay is in millisecond e.g. 7 days is 1000*60*60*24*7
+SESSION_EXPIRY=1000 * 60 * 60 * 24 * 7
+# Note: NODE_ENV should be set to 'development' in the Server configuration section if you want to run in dev mode
+CLIENT_URL_DEV=http://localhost:3090
+SERVER_URL_DEV=http://localhost:3080
+# Change these values to domain if deploying:
+CLIENT_URL_PROD=http://localhost:3080
+SERVER_URL_PROD=http://localhost:3080
+```
+
+In /client/.env, you will need to set the following variables:
+```bash
+VITE_SERVER_URL_DEV=http://localhost:3080
+# Change this to domain if deploying:
+VITE_SERVER_URL_PROD=http://localhost:3080
+```
+
+The first time you run the application, you should register a new account by clicking the "Sign up" link on the login page. The first account registered will be recieve an admin role. The admin account does not currently have extended functionality, but is valuable should you choose to create an admin dashboard for user management. 
 
 **Migrating Previous Conversations and Presets to new User Account**
 
@@ -326,6 +351,21 @@ The application is setup to support OAuth2/Social Login with Google. All of the
 
 To enable Google login, you must create an application in the [Google Cloud Console](https://cloud.google.com) and provide the client ID and client secret in the [/api/.env](https://github.com/danny-avila/chatgpt-clone/blob/main/api/.env.example) file, then set `VITE_SHOW_GOOGLE_LOGIN_OPTION=true` in the [/client/.env](https://github.com/danny-avila/chatgpt-clone/blob/main/client/.env.example) file. 
 
+*Instructions for setting up Google login are provided below.*
+
+1. Go to "APIs and Services" in your Google Cloud account and click on "Credentials".
+2. Click on "Configure consent screen" and select "External" as the user type.
+3. Add "profile", "email" and "openid" as the scopes for your app. These are the first three checkboxes when you click on "Add or remove scopes".
+4. Click on "Save and continue" and then "Back to dashboard".
+5. Click on "Create Credentials" and then "OAuth client ID".
+6. Select "Web application" as the application type and give it a name.
+7. Add "http://localhost/" "http://localhost:3080/" and "http://localhost:3090/" to the authorized JavaScript origins.
+8. Add "http://localhost:3080/oauth/google/callback" to the authorized redirect URIs.
+9. Click on "Create" and copy your client ID and client secret.
+10. Paste them into your api/.env file.
+11. Enable the feature in the client/.env file
+
+
 **Email and Password Reset** 
 
 Most of the code is in place for sending password reset emails, but is not yet feature-complete as I have not setup an email server to test it. Currently, submitting a password reset request will then display a link with the one-time reset token that can then be used to reset the password. Understanding that this is a considerable security hazard, email integration will be included in the next release.