From 48e822e6e58e685c843edf872cb99396e2f15db0 Mon Sep 17 00:00:00 2001 From: Matt Fancher <142915944+FancMa01@users.noreply.github.com> Date: Thu, 19 Dec 2024 08:22:32 -0700 Subject: [PATCH] Docs fixes so that they deploy --- docs/docs/Install/Configurations.md | 7 ++++++- docs/docs/Install/Docker.md | 4 ++++ docs/docs/Install/Local.md | 1 + docs/docs/User-Guides/user-interface.md | 5 ++++- 4 files changed, 15 insertions(+), 2 deletions(-) diff --git a/docs/docs/Install/Configurations.md b/docs/docs/Install/Configurations.md index 7e002d8f..7cdf73db 100644 --- a/docs/docs/Install/Configurations.md +++ b/docs/docs/Install/Configurations.md @@ -130,10 +130,15 @@ The preferred method, however, is **Azure AD** (formerly Azure Active Directory) The client secret from Azure AD. You obtain this after registering your application in Azure AD. _Example:_ `your_client_secret` -- **REDIRECT_URI=http://localhost:3001** +- **REDIRECT_URI** The redirect URI from Azure AD. You obtain this after registering your application in Azure AD. _Example:_ `http://localhost:3001` +- **CSRF_SECRET** + A string or value utilized to verify secure exchanges between client and server. + + _Example:_ `123e4567-e89b-12d3-a456-426655440000` + --- ### 6. Email Configuration diff --git a/docs/docs/Install/Docker.md b/docs/docs/Install/Docker.md index 0be81aa8..fb68905a 100644 --- a/docs/docs/Install/Docker.md +++ b/docs/docs/Install/Docker.md @@ -21,6 +21,10 @@ Before setting up Tombolo with Docker, ensure your system meets the following re - **Docker**: Ensure Docker is installed and running on your machine, preferably the latest version. You can download the most recent version from [Docker's official site](https://www.docker.com/get-started). - **Git**: Preferably latest version +### Other Prerequisites + +- **Email Provider** - Required to verify user accounts. + --- ### Step 1- Clone the Repository diff --git a/docs/docs/Install/Local.md b/docs/docs/Install/Local.md index f94f3182..5f68c71f 100644 --- a/docs/docs/Install/Local.md +++ b/docs/docs/Install/Local.md @@ -23,6 +23,7 @@ Local installation requires a few dependencies to be installed directly on your - [Git](https://git-scm.com/downloads) latest version recommended. - [MySQL Database](https://dev.mysql.com/downloads/) latest version recommended (URL, and port number, must be accessible from the installation environment). - [HPCC cluster](https://hpccsystems.com/getting-started/) latest version recommended. +- Email Provider - Required to verify user accounts. ### Recommended Software and Skills diff --git a/docs/docs/User-Guides/user-interface.md b/docs/docs/User-Guides/user-interface.md index 1d085963..a9c523b5 100644 --- a/docs/docs/User-Guides/user-interface.md +++ b/docs/docs/User-Guides/user-interface.md @@ -36,7 +36,10 @@ The workflows section contains all of Tombolo's functionalities for setting up, The monitoring section contain's a set of tools to monitor assets within HPCC.