diff --git a/guides/users-guide/quickstart.md b/guides/users-guide/quickstart.md index 665062bf3..57fde99b6 100644 --- a/guides/users-guide/quickstart.md +++ b/guides/users-guide/quickstart.md @@ -6,7 +6,7 @@ icon: sign-posts-wrench ## Quickstart for users (quick method) -1. Download our [Docker compose file](https://github.com/bluewave-labs/bluewave-uptime/blob/develop/Docker/dist/docker-compose.yaml) +1. Download our [Docker compose file](https://github.com/bluewave-labs/bluewave-uptime/raw/refs/heads/master/Docker/dist/docker-compose.yaml) 2. Run `docker compose up` to start the application 3. Now the application is running at `http://localhost` @@ -96,6 +96,13 @@ Make sure you change the directory to the specified directories, as paths in com | VITE_APP_LOG_LEVEL | Optional | `string` | Log level | `"none"`\|`"error"` \| `"warn"` \| | | VITE_APP_DEMO | Optional | `boolean` | Demo server or not | `true`\|`false` \| | +Sample ENV file: + +``` +VITE_APP_API_BASE_URL="http://localhost:5000/api/v1" +VITE_APP_LOG_LEVEL="debug" +``` + #### Starting the Client development server 1. Run `npm run dev` to start the development server. @@ -112,6 +119,25 @@ Configure the server with the following environmental variables:
ENV Variable NameRequired/OptionalTypeDescriptionAccepted Values
CLIENT_HOSTRequiredstringFrontend Host
JWT_SECRETRequiredstringJWT secret
REFRESH_TOKEN_SECRETRequiredstringRefresh JWT secret
DB_TYPEOptionalstringSpecify DB to useMongoDB | FakeDB
DB_CONNECTION_STRINGRequiredstringSpecifies URL for MongoDB Database
PORTOptionalintegerSpecifies Port for Server
LOGIN_PAGE_URLRequiredstringLogin url to be used in emailing service
REDIS_HOSTRequiredstringHost address for Redis database
REDIS_PORTRequiredintegerPort for Redis database
TOKEN_TTLOptionalstringTime for token to liveIn vercel/ms format https://github.com/vercel/ms
REFRESH_TOKEN_TTLOptionalstringTime for refresh token to live
PAGESPEED_API_KEYOptionalstringAPI Key for PageSpeed requests
SYSTEM_EMAIL_HOSTRequiredstringHost to send System Emails From
SYSTEM_EMAIL_PORTRequirednumberPort for System Email Host
SYSTEM_EMAIL_ADDRESSRequiredstringSystem Email Address
SYSTEM_EMAIL_PASSWORDRequiredstringSystem Email Password
+Sample env file + +``` +CLIENT_HOST="http://localhost:5173" +JWT_SECRET="my_secret" +DB_TYPE="MongoDB" +DB_CONNECTION_STRING="mongodb://localhost:27017/uptime_db" +REDIS_HOST="127.0.0.1" +REDIS_PORT=6379 +TOKEN_TTL="99d" +PAGESPEED_API_KEY= +SYSTEM_EMAIL_HOST="smtp.gmail.com" +SYSTEM_EMAIL_PORT=465 +SYSTEM_EMAIL_ADDRESS= +SYSTEM_EMAIL_PASSWORD= +REFRESH_TOKEN_SECRET="my_refresh" +REFRESH_TOKEN_TTL="99d" +``` + --- #### Databases