From b8c0d4ef67fa4f7fbe04cda0ab6ac97eae70e876 Mon Sep 17 00:00:00 2001 From: Hargata Softworks <155338622+hargata@users.noreply.github.com> Date: Tue, 23 Jan 2024 16:43:03 -0700 Subject: [PATCH] Update GettingStarted.md --- docs/documentation/GettingStarted.md | 37 ++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/docs/documentation/GettingStarted.md b/docs/documentation/GettingStarted.md index c264ffa..3eb0f60 100644 --- a/docs/documentation/GettingStarted.md +++ b/docs/documentation/GettingStarted.md @@ -26,8 +26,45 @@ By default the app will start listening at localhost:8080, this port can be conf Windows Standalone executables are provided on a request basis, and will usually be included with every other release. To run the server, you just have to double click on CarCareTracker.exe Occassionally you might run into an issue regarding a missing folder, to fix that, just create a "config" folder where CarCareTracker.exe is located. +If you wish to set up SMTP when using this approach, you will have to configure the environment settings in appsettings.json located in the same folder as CarCareTracker.exe +You just have to add the MailConfig section into it, but I provided the full appsettings.json anyways as an example. +``` +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + }, + "AllowedHosts": "*", + "UseDarkMode": false, + "EnableCsvImports": true, + "UseMPG": true, + "UseDescending": false, + "EnableAuth": false, + "HideZero": false, + "EnableAutoReminderRefresh": false, + "EnableAutoOdometerInsert": false, + "UseUKMPG": false, + "UseThreeDecimalGasCost": true, + "VisibleTabs": [ 0, 1, 4, 2, 3, 6, 5, 8 ], + "DefaultTab": 8, + "UserNameHash": "", + "UserPasswordHash": "", + "MailConfig": { + "EmailServer": "", + "EmailFrom": "", + "UseSSL": true, + "Port": 587, + "Username": "", + "Password": "" + } +} + +``` When using this approach, the default port the app will be listening on is 5000, so you will navigate to localhost:5000 +## Test that It Works Whichever path you choose, once you get the app up and running, just navigate to the IP address and port the server is listening to and you should be able to see the app ![image](https://github.com/hargata/lubelog/assets/155338622/a32c40ce-271c-406b-a211-c1f2af138418) ![image](https://github.com/hargata/lubelog/assets/155338622/4e1c913c-001e-43fd-9b56-4ecffdfd4c2e)