diff --git a/docusaurus/docs/Advanced Installation/Docker BE Install Guide.md b/docusaurus/docs/Advanced Installation/Docker BE Install Guide.md
index d79d41f..f41f4b9 100644
--- a/docusaurus/docs/Advanced Installation/Docker BE Install Guide.md
+++ b/docusaurus/docs/Advanced Installation/Docker BE Install Guide.md
@@ -1,58 +1,137 @@
---
-sidebar_label: 'Docker Backend Installation'
-sidebar_position: 1
-slug: "/advanced-installation/docker-backend-installation"
+sidebar_label: 'Docker Back End Installation'
+sidebar_position: 7
+slug: "/advanced-installation/docker-back-end-installation"
+hide_table_of_contents: true
---
+import AppName, {WrapVariable, ShowIntenralDockerTag} from "@site/src/components/CustomFields";
-# Docker Installation
+# AI Core Docker Installation
-This guide will show the steps for installing **Docker** and running SEMOSSName in a Docker container.
-For instructions on how to perform a frontend installation of SEMOSSName instead, click **[here](Frontend%20Installation.md)**.
+This guide will show the steps for installing **Docker** and running in a Docker container.
+For instructions on how to perform a front end installation of instead, click **[here](Front%20End%20Installation.md)**.
> **Note**
-> If you don't need admin privileges and would prefer a **lightweight, low management** way to connect to SEMOSSName, then use the [live web server](https://semoss.com/demo/SemossWeb/packages/client/dist/) instead of following this guide. Instructions to set up a connection to the web version can be found in the [Connecting to SEMOSSName](../Integrating%20with%20SEMOSS/ConnectingToAI.md) guide.
+> If you don't need admin privileges and would prefer a **lightweight, low management** way to connect to , then use the [live web server](https://workshop.cfg.deloitte.com/cfg-ai-demo/SemossWeb/packages/client/dist/) instead of following this guide. Instructions to set up a connection to the web version can be found in the [Connecting to ](../Integrating%20with%20SEMOSS/Connecting%20to%20CFG%20AI.md) guide.
## Before You Begin
-- **External Docker/container deployments are not supported on SEMOSSName.**
-- Custom container deployments require full cyber, and risk approvals, which are not supported for standard app onboarding.
+- **External Docker/container deployments are not supported on AI Core.**
+- Custom container deployments require full Deloitte GTOM, cyber, and risk approvals, which are not supported for standard app onboarding.
- Applications intended for production use must be deployed in the user’s own cloud environment and accessed via API.
-- Backend extensions on SEMOSSName should be implemented using supported technologies (e.g., Java or Python).
+- Backend extensions on AI Core should be implemented using supported technologies (e.g., Java or Python).
-This guide documents how to run SEMOSSName inside a Docker container for **local development and internal usage scenarios only**.
+This guide documents how to run inside a Docker container for **local development and internal usage scenarios only**.
-Docker containers created using this guide **must not be considered a supported production deployment model** for SEMOSSName-hosted applications.
+Docker containers created using this guide **must not be considered a supported production deployment model** for AI Core-hosted applications.
## Docker Installation Guide
+
> **Note**
-> **Quick Link**: If you already created a Docker container for SEMOSSName by following this guide, then you can jump directly to the shortcuts below to start your server:
+> **Quick Link**: If you already created a Docker container for by following this guide, then you can jump directly to the shortcuts below to start your server:
> * **For Windows:** [Running an Existing Docker Container on Windows](#running-an-existing-docker-container-on-windows)
> * **For Mac OSX:** [Running an Existing Docker Container on Mac](#running-an-existing-docker-container-on-mac)
+
### Download Docker
-If you already have Docker installed, you can skip to the next step ([Accessing the SEMOSSName Docker Repository](#accessing-the-ai-core-docker-repository).
+If you already have Docker installed, you can skip to [Accessing the SEMOSS Docker Repository](#accessing-semoss-docker-repository).
If this is your first time installing Docker, please follow the installation guides for your operating system linked below:
-* [Windows Docker Installation Guide](https://docs.docker.com/desktop/install/windows-install/)
-* [OSX/Mac Docker Installation Guide](https://docs.docker.com/desktop/install/mac-install/)
-* [Windows/Max install without Docker Desktop](https://docs.docker.com/engine/install/)
+* [Windows Docker Installation Guide](https://docs.docker.com/desktop/install/windows-install/)
+* [OSX/Mac Docker Installation Guide](https://docs.docker.com/desktop/install/mac-install/)
+* [Docker Engine install (Linux)](https://docs.docker.com/engine/install/)
### Accessing SEMOSS Docker Repository
-SEMOSS docker builds and deployes images to Quay.io
+SEMOSS Docker builds and deploys images to Quay.io:
[Quay Docker](https://quay.io/repository/semoss/semoss-dev?tab=tags&tag=latest)
+
+
+### Accessing the AI Core Docker Repository
+
+* Please reach out to your administrator to get access to the Docker Repository. You can only continue with the rest of the guide after receiving access.
+* After being granted Docker repository access, log into the repository via your organization's SSO.
+ - If you are not automatically redirected to the SSO login, then click on the button that says **"Login via OIDC Provider"** to be redirected to your organization's SSO login.
+
+* After logging in, **click on your username in the top right hand corner**, then click **User Profile** in the dropdown menu.
+* In your user profile, look for the **CLI secret** field. Click on the blue copy icon to the right to copy it to your clipboard.
+
+* Make sure that your Docker Desktop is currently running. If it is not, then launch the Docker Desktop app.
+* Open up a new command prompt/terminal and enter the following command: `docker login DOCKER_REPOSITORY_URL`, and replace `DOCKER_REPOSITORY_URL` with the repository link that your administrator provided you.
+ - It will take a few moments to connect.
+ - When it prompts for your username, enter your **organization email address**
+ - When it prompts for your password, hit ctrl-V *ONCE* to paste the password that you copied from your user profile details (or command-V for Mac), then hit enter.
+ - **Note: The password will not appear in the terminal when you paste it**, so be careful to only hit ctrl-v/command-V once (and do not type in anything else), followed by enter.
+ - It may take a few moments for the authentication to complete. Once complete, a message will say **"Login succeeded"**
+
+
+
+
+### Download the Helper Scripts
+* Click [here](/assets/windows_docker_starter_scripts.zip) to download a zip file called `windows_docker_starter_scripts.zip`.
+* Unzip this folder to any location and copy its path. This guide will refer to this path as `SEMOSS_DOCKER_DIR`. For example, in the image below, the `SEMOSS_DOCKER_DIR` folder path is `C:\workspace\cfgai-docs\assets\windows_docker_starter_scripts`
+ 
+
+### Set Up Your Container and Volume
+* Open up a command prompt and navigate to the `SEMOSS_DOCKER_DIR` by running `cd SEMOSS_DOCKER_DIR` (replace `SEMOSS_DOCKER_DIR` with the actual folder path you copied in the previous step).
+> **Note**
+> The helper scripts default to using port 8080 to host . If port 8080 is blocked on your computer and you wish to use a different port, then use any text editor (VSCode or Notepad++) to edit both **init.bat** and **startAIServer.bat** by replacing the `8080` in the lines that say `set ACTIVE_PORT=8080` with your desired port number
+
+* In the command prompt, type `init.bat` and hit enter.
+ - You will see some output and auto-executed commands appear (see below image for reference) while Docker pulls the image and the script runs. This process may take up to 45 minutes depending on your connection speed.
+
+* Once it completes, your browser window will automatically open 2 tabs.
+* Access the tab at http://localhost:8080/Monolith/setAdmin/ to designate an admin user.
+ 
+ - You will see a table appear with an input field to enter your admin credentials.
+ - Since we are creating a native account, you can enter in any username you want. Please remember the username you entered.
+ - Click "Submit" after typing in your username. Do not worry if the page does not respond/redirect: this is normal. As long as you clicked the submit button, your admin username has been stored.
+* Close this tab and navigate to the other tab at http://localhost:8080/SemossWeb/packages/client/dist/ and click on the **Register Now** link
+ 
+ - Fill out the fields for Name, Last Name, Username, Email Address, Password, and Confirm Password.
+ 
+ - **Important**: Make sure your the username you enter matches the username that you created earlier when setting up your admin account.
+* The page will return to the login after successfully creating your account. Enter the username and password you just created, then click **"Login with Native"**.
+ 
+* The page will redirect to the App Library Landing page.
+ 
+* Return to your command terminal, making sure it is still in the `SEMOSS_DOCKER_DIR`.
+* Run:
+ - `cloneAIServer.bat`
+ - `startAIServer.bat`
+ 
+
+### Shutdown and Clean Up
+* To stop running the Docker container, open up a new command terminal, then run:
+ - `cd SEMOSS_DOCKER_DIR`
+ - `stopAIServer.bat`
+
+### Running an Existing Docker Container on Windows
+* To start running a container, open up a command prompt at the `SEMOSS_DOCKER_DIR` and run `startAIServer.bat`
+
+## Mac OSX Instructions
+### Pulling the Docker Image
+* Navigate to the Docker Repository URL that your administrator provided to you. You will see a list of projects.
+* Click on the **genai** project, and then **genai/genai-server**.
+ 
+* In the table that appears, look for the header that says **"Push Time"**. Click twice on this header to sort the table from **most recent to oldest**.
+* In the first row on the table (the most recent image), click on the **"Copy"** icon in the **"Pull Command"** column.
+
+* In a command prompt/terminal, paste the command that you just copied. It should start with `docker pull DOCKER_REPOSITORY_URL ...`
+ - It may take a while (between 5 - 45 minutes, depending on your internet connection speed) to finish pulling.
### Creating a New Docker Container from the Image
* Enter the following command to list your images: `docker images`
* Find the row in the output that says `DOCKER_REPOSITORY_URL/genai/genai-server` under the **REPOSITORY** heading. This corresponds to the image that was just pulled.
+
* Copy the value under **IMAGE ID** for that row.
* Tag your image with a nickname called `genai-image` by executing the following command: `docker tag YOUR_IMAGE_ID genai-image:latest`
- Replace `YOUR_IMAGE_ID` in the above command with the actual **IMAGE ID** that you copied from the previous step.
- `latest` identifies that this is the **most recent** image.
- 
+ 
* Enter the following command to run a container from the image: `docker run -d -p 8080:8080 --name genAI genai-image`
- **-d tag:** The `-d` tag runs the Docker container in **detached mode**, which allows the container to keep running even after you close the command line/terminal window.
If you want the Docker container to automatically shut down when you close the command line/terminal, you can **omit the `-d` tag**.
@@ -61,18 +140,18 @@ SEMOSS docker builds and deployes images to Quay.io
- **`--name` tag:** This allows you to specify a nickname/alias for your container. We set it to `genAI`, but you can replace it.
- **`genai-image`**: This is the nickname for the image that we tagged in the previous step.
* After you enter the command, you will see an alphanumeric string output in the command prompt/terminal.
- 
+ 
* You can verify that the container is running by entering the following command: `docker ps`
- This will list all of the containers you have running. You should see a row with the name `genAI` (or whatever alias you set in your `docker run` command).
* In your browser, navigate to http://localhost:8080/SemossWeb/packages/client/dist/
- **Hint**: If you used a different port than 8080 in your `docker run` command, make sure to replace it in the above link.
- 
-* Accept the cookies if prompted, and you will see the SEMOSSName login landing page.
+ 
+* Accept the cookies if prompted, and you will see the login landing page.
- Note that this login page will not have an option to enter username/password yet as we still need to enable native user account registration.
### Creating an Admin and Registering for a Native Account
* Return to your command line/terminal window, and run the following command to connect to a bash shell inside of the container: `docker exec -it genAI /bin/bash`
- 
+ 
- If you named your container something different than `genAI`, then replace `genAI` with the alias you set.
- If you enter the shell successfully, you should see that the terminal prompter looks like: `root@XXXXXXXX/opt/semoss-artifacts/artifacts/scripts`
* In the shell, run the following commands:
@@ -81,7 +160,7 @@ SEMOSS docker builds and deployes images to Quay.io
- `sed -i 's||true|' social.properties`
- `sed -i 's||http://localhost:8080/SemossWeb/packages/client/dist|' social.properties`
- `head social.properties`
- 
+ 
* Verify that the first 4 lines of output from the last command match what is below:
```
redirect http://localhost:8080/SemossWeb/packages/client/dist
@@ -93,39 +172,40 @@ SEMOSS docker builds and deployes images to Quay.io
* Next, run the following commands:
- `$TOMCAT_HOME/bin/stop.sh`
- `$TOMCAT_HOME/bin/start.sh`
- 
+ 
* You will see some logs and output begin to appear in the terminal. Return to a browser window and navigate to http://localhost:8080/SemossWeb/packages/client/dist/
- 
+ 
* Verify that an option to enter a username and password has now appeared on the login page. Do not login or register yet.
* Now, you will designate an admin user. Navigate to this link: http://localhost:8080/Monolith/setAdmin/
- 
+ 
- You will see a table appear with an input field to enter your admin credentials
- Since we are creating a native account, you can enter in any username you want. Please remember the username you entered.
- Click "Submit" after typing in your username. Do not worry if the page does not respond/redirect: this is normal. As long as you clicked the submit button, your admin username has been stored.
* Return to http://localhost:8080/SemossWeb/packages/client/dist/ and click on the **Register Now** link
- 
+ 
- Fill out the fields for Name, Last Name, Username, Email Address, Password, and Confirm Password.
- 
+ 
- **Important**: Make sure your the username you enter matches the username that you created earlier when setting up your admin account.
* The page will return to the login after successfully creating your account. Enter the username and password you just created, then click **"Login with Native"**.
- 
-* The page will redirect to the SEMOSSName App Library Landing page.
- 
+ 
+* The page will redirect to the App Library Landing page.
+ 
### Stopping the Container
To stop the container, open up a **new command prompt/terminal** and enter the following command: `docker stop genAI`
* If you named your container something different than `genAI`, then replace `genAI` with the alias you set.
-
+
> **Warning**
> Do not delete your `genAI` docker container. If you accidentally delete it using `docker rm`, `docker system prune`, or `docker container prune`, then you must redo the steps starting from the [Creating a New Docker Container from the Image](#creating-a-new-docker-container-from-the-image) section of this guide.
### Running an Existing Docker Container on Mac
-Now that you have created a Docker container to run SEMOSSName, you can run it directly by entering `docker start genAI` in a command line/terminal. Then, navigate to http://localhost:8080/SemossWeb/packages/client/dist/ in your browser to log in.
-
+Now that you have created a Docker container to run , you can run it directly by entering `docker start genAI` in a command line/terminal. Then, navigate to http://localhost:8080/SemossWeb/packages/client/dist/ in your browser to log in.
+
+
## What's Next?
-Want to start developing apps with SEMOSSName? Learn how to use the SEMOSSName Software Development Kit (SEMOSS SDK) in the [SEMOSS SDK Guide](../Integrating%20with%20SEMOSS/Using%20the%20SDK.md).
+Want to start developing apps with ? Learn how to use the Software Development Kit (SEMOSS SDK) in the [SEMOSS SDK Guide](../Integrating%20with%20SEMOSS/Using%20the%20SDK.md).
If you've already finished that, try out one of the **App Use Case Quick Start guides** linked below to get a hands-on tutorial with your preferred frontend framework!
- [React Quick Start Guide](../Cookbook%20Recipes/Guide%20for%20Building%20a%20JavaScript%20App%20(Node.js).md)
diff --git a/docusaurus/docs/Advanced Installation/Frontend Installation.md b/docusaurus/docs/Advanced Installation/Frontend Installation.md
index ef7dd2f..5bac846 100644
--- a/docusaurus/docs/Advanced Installation/Frontend Installation.md
+++ b/docusaurus/docs/Advanced Installation/Frontend Installation.md
@@ -1,174 +1,185 @@
---
-sidebar_label: 'Frontend Installation'
-sidebar_position: 2
+sidebar_label: 'Front End Installation'
+sidebar_position: 3
+slug: "/advanced-installation/front-end-installation"
---
-import AppName, {WrapVariable} from "@site/src/components/CustomFields";
-
-# Local Front End Installation Guide
-
-Local SEMOSSName Front End Installation Guide
+import AppName from "@site/src/components/CustomFields";
+# Front End Installation Guide
## Overview
-The main way that you'll interact with a Gen AI app is through the SEMOSSName server. By using the SDK you will be able to access the data that you have stored inside your server. However, you can also setup SEMOSSName to run locally.
+This guide covers how to build and run the frontend locally. The frontend connects to your locally running backend (Tomcat) server.
-There are several reasons why this might be useful to you, the main one being that you will have admin privileges back in, and that you can change the SEMOSSName interface to fit your needs more directly.
+## Before you start
+- **Terminal**: on Windows, use **Command Prompt** (`cmd`) or **PowerShell**. On Mac, use the **Terminal** app.
+- You will run copy/paste commands. If you see “command not found”, double check you reopened your terminal after installing tools.
+- If you run into an error at any point, check the [Troubleshooting Tips](Troubleshooting%20Tips.md) guide before continuing.
-This guide will go through what steps to take to get SEMOSSName to run locally as a frontend server.
+Before proceeding, make sure you have completed the backend installation for your platform:
+- [Windows Back End Installation](Windows%20Back%20End%20Installation.md)
+- [Mac Back End Installation](Mac%20Back%20End%20Installation.md)
## Prerequisites
-### Node.js
-You can install Node on your machine by downloading the appropriate installer for your device directly from the Node.js website. Version [v18.16.0](https://nodejs.org/download/release/v18.16.0/) is suggested for our projects (for most Windows machines, you should download `node-v18.16.0-x64.msi`).
-
-### Code Editor
-You'll need to have your code editor of choice downloaded on your machine. We suggest [Visual Studio Code](https://code.visualstudio.com/)
-
-
-## Setting up a Project Directory
-
-In order to have SEMOSSName running locally, you will need to also supplement it with a running backend. You can find a guide to getting your local backend set up using this [link](Docker%20BE%20Install%20Guide.md).
-
-Once you have your backend structure set up we will navigate to your workspace folder, and select our tomcat server:
-
-
-Within the tomcat folder we will navigate to our webapps folder. This is where our UI will reside.
-
-
-
-Now navigate to the webapps folder in your local terminal.
-
-
+### Node.js and pnpm
+The frontend requires **Node.js v24**.
-Once you have your terminal setup, you can navigate to the SEMOSSName repository in github
+Verify by running:
-[SEMOSSName UI repository](https://github.com/SEMOSS/semoss-ui.git)
-
-If this link does not properly open up for you, then please email [support-email](mailto:support-email) to request access.
-
-Inside of the repository click the green code button and copy the code for cloning the repo. You can click the circled button to copy the link that is there.
-
-
-
-Once you have this link you can go back to your open terminal and clone the repository into your webapps folder.
-
-
+```
+node -v
+npm -v
+```
-This will download all of the necessary folder structure into your webapps component.
+If you do not have Node v24 installed yet, install it with a version manager:
-# Installation and Server Setup
+**Windows (nvm-windows):**
+1. Download and run the latest `nvm-setup.exe` from: https://github.com/coreybutler/nvm-windows/releases
+2. Close and reopen your terminal, then verify `nvm -v`
+```
+nvm install 24
+nvm use 24
+node -v
+```
-### Step 1: Node Package Manager (NPM) setup
-You should have Node installed, that will be our package manager of choice. There are instructions for how to install this in our Prerequisites portion.
+**Mac (nvm):**
+1. Install Homebrew if needed: https://brew.sh/
+2. Install nvm: `brew install nvm`
+3. Add this to your `~/.zshrc`, then restart your terminal:
+```zsh
+export NVM_DIR="$HOME/.nvm"
+[ -s "$(brew --prefix nvm)/nvm.sh" ] && \. "$(brew --prefix nvm)/nvm.sh"
+[ -s "$(brew --prefix nvm)/etc/bash_completion.d/nvm" ] && \. "$(brew --prefix nvm)/etc/bash_completion.d/nvm"
+```
+```bash
+nvm install 24
+nvm use 24
+node -v
+```
-You can check that they exist on your machine by typing the following code in a terminal.
+Enable pnpm via Corepack:
```
- node -v
- npm -v
+corepack enable
+corepack prepare pnpm@latest --activate
+pnpm -v
```
+> Note: Corepack ships with modern Node.js (including Node v24). If `corepack` is not found, reinstall/upgrade Node and try again.
-If these output versions, that means that you have a working version of npm on your computer. If you do not go back to prerequisities and make sure to download Node (and npm alongside it).
-
-We will be using npm to install pnpm, which is a lighter package manager.
+### Code Editor
+You'll need a code editor. We recommend [Visual Studio Code](https://code.visualstudio.com/).
-To do so open a terminal and install it using:
+## Step 1: Clone the Frontend Repository
-```npm install -g pnpm```
+Navigate to your Tomcat `webapps` folder (replace `xx` with your Tomcat patch version):
-### Step 2: Installing SEMOSSName's packages
+**Windows:**
+```
+cd C:\workspace\apache-tomcat-11.0.xx\webapps
+```
-Now that we have access to pnpm we are ready to install all necessary SEMOSSName packages.
+**Mac:**
+```
+cd ~/Documents/SEMOSS/workspace/apache-tomcat-11.*/webapps/
+```
-Navigate to your newly created repository inside of webapps, open the `SEMOSS-ui` folder inside of your code editor of choice.
+Clone the repository and rename it:
+```
+git clone https://github.com/SEMOSS/semoss-ui.git SemossWeb
+```
-
+Verify you are on the `dev` branch:
+```
+cd SemossWeb
+git status
+```
-We are going to open a new terminal inside of VS code for the next few portions. You can use an external terminal as well, the results will be the same.
+## Step 2: Install Packages
-Inside the root folder of SEMOSSName we are going to run
+Open a terminal in the root of your `SemossWeb` folder and run:
-```pnpm install```
+```
+pnpm install
+```
-This will go through all of the contents of the `package.lock` file and download them. For reference, here is the [package.lock file](https://github.com/SEMOSS/semoss-ui/blob/dev/package.json)
+This will go through the `package.json` and download all necessary packages. The install may take some time as it resolves dependencies for all sub-packages.
-The install command will also go through and install of the packages that each portion of SEMOSSName uses so it might take some time.
+## Step 3: Build the Frontend
-### Step 3: Setting Up Your .env.local file
+From the root of your `SemossWeb` folder, run:
-When we run the Frontend server we are pointing it to a specific backend route to follow. This will be your locally setup backend server that is outlined in the documentation here: [Backend Install](Docker%20BE%20Install%20Guide.md)
+```
+pnpm build
+```
-If you followed the same naming conventions as those outlined in the above documentation then you can create a new file in your root folder and name it
+This builds all libraries and packages and generates the `dist` output needed to serve the frontend. It may take a while to complete.
-`.env.local`
+> **Troubleshooting:** If the build fails due to timeout or memory errors, you can build each piece individually instead. Navigate into each of the following directories and run `pnpm build` from within them one at a time: `libs/ui`, `libs/renderer`, `libs/sdk`, then `packages/client`.
-You will notice that it will live right underneath the already created `.env` file. It should also appear to look greyed out, this is because it will be ignored by git, so your local preferences will not be pushed up with the rest of your work.
+## Step 4: Access Your Local Server
-Inside of the newly created local enviornment file you should add these specifications:
+Before proceeding, ensure your Tomcat backend server is running. You can verify by navigating to:
```
-ENDPOINT=../../../..
-MODULE=/Monolith_Dev
+http://localhost:9090/Monolith/api/config
```
-Your final outcome should look like this:
-
-
-
-### Step 4: Starting your Frontend Server
+If you see a JSON response, your backend is up and running.
-Within your package.json you should see several scripts that will help run your server.
-
-During this process your backend server must be up and running, so please review the [Backend Installation Guide](Docker%20BE%20Install%20Guide.md) to make sure that it is correctly setup.
+With your backend running, seed yourself as an admin. Open your browser and navigate to:
```
- "scripts": {
- "preinstall": "npx only-allow pnpm",
- "prepare": "husky install",
- "dev": "pnpm run --filter=@semoss/legacy --filter=@semoss/ui --filter=@semoss/client --stream --parallel dev",
- "dev:ui-client": "pnpm run --filter=@semoss/ui --filter=@semoss/client --stream --parallel dev",
- "dev:client": "pnpm run --filter=@semoss/client --stream --parallel dev",
- "build": "pnpm run --filter=@semoss/legacy --filter=@semoss/ui --filter=@semoss/client build",
- "fix": "pnpm run --filter=@semoss/legacy --filter=@semoss/ui --filter=@semoss/client fix"
- },
+http://localhost:9090/Monolith/setAdmin/
```
-We are only going to focus on two of them. `dev` and `dev:ui-client`.
+Type in the username you want to use with and submit.
-If it is the first time that you are running the server, you must run it using
+Once the build has completed, open your browser and navigate to:
-```pnpm run dev```
+```
+http://localhost:9090/SemossWeb/
+```
-This will go through each individual package, bundle them, and create a local server. Afterwards, you may want to shift over to using
+At the bottom of the page, click **Register new user**:
+- Fill out the required fields
+- Make sure the username you register with matches the username you typed into the admin setup page
-```pnpm run dev:ui-client``` since it is slightly lighter-weight.
+Once registered, you can sign in using the same credentials.
+Congratulations! You're all set to start using !
-***Please Note*** The server takes a long time to run. If the webpack seems to be compiled, and you get a ui module not found error, that means you need to wait longer.
+## Updating the Frontend
-### Step 5: Accessing your local server
+We recommend updating your local frontend at least once a week to stay current with the latest features and fixes.
-Once your webpack has compiled you can navigate over to
+To pull the latest changes and update your local frontend:
-```http://localhost:9090/semoss-ui/packages/client/dist/#/```
+1. Navigate to your `SemossWeb` folder and pull the latest code:
-Here you will have to register a user using the native registration.
+```
+cd SemossWeb
+git pull
+```
-
+2. Install any new or updated dependencies:
-Once you've registered a user, you can use the credentials to log into SEMOSSName. This will just be a local user, we recommend using a generic name such as Admin or your first name.
+```
+pnpm install
+```
-
+3. Rebuild:
-Please note that the url here is slightly different than the one shared. This is using an older version of SEMOSSName.
+```
+pnpm build
+```
-Congratulations! You have everything up and running!
+Once the build completes, refresh your browser to see the updates.
## What's Next?
Check out one of the **App Use Case Quick Start guides** linked below to get a hands-on tutorial with your preferred frontend framework!
- [React Quick Start Guide](../Cookbook%20Recipes/Guide%20for%20Building%20a%20JavaScript%20App%20(Node.js).md)
- [Sample VanillaJS Use Case](../Cookbook%20Recipes/VanillaJS%20App%20Quickstart%20Guide.md)
- - [Sample Streamlit Use Case](../Cookbook%20Recipes/Streamlit%20App%20Quickstart%20Guide.md)
+ - [Sample Streamlit Use Case](../Cookbook%20Recipes/Streamlit%20App%20Quickstart%20Guide.md)
\ No newline at end of file
diff --git a/docusaurus/docs/Advanced Installation/Mac Developer Install.md b/docusaurus/docs/Advanced Installation/Mac Developer Install.md
index fa2c8ce..31a93d2 100644
--- a/docusaurus/docs/Advanced Installation/Mac Developer Install.md
+++ b/docusaurus/docs/Advanced Installation/Mac Developer Install.md
@@ -1,73 +1,64 @@
+
import AppName, {WrapVariable} from "@site/src/components/CustomFields";
-## SEMOSSName Installation for Mac Silicon
+## AI Core Installation for Mac Silicon
> Note: This section is undergoing updates and is not in its final form.
+## What you’re installing
+This guide sets up the backend on macOS (Java + Maven projects running on Tomcat). When you are done, this URL should return JSON:
+```
+http://localhost:9090/Monolith/api/config
+```
+
+## Before you start
+- **Terminal**: on macOS, this guide uses the **Terminal** app (you can find it with Spotlight).
+- You will download and unzip several `.zip` files. To unzip on macOS: double-click the `.zip` file in Finder.
+- If you run into an error at any point, check the [Troubleshooting Tips](Troubleshooting%20Tips.md) guide before continuing.
+
### Elevating Permissions
-Whenever you need admin level permissions to execute something (installing a new application, copying files into certain directories), use the Privileges app (green lock icon) - this is like running an application in admin mode!
+Some steps in this guide require admin-level permissions (installing an application, copying files into certain directories). Make sure you're logged in with an admin account. If your Mac has the Privileges app installed (green lock icon), use it to temporarily elevate to admin when prompted.
-
+
-### Set Up your SEMOSSName Dev Directory
+### Set Up your AI Core Dev Directory
-Open Documents, create a new folder called SEMOSS or open your terminal and run mkdir ~/Documents/SEMOSS
+Open Documents, create a new folder called `SEMOSS`, or open your terminal and run `mkdir -p ~/Documents/SEMOSS`.
- This directory will house your workspace, Java, and other installation pieces
- This can be anywhere, but placing it in Documents is the best option
-
+
## Prerequisites
-Download softwares and tools from below links to be able to install SEMOSSName.
-
-### Create SEMOSSName and workspace Folders
-
-Create a folder `SEMOSS` in Documents and then create a folder 'workspace' inside the `SEMOSS` folder
-
-### Download Visual Studio Code
-- Click on [Visual Studio](https://code.visualstudio.com/download)
-- Select Mac
-- Download and install Visual Studio Code
-
-
+Download softwares and tools from below links to be able to install .
-### Install Homebrew- Option 1/2
-- Open the Self Service App through Launchpad or your Applications
-- Go to Homebrew
-- Install Homebrew and follow the instructions on the screen
-- Once installation is done open terminal or iTerm
-- Run brew help in the terminal to ensure it is installed
+### Recommended editor
+We recommend using Visual Studio Code:
+- Download: https://code.visualstudio.com/download
-
+### Create AI Core and workspace Folders
-### Install Homebrew- Option 2/2
-- Before proceeding, make sure that you have elevated permissions with the yellow unlocked icon in the dock
-- Open iTerm or the standard mac Terminal
-- Navigate to [Brew](https://brew.sh/) and copy the command to install Homebrew
-- Paste this into the terminal
-- It will ask you for your password several times – continue to type it in until the installation is complete
- - You can optionally configure your mac to prompt you to use touch id (**given** that you've elevated privileges) by running the following commands:
- - `sudo vim /etc/pam.d/sudo` (use whichever text editor you're comfortable with)
- - Make a space under the very top commented line and add this line: `auth sufficient pam_tid.so`, then make sure to save overriding the readonly option.
- - This is in order to avoid typing in your password over and over again.
-- Once the installation is done, make sure to read and follow the steps on the terminal to complete setting up the path listed under Next steps
-- Run brew help in the terminal to ensure it is installed
+Inside `~/Documents/SEMOSS`, create a `workspace` folder.
-
+Inside `~/Documents/SEMOSS/workspace`, create a `tools` folder (for zipped downloads like the JDK and Maven).
-### iTerm + Git
-iTerm installation is optional but is recommended as it will improve any command line experience
-Click on [iTerm2](https://iterm2.com/)
-- Select Download
-- Install iTerm
-
-- Open iTerm (or regular terminal if skipped)
-- Install git via Homebrew by typing: brew install git
-- Once installed, verify git is working by typing into the terminal: git -v
+### Install Homebrew
+- Open the macOS Terminal app
+- Follow the Homebrew install instructions at https://brew.sh/
+- After install, open a new Terminal window and verify:
+```bash
+brew --version
+```
+> Note: If `brew` is not found after installing, follow the “Next steps” shown by the Homebrew installer to add Homebrew to your `PATH`, then open a new Terminal window and try again.
-
+### Install Git
+- Install Git via Homebrew:
+```bash
+brew install git
+git --version
+```
### .zshrc
- .zshrc will be the file used to maintain all environment variables
@@ -78,63 +69,37 @@ Click on [iTerm2](https://iterm2.com/)
- If the file does not exist, open VS code and select command + N, or go to File >> New text file
- Save the file as .zshrc under your home directory of `/Users/`
-
-
-### Install nvm
-- nvm is a node version management tool for macOS
- - Go to https://github.com/nvm-sh/nvm to check out the latest build
-- Open iTerm (or regular Terminal if skipped)
-- Run:
-```bash
-curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
-```
-- Edit ~/.zshrc (this can be done through nano/vim on command line or VS code
-- At the bottom of the file, add:
-```zsh
-[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion" # This loads nvm bash_completion
-export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"
-[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm
-source ~/.nvm/nvm.sh
-```
-- Open a new iTerm window or terminal window
-- Run:
-```zsh
-nvm install node
-```
-- Once installed, open a new terminal window and type:
-```zsh
-node --version
-```
-- Install pnpm via:
-```zsh
-npm install –g pnpm
-```
-
-
+
### Download Java
-- Download a Java 21 JDS – We use Azul Zulu Builds of OpenJDK
-- Navigate to https://www.azul.com/downloads/?version=java-21-lts&os=macos&architecture=arm-64-bit&package=jdk-fx#zulu
+> **Note:** This guide installs Java 25, which matches the latest version of . If you're setting up against an older, already-deployed instance, check with your team which version of they're on — for example, v5.x runs on Java 21 instead. Semoss version 6 is compatable with Java 21, the container is built using Java 25.
+
+- Download a Java 25 JDK. We use Azul Zulu Builds of OpenJDK.
+- Navigate to https://www.azul.com/downloads/
- Scroll down to see all options
- Choose these filters:
- - Java Version : Java 21 LTS
+ - Java Version : Java 25
- Operating System : macOS
- Architecture : ARM 64 bit
- Java Package : JDK FX
- Select Download and choose Zip
-- Download the zip to your ~/Documents/SEMOSS folder
-- Unzip the folder
+- Download the zip to your `~/Documents/SEMOSS/workspace/tools` folder
+- Unzip the folder into `~/Documents/SEMOSS/workspace/tools`
-
+
### Set Java Home
- Edit ~/.zshrc
- This can be done through nano/vim on command line or VS code
- At the **top of the file** add the JAVA_HOME to be the folder you just unzipped for zulu JDK (see example below and update for username and filepath/version). You can copy the following code to do so:
```zsh
-export JAVA_HOME=/Users/kunalppatel9/Documents/SEMOSS/zulu8.64.0.19-ca-jdk8.0.345-macosx_aarch64
+export JAVA_HOME="$HOME/Documents/SEMOSS/workspace/tools//Contents/Home"
export PATH=$JAVA_HOME/bin:$PATH
```
+> Note: After editing `~/.zshrc`, open a new Terminal window and verify:
+```bash
+java -version
+```
### Eclipse IDE for Enterprise Java and Web Developers
Click on [Eclipse Download](https://www.eclipse.org/downloads/packages)
@@ -143,50 +108,48 @@ Click on [Eclipse Download](https://www.eclipse.org/downloads/packages)
- Open the downloaded dmg and either copy Eclipse into your Applications or into your SEMOSS folder
- Launch Eclipse
-
+
Once your Eclipse & JDK are installed, open Eclipse and specify where you want your workspace to be
- Specify **/Users/Your Username/Documents/SEMOSS/workspace** instead of the default name that shows up
- We recommend that you pin eclipse to your taskbar and pin your workspace to your Quick access bar in finder
-### Apache Tomcat 9
-Click on [Apache Tomcat](https://tomcat.apache.org/download-90.cgi)
-- Choose Binary Distributions, Core, zip file under the latest 9.0 section
-- Download this to your Documents/SEMOSS/workspace folder
-- Unzip the folder
+### Apache Tomcat 11
+Click on [Apache Tomcat](https://tomcat.apache.org/download-11.cgi)
+- Choose Binary Distributions, Core, zip file under the latest 11.0 section
+- Download this to your `~/Documents/SEMOSS/workspace` folder
+- Unzip the folder into `~/Documents/SEMOSS/workspace`
-
+
### Maven
Click on [Maven](https://maven.apache.org/download.cgi)
-- Click the download link beside Binary zip archive, and unzip this to your Documents/SEMOSS folder
+- Click the download link beside Binary zip archive, and unzip this to your `~/Documents/SEMOSS/workspace/tools` folder
- Then, in your .zshrc, add the following lines:
```zsh
-export M2_HOME="$HOME/Documents/SEMOSS/apache-maven-3.9.10"
+export M2_HOME="$HOME/Documents/SEMOSS/workspace/tools/apache-maven-3.9.10"
export PATH=$M2_HOME/bin:$PATH
```
- Remember to modify the above to use the correct folder and version name
+> Note: After editing `~/.zshrc`, open a new Terminal window and verify:
+```bash
+mvn --version
+```
## Installation Steps
-### Git Clone SEMOSS, Monolith & SemossWeb
-- Open iTerm (or regular Terminal if skipped)
+### Git Clone SEMOSS & Monolith
+- Open Terminal
- Run: cd ~/Documents/SEMOSS/workspace
- Run: git clone https://github.com/SEMOSS/Semoss.git
- After SEMOSS is done git cloning, clone Monolith
- Run: git clone https://github.com/SEMOSS/Monolith.git
-- Once Monolith is done cloning, clone SemossWeb
-- Navigate to your tomcat webapps folder. This can be done by running: cd ~/Documents/SEMOSS/workspace/apache-tomcat-9.*/webapps/
-- Run: git clone https://github.com/SEMOSS/semoss-ui.git
-- Once the folder is done cloning, rename it through finder or through this command in the terminal: mv semoss-ui SemossWeb
- Alternatively, you can run the following commands at once:
```zsh
cd ~/Documents/SEMOSS/workspace
git clone https://github.com/SEMOSS/Semoss.git
git clone https://github.com/SEMOSS/Monolith.git
-cd ~/Documents/SEMOSS/workspace/apache-tomcat-9.*/webapps/
-git clone https://github.com/SEMOSS/semoss-ui.git SemossWeb
```
### Import SEMOSS & Monolith into Eclipse
@@ -198,7 +161,7 @@ git clone https://github.com/SEMOSS/semoss-ui.git SemossWeb
- Leave everything else unchecked
- Click “Finish”
-
+
### Configure Build Path for Monolith
- Right click on “Monolith” under Project Explorer
@@ -213,6 +176,14 @@ git clone https://github.com/SEMOSS/semoss-ui.git SemossWeb
> Note: Make sure you are selecting workspace/Semoss/src and not workspace/Monolith/src
+> Note: If you do not see Build Path when right clicking on "Monolith" try:
+> - Click on Project on the Eclipse toolbar located on the upper left side of the screen
+> - Scroll down to properties
+> - Type in Project Facets in the search bar
+> - Make sure to select Java, JavaScript, JAX-RS (REST Web Services, Dynamic Web Module)
+> - Select Apply and Close
+> If that doesn't work, change Dynamic Web Module version from 5.0 to 3.0
+
- If you get the error `The folder is already a source folder`, you might need to first unlink it before you do the above.
- Under Properties for Monolith, Navigate to Resources > Linked Resources, then select the resource name you want to delete and delete it.
@@ -221,49 +192,52 @@ git clone https://github.com/SEMOSS/semoss-ui.git SemossWeb
- Open workspace/Semoss/RDF_Map.prop
- Update all paths to point to the Semoss directory
- For example:
- - Open Find and Replace and replace all instances of C:\\workspace\\Semoss with your path to your Semoss folder you clone – ex. /Users/User name/Documents/SEMOSS/workspace/Semoss
+ - Many defaults in `RDF_Map.prop` are Windows-style paths. Use Find and Replace to update them to your Mac paths.
+ - Replace all instances of `C:\\workspace\\Semoss` with your Semoss repo path, for example: `/Users//Documents/SEMOSS/workspace/Semoss`
- Update all slashes from backslashes to forward slashes in the file paths of RDF_MAP.prop
- Replace \\\\ with /
> Notes:
> 1. User name is your actual user name
> 2. If you have any \\\\ in the paths they need to be changed to / or you will get an error
+> 3. Make sure to not have C:/, just start path with /
- Additionally, ensure you adjust the following property as well:
-BaseFolder C:\\workspace\\Semoss to your Semoss folder
-(eg. BaseFolder /Users/\/Documents/SEMOSS/workspace/Semoss)
+- Update the `BaseFolder` property from the Windows default to your Semoss folder:
+ - Example: `BaseFolder /Users//Documents/SEMOSS/workspace/Semoss`
-
+
### Update server.xml for Tomcat
-- Open Finder and navigate to the following path: /Users/.../workspace/apache-tomcat-9..XX\conf
+- Open Finder and navigate to the following path: `~/Documents/SEMOSS/workspace/apache-tomcat-11.0.xx/conf` (replace `xx` with your Tomcat patch version)
- Right click on server.xml and Open With TextEdit (or your text editor of choice)
- Find the line that says "Connector and the port number" (should be around line 63)
- Change the port to 9090
- Save and close the file
+> Note: If Tomcat fails to start due to port `8005` being in use, update the shutdown port in the same `server.xml` to another unused port (for example `8006`).
-
+
-
+
### Create a Tomcat Server
- Back in Eclipse, at the bottom, select “Servers” tab
- Click "link to create a new Server"
- Select “Tomcat Server vX.X” under “Apache” (your version maybe different)
- Click Next
-- “Browse” for “apache-tomcat-X.X.XX” directory inside workspace
+- “Browse” for “apache-tomcat-11.0.xx” directory inside workspace
- Click “Next”
- Select “Monolith” and click Add to move it to the “Configured” column
- Click Finish
-
+
-
+
-
+
### Update Tomcat Server Configuration
-- Under “Servers” tab, double-click on “Tomcat v9.X Server on localhost”
+- Under “Servers” tab, double-click on “Tomcat v11.X Server on localhost”
- Popup should open
- Under “Server Locations”, select “Use Tomcat installation” and set “Deploy path” to webapps
- Under “Publishing”, select “Never publish automatically”
@@ -272,23 +246,21 @@ BaseFolder C:\\workspace\\Semoss to your Semoss folder
- Edit module and set “Path” /Monolith
- Save configuration
-
+
-
+
### Update web.xml
- Open Eclipse
- Type Command + Shift + R
- Search for web.xml and select the web.xml under Monolith
-- Find and replace for: C:\\workspace\\Semoss\\ to your semoss folder
- - Eg. /Users/User name /Documents/SEMOSS/workspace/Semoss
-- Find and replace for C:/workspace/Semoss and replace with your semoss folder
- - Eg. /Users/User name/Documents/SEMOSS/workspace/Semoss
-- Find and replace for C:\\Temp and replace with /tmp
+- Some defaults in `web.xml` may still contain Windows-style placeholder paths. Update them to your Mac paths:
+ - Replace any occurrences of `C:\\workspace\\Semoss\\` or `C:/workspace/Semoss` with your Semoss path, for example: `/Users//Documents/SEMOSS/workspace/Semoss`
+ - Replace any occurrences of `C:\\Temp` with `/tmp`
> Note: User name is your actual user name
-
+
### Create settings.xml
@@ -313,7 +285,7 @@ cat > ~/.m2/settings.xml << 'EOF'
EOF
```
-
+
### Update Maven
- Open Eclipse
@@ -323,128 +295,105 @@ EOF
- Check “Force Update of Snapshots/Releases”
- Click “OK"
-
+
### Start Tomcat Server
-- Right click “Tomcat v9.0 Server at localhost” under the “Servers” tab
+- Right click “Tomcat v11.0 Server at localhost” under the “Servers” tab
- Select “Start”
+### Verify the Backend is Running
+
+Before proceeding, confirm your backend is working. Open a browser and navigate to:
+
+```
+http://localhost:9090/Monolith/api/config
+```
+
+**You should see a JSON response.** If you do not get a JSON response, your backend is not running correctly — do not proceed to the frontend installation until this is resolved.
+
+## Build and Run the Frontend
+
+Once you have verified the backend is returning JSON at the URL above, follow the [Front End Installation Guide](Front%20End%20Installation.md) to build and run the frontend.
## Install R
### Initial Steps
Click here [RProject](https://cloud.r-project.org/bin/macosx/)
- Install the latest ARM64 version for Apple silicon (if you have M1 or newer)
-- Execute the application when download finishes to complete the installation
-- Make sure it is getting placed in your Documents (C:\Users\Your Username\Documents\R\R-4.2.3)
-
-> Note:
-> The path above may not exist yet, as the folder has not yet been created
-> Your Username is your actual username
-
-- Next, create the R folder in Documents to match the variable value
-- Click Next all the way through
-- Download will result in R being placed in your Documents Folder
+- Execute the installer and follow the prompts
+- Verify installation:
+```bash
+R --version
+Rscript --version
+```
### Install R Packages
-- Add the following to the top of workspace/Semoss/R/SemossConfigR/scripts/Packages.R script (open in text editor),
+- Add the following to the top of `workspace/Semoss/R/SemossConfigR/scripts/Packages.R` (open in a text editor):
r = getOption("repos")
-r["CRAN"] = “https://cloud.r-project.org/”
+r["CRAN"] = "https://cloud.r-project.org/"
options(repos = r)
-- Edit line 190 to: httr::set_config( httr::config( ssl_verifypeer = 0L ) )
+- If you are on a restricted corporate network and package installs fail due to SSL inspection/proxying, fix your corporate cert/proxy configuration first. Only disable SSL verification if your security team explicitly approves it.
-- From the terminal, run the scripts
-
-cd /Users/brihill/Desktop/workspace/Semoss/R/SemossConfigR/scripts
+- From the terminal, run the scripts:
+```bash
+cd ~/Documents/SEMOSS/workspace/Semoss/R/SemossConfigR/scripts
Rscript Packages.R
Rscript Rserve.R
+```
## Install Python
-This uses the pyproject.toml file to install the necessary packages for the SEMOSSName Python environment. This setup is intended to be used with the [Astral UV](https://docs.astral.sh/uv/) platform.
+This uses the pyproject.toml file to install the necessary packages for the Python environment. This setup is intended to be used with the [Astral UV](https://docs.astral.sh/uv/) platform.
### Install uv
-Install [uv](https://docs.astral.sh/uv/getting-started/installation/) with brew
+Install [uv](https://docs.astral.sh/uv/getting-started/installation/) with Homebrew:
```
brew install uv
```
#### Install Python in uv
Once you have installed UV run
```
-uv python install 3.12.9 --default --preview
+uv python install 3.13 --default
```
-if you get an error run this instead
+If the download fails on a corporate network, this is usually because `uv` doesn't read the certificates your organization's proxy already installed in your system keychain. Try again with:
```
-uv python install 3.12.9 --default --preview --allow-insecure-host github.com
-```
+UV_NATIVE_TLS=1 uv python install 3.13 --default
+```
Check that python was installed by running
```
python --version
```
#### Create a virtual environment
-In your command line, go to `/py/install_config` and run:
+Assume your Semoss repo lives at:
+- `SEMOSS_HOME=~/Documents/SEMOSS/workspace/Semoss`
+
+In your command line, go to `~/Documents/SEMOSS/workspace/Semoss/py/install_config` and run:
```
-uv venv
+uv venv --python 3.13 .venv
```
Install the necessary packages depending on your system's capabilities
```
-uv pip install .[cpu]
+uv sync --extra cpu
```
OR if you have a GPU enabled system
```
-uv pip install .[gpu]
+uv sync --extra gpu
```
+> Note: If either command fails on a corporate network with a certificate error, prefix it with `UV_NATIVE_TLS=1` as above.
+
Verify the packages are installed
```
uv pip list
```
-Add the following to your .zshrc if you plan to run this specific python installation locally:
-```zsh
-export VIRTUAL_ENV="path/to/your/python/venv"
-export PATH="$VIRTUAL_ENV/bin:$PATH"
-```
-
-
-
-
-
### Adding new packages
-create the [virtual environment](#create-a-virtual-environment) (if not already created)
+Create the [virtual environment](#create-a-virtual-environment) (if not already created), then run these from `~/Documents/SEMOSS/workspace/Semoss/py/install_config`:
to add a package
```
@@ -462,15 +411,15 @@ uv pip list
```
### Test Python Installation
-- Open the Terminal and then type **py** and enter
-- It will open python terminal
-- Now try 2+2 and see if it gives the correct response of 4
+- In Terminal, run:
+```bash
+python
+```
+- In the Python REPL, run `2+2` and confirm it prints `4`.
### Update RDF_Map
-- Open workspace/Semoss/RDF_Map.prop
-- Edit Line 23: USE_PYTHON true
-- Edit Line starting with LD_LIBRARY_PATH:
- - For LD_LIBRARY_PATH, insert your Python Home directory where it says `“{{INPUT_YOUR_PYTHON_HOME}}”`
- - Remember to take out the braces (i.e. LD_LIBRARY_PATH must point to a valid path)
+- Open `workspace/Semoss/RDF_Map.prop`
+- Ensure `USE_PYTHON true` is enabled
+- Set `PYTHONHOME` to the full path of the virtual environment you just created, for example `/Users//Documents/SEMOSS/workspace/Semoss/py/install_config/.venv`
- 
+ 
\ No newline at end of file
diff --git a/docusaurus/docs/Advanced Installation/Troubleshooting.md b/docusaurus/docs/Advanced Installation/Troubleshooting.md
index 4846525..6b20e94 100644
--- a/docusaurus/docs/Advanced Installation/Troubleshooting.md
+++ b/docusaurus/docs/Advanced Installation/Troubleshooting.md
@@ -3,36 +3,29 @@ sidebar_label: 'Troubleshooting Tips'
sidebar_position: 7
---
+
import AppName, {WrapVariable} from "@site/src/components/CustomFields";
## Initial Install Troubleshooting
Check to see if this page loads http://localhost:9090/Monolith/api/config (should return JSON)
-- If JSON doesn’t load, the back end isn't deploying…
- - If the console in Eclipse says "database is in use / locked“…
- - In the bottom panel area, on the Servers tab, double-click your server (Tomcat v9.0 Server at localhost)
- - In the new window that appears, switch from Overview to Modules tab (at the bottom of the opened window)
- - Select the Monolith Web Module that appears in the table and click Edit on the right
- - Make sure the Path accurately reflects what you named your Monolith Folder and the case (E.g., “/Monolith”)
- - Uncheck auto reload
- - Click Save in Eclipse
+- If JSON doesn’t load, the back end isn't deploying…
+ - If the console in Eclipse says "database is in use / locked“…
+ - In the bottom panel area, on the Servers tab, double-click your server (Tomcat v11.0 Server at localhost)
+ - In the new window that appears, switch from Overview to Modules tab (at the bottom of the opened window)
+ - Select the Monolith Web Module that appears in the table and click Edit on the right
+ - Make sure the Path accurately reflects what you named your Monolith Folder and the case (E.g., “/Monolith”)
+ - Uncheck auto reload
+ - Click Save in Eclipse
- Right click on your server, Clean, and Republish
-- If JSON does load, the back end is deploying…
- - Navigate to the following path in your command prompt/terminal: C:/workspace/apache-tomcat 9.0.##/webapps/SemossWeb
- - In the terminal type in: “pnpm install”
- - Inside the same terminal type in: “pnpm run build” (may take ~10 min to run)
+- If JSON does load, the back end is deploying…
+ - Navigate to the following path in your command prompt/terminal: `C:/workspace/apache-tomcat-11.0.xx/webapps/SemossWeb` (replace `xx` with your Tomcat patch version)
+ - In the terminal type in: “pnpm install”
+ - Inside the same terminal type in: “pnpm build” (may take ~10 min to run)
- Once finished, refresh, and try accessing http://localhost:9090/SemossWeb/
-## BE Flow
-Process starts with the Start Server step. Once the server is initiated, the flow progresses to the Web.xml configuration, which is crucial for setting up web application parameters. Following this, the process moves to the RDF_MAP, which likely involves mapping data structures or resources. Finally, the flow concludes with Social Props, indicating a step related to social properties or settings. This sequence ensures a structured setup and configuration process.
-
-
-To reference the correct web.xml file in Eclipse, start by navigating to the server tab and double-clicking on your Tomcat server. Then, go to the "Modules" section, where you can see which BE files are currently deployed. For example, the vha-supply module is displayed in the list, helping you identify the specific deployment and its associated configuration files. This process ensures you are working with the correct web.xml for your application.
-
-
-
-## Regarding SEMOSSName Update
+## Regarding AI Core Update
> When to Update
- If you need a stable build >> wait till you are told to update
@@ -45,18 +38,18 @@ To reference the correct web.xml file in Eclipse, start by navigating to the ser
cd C:\workspace\Monolith
```
- Check if you have any local changes using `git status`. If you do have local changes, use the `git stash` command to save them.
-
+
Note that if you try to git pull without stashing your local changes, you will get a warning message:
-
+
- Confirm that you are on the 'dev' branch. If not, run `git switch dev` to switch branches.
- Run `git pull` to pull in the latest changes from the dev branch.
- You should see a list of the files which have been changed appear in the output. Scroll through the output and check if any files are named "pom.xml".
- 
+ 
- You may want to view these logs to know which specific files were changed in a revision, if a fix has come through for a bug you are tracking, or to see other changes in the build.
- If you wish to re-apply your local changes that you stashed earlier, run `git stash pop`
-
+
- Next, navigate to your Semoss folder (`cd C:\workspace\Semoss`) and repeat the above steps to pull the latest changes from the dev branch for the Semoss repo/folder.
-- Next, navigate to your SemossWeb folder inside of Tomcat\webapps (`cd C:\workspace\apache-tomcat-X.X.XX\webapps\SemossWeb`, replacing the X's with your Tomcat version number) and repeat the above steps to pull the latest changes from the dev branch for the front-end repo/folder.
+- Next, navigate to your SemossWeb folder inside of Tomcat\webapps (`cd C:\workspace\apache-tomcat-11.0.xx\webapps\SemossWeb`, replacing `xx` with your Tomcat patch version) and repeat the above steps to pull the latest changes from the dev branch for the front-end repo/folder.
- Start Eclipse
- Refresh each project in Eclipse
- If there were pom.xml changes, Select both "Monolith" and "Semoss" and right click one of them and hold cursor over "Maven" and click "Update Project"
@@ -70,96 +63,79 @@ Note that if you try to git pull without stashing your local changes, you will g
**Conflicts in updating files**
- Sometimes you will have conflicts when you update. Conflicts happen when you have modified **and staged** a file on your computer that someone else also modified.
- When this happens, the output of your `git stash pop` command may look like this:
-
+
Note that the paths of the conflicted files that need to be manually resolved are displayed in the output!
- To fix this, open a file which is conflicted in VSCode.
-- View each of the sections labeled `>>>>>> Incoming changes` and `>>>>>> Current changes`, and edit the file to select which changes you want.
-
- - If it is not a database file and you have not intentionally edited the file, use **Accept incoming change** in VSCode to override your local changes with the new changes from the Git repository.
- - If it is a database file, select **Accept current change** in VSCode to maintain your database values.
- - If you have intentionally edited the file, you can manually update the file to combine your changes with the incoming ones.
+ - View each of the sections labeled `>>>>>> Incoming changes` and `>>>>>> Current changes`, and edit the file to select which changes you want.
+
+ - If it is not a database file and you have not intentionally edited the file, use **Accept incoming change** in VSCode to override your local changes with the new changes from the Git repository.
+ - If it is a database file, select **Accept current change** in VSCode to maintain your database values.
+ - If you have intentionally edited the file, you can manually update the file to combine your changes with the incoming ones.
- Once you have resolved all the conflicts in the file, save the changes in your text editor (Hint: double check to make sure there are no leftover ">>>>>>" or "======" symbols in the file).
- Then, repeat this process for each conflicted file.
+## Database Connection is broken / connection timed out
+- If you see something like this when starting up semoss:
+```
+org.h2.jdbc.JdbcSQLNonTransientConnectionException: Connection is broken: "java.net.SocketTimeoutException: Connect timed out: 10.10.181.9:5356"
+```
+- The database connection is being routed over VPN as opposed to your localhost. To immediately fix this, disconnect from the VPN and restart your server. If you need to be on the VPN for your work/organization, add the following item to your Eclipse server run configurations:
+```
+-Dh2.bindAddress=127.0.0.1
+```
+
## Maven Dependency Issues
- If Tomcat publishing fails with errors related to “The system cannot find the [.m2] file specified”, double check that you do not have any pre-installed security applications causing a firewall issue with Maven
- You will need to uninstall any security applications like Symantec
- To fix this, contact your organization's IT department
- - Open a ticket with IT and request for Symantec to be suspended for an installation through maven/eclipse
- - Once the IT personnel confirms Symantec has been disabled, they may prompt you confirm by doing steps 3-4
- - Verify Symantec is disabled: click the up caret in the bottom right corner of your desktop (right side of task bar) to reveal background application. Double-click on the yellow cloud with a green shield on it (this shows you security status with Symantec)
- - Inspect if Symantec has been suspended; the IT personnel will usually give you a window of time it will be disabled, or they will ask you to message them back immediately when you no longer need it suspended. (This will depend on the IT staff)
-- Then in Eclipse, follow steps in slide 87, refresh your code, and clean your projects
+ - Open a ticket with IT and request for Symantec to be suspended for an installation through maven/eclipse
+ - Once the IT personnel confirms Symantec has been disabled, verify it and inspect the suspension status (see the next two steps)
+ - Verify Symantec is disabled: click the up caret in the bottom right corner of your desktop (right side of task bar) to reveal background application. Double-click on the yellow cloud with a green shield on it (this shows you security status with Symantec)
+ - Inspect if Symantec has been suspended; the IT personnel will usually give you a window of time it will be disabled, or they will ask you to message them back immediately when you no longer need it suspended. (This will depend on the IT staff)
+- Then in Eclipse, [update Maven, refresh your code, and clean your projects](#errors-in-eclipse-projects)
-
+
## If Maven doesn't download the dependencies correctly during your initial install
-- When you open the Problems view/tab (Window --> Show View --> Other --> Search Problems --> Select and Open), if any of the problems are categorized as ‘Maven Dependencies’ in the Type column (last column), then,
- - Download http://test.semoss.org/download/repository.zip
- - Close eclipse
- - Go to your .m2 folder in ‘C:\Users\USERNAME\.m2’
- - Delete the repository folder
- - Unzip the new repository folder in the zip you just downloaded in Step 1 and wait for it to finish
- - Make sure the repository folder is on the same level as the settings.xml file in the .m2 folder
- - Open eclipse
- - Select both Semoss and Monolith and right click --> Maven --> Update Project
- - Check Force Update
- - Press OK
- - Once this finishes, it should get rid of the ‘Maven Dependencies’ errors in the Problems tab
-
-
-
-
-
+- When you open the Problems view/tab (Window --> Show View --> Other --> Search Problems --> Select and Open), if any of the problems are categorized as ‘Maven Dependencies’ in the Type column (last column), then:
+ - Download http://test.semoss.org/download/repository.zip
+ - Close eclipse
+ - Go to your .m2 folder in ‘C:\Users\USERNAME\.m2’
+ - Delete the repository folder
+ - Unzip the new repository folder in the zip you just downloaded and wait for it to finish
+ - Make sure the repository folder is on the same level as the settings.xml file in the .m2 folder
+ - Open eclipse
+ - Select both Semoss and Monolith and right click --> Maven --> Update Project
+ - Check Force Update
+ - Press OK
+ - Once this finishes, it should get rid of the ‘Maven Dependencies’ errors in the Problems tab
+
+
+
+
+
## Errors in Eclipse projects
- Sometimes you will see a red ! or X on your Semoss or Monolith projects within eclipse. This means that there is an error somewhere in your code.
- Generally, this happens because the project needs to be refreshed or cleaned in eclipse. Try Updating Maven and cleaning your projects first.
-
-
-- After you update you should follow these steps within Eclipse in order to ensure your Semoss and Monolith projects are fully operational,
- - Update Maven
- - You usually only need to do this when the pom.xml is updated, which you can check during the [`git pull` update process](#regarding-ai-core-update).
- - Right click on your Semoss and Monolith projects in the left hand panel of Eclipse and click Maven Update Project
- - Refresh your code
- - Right click on your Semoss and Monolith projects in the left hand panel of Eclipse and click Refresh to do this before starting SEMOSSName
- - Clean your projects
- - From the top menu in Eclipse, select Project Clean. Then select all your projects to clean.
- - Clean the Tomcat working directory
- - From the Java window, navigate to the Servers tab in the bottom section. Right click on Tomcat Server and select Clean.
-
-- After you update you should follow these steps in order to ensure your front end changes take effect in Chrome
- - Empty Cache and Hard Reload: In Google Chrome, click F12. Then right click on the refresh button in the browser and select “Empty Cache and Hard Reload”
-
-## Environment Variables
-- If your projects still have errors, you may need to delete your pom.xml file (Semoss) and [update again by performing `git pull`](#regarding-ai-core-update).
-- If you run into an issue in Eclipse that says it cannot find Local Master or Security:
- - Turn off Server
- - Delete databaseNewMaster.mv.db (C:\workspace\Semoss\db\LocalMasterDatabase) or database.mv.db (..\workspace\Semoss\db\security)
- - [Update Semoss](#regarding-ai-core-update)
- - Restart Server
-
-## Eclipse won't open
-- If your Eclipse won’t open, it’s likely that your Java updated automatically by your organization's update policy.
-
-
+
-
+After you update you should follow these steps within Eclipse in order to ensure your Semoss and Monolith projects are fully operational:
+- **Update Maven** — You usually only need to do this when the pom.xml is updated, which you can check during the [`git pull` update process](#regarding-ai-core-update). Right click on your Semoss and Monolith projects in the left hand panel of Eclipse and click Maven > Update Project.
+- **Refresh your code** — Right click on your Semoss and Monolith projects in the left hand panel of Eclipse and click Refresh to do this before starting .
+- **Clean your projects** — From the top menu in Eclipse, select Project > Clean. Then select all your projects to clean.
+- **Clean the Tomcat working directory** — From the Java window, navigate to the Servers tab in the bottom section. Right click on Tomcat Server and select Clean.
-- To begin the fix, download the latest matching 64 bit JDK file from this website (http://www.oracle.com/technetwork/java/javase/downloads/index-jsp-138363.html)
- - Generally you want the Java SE 8uXXX version
-- Navigate to this path: C:\Programs Files\Java, and you should see a jdk and jre file
-- Click within the JDK file and copy the file path at the top (ex. C:\Program Files\Java\jdk1.8.0_131)
+After you update you should follow these steps in order to ensure your front end changes take effect in Chrome:
+- **Empty Cache and Hard Reload** — In Google Chrome, click F12. Then right click on the refresh button in the browser and select “Empty Cache and Hard Reload”.
-
-
-- Go to the start menu and type in “Edit the system environment variables”
-- Click “Environment Variables” at the bottom
-- In the bottom of the “System Variables” pane, look for JDK_HOME, JRE_HOME, and PATH—these are the variables that you will edit
-
-
-
-
+## Environment Variables
+- If your projects still have errors, you may need to delete your pom.xml file (Semoss) and [update again by performing `git pull`](#regarding-ai-core-update).
+- If you run into an issue in Eclipse that says it cannot find Local Master or Security:
+ - Turn off Server
+ - Delete databaseNewMaster.mv.db (C:\workspace\Semoss\db\LocalMasterDatabase) or database.mv.db (..\workspace\Semoss\db\security)
+ - [Update Semoss](#regarding-ai-core-update)
+ - Restart Server
## Server Startup Errors
### fileNames is null Error in Eclipse
@@ -197,83 +173,52 @@ Exception in thread "Thread-0" java.lang.NullPointerException: Cannot read the a
1. Confirm in the console that there are no more nulls for items being found
2. Check server-url/Monolith/api/config to confirm the backend is running
-## Java Errors
-- Error: Cannot find the class file for javax.crypto.SecreKey
-- Do the following to the Semoss build path:
- - Right click on Semoss
- - Under Build Path Select Configure Build Path
- - Click the Libraries tab
- - Select Add External JARs...
- - Add the jce.jar and the jsse.jar files located in your C:\Program Files\Java\jre1.8.0_281\lib
- - Apply
-
-
-
-
-
- - In the Order and Export tab make sure the JRE System library is at the top and the jce.jar and jsse.jar are directly below
- - Check the jce.jar and jsse.jar boxes so that Monolith will inherit
- - You may need to go through the Refresh steps
-
-
-
-
-
-- Edit JAVA_HOME variable with the path you copied before
-
-
-
-- Edit JRE_HOME with the path you copied before + \jre
-
-
-
-- Ensure the PATH variable uses your JAVA_HOME instead of being hardcoded
-- Ensure your pom.xml does not contain a hardcoded java path
-
## Adding New Databases
- The server should be off when adding new databases to Semoss
- Every database should also have a corresponding .smss file within the db folder.
- Copy and paste the folder and .smss file for the database into your Semoss/db folder
- Add the following line to the .smss file of the database you are adding if it is replacing one there before using the same name: RELOAD_INSIGHTS true
- If insights are not showing up after uploading a new database, try the following steps:
-- In Insight Cache folder (Semoss) delete all files that are not called CSV_Insights
-- Delete the databaseNewMaster.mv.db out of the Local Master Database folder and [update Semoss](#regarding-ai-core-update)
-- Go to Eclipse, clean the projects, run, and hard refresh in Chrome
+ - In Insight Cache folder (Semoss) delete all files that are not called CSV_Insights
+ - Delete the databaseNewMaster.mv.db out of the Local Master Database folder and [update Semoss](#regarding-ai-core-update)
+ - Go to Eclipse, clean the projects, run, and hard refresh in Chrome
## Other Helpful Tips
**Server Configuration**
-- If you are getting an error related to connection aborted, this is likely because your port is already in use. Your organization has started using/blocking port 8080, so you will need to perform the following steps to correct,
-
- server.xml
- - Open your Windows File Explorer and navigate to the following path: C:\workspace\apache-tomcat-9.0.30\conf
- - Right click on server.xml and Open With Notepad++
- - Find the line that says \)
-
-**Missing R Packages**
-- Open the R console
-- Run install.packages("pacman")
-- Run this script: https://github.com/SEMOSS/docker-r-packages/blob/R4.1.2-debian11/Packages.R
+![Tomcat Error]()
**Eclipse Network Problem**
- Disconnect from your organization's VPN
-- Reinstall Eclipse from [Eclipse](https://www.eclipse.org/downloads/packages/release/2020-06/r)
+- Reinstall Eclipse from [Eclipse](https://www.eclipse.org/downloads/packages)
-
+
**MVN not recognized as an internal or external command**
-- Run echo %PATH% in the cmd to find the maven path
+- Run echo %PATH% in the cmd to find the maven path
- Verify the path exists in your file explorer and matches the MVN environment variable
**PKIX Certs Errors in Eclipse**
@@ -315,18 +255,16 @@ Exception in thread "Thread-0" java.lang.NullPointerException: Cannot read the a
**If things go Wrong:**
- Here are a few important files to double check and make sure your paths are correct (http, port, and file paths):
- - RDF_MAP.prop (Semoss)
- - Web.xml (Monolith\WebContent\WEB-INF)
- - Config.js files in core, embed, and playsheet (SemossWeb)
- - Server.xml (Servers\Tomcat Server)
-
-- Check your Monolith Build Path (it’s Users\Your username\workspace\Semoss\src) and the folder name is “Semosssrc”)
-- If the path is incorrect, change it, click “Finish”. possible that the build path in Monolith pointing to Semoss has changed. To check this:
- - In Eclipse, right click on Monolith project and choose Build Path > Configure Build Path
- - Select Monolith/Semosssrc and choose “Edit” on the right-hand side
- - Make sure that the linked folder location is pointing to your Semoss src folder
- - If there are multiple Semosssrc links, remove all but the necessary one. Click “Finish”
- - Update, clean and refresh project
+ - RDF_MAP.prop (Semoss)
+ - Web.xml (Monolith\WebContent\WEB-INF)
+ - Config.js files in core, embed, and playsheet (SemossWeb)
+ - Server.xml (Servers\Tomcat Server)
+- Check your Monolith Build Path (it’s Users\Your username\workspace\Semoss\src) and the folder name is “Semosssrc”. If the path is incorrect:
+ - In Eclipse, right click on Monolith project and choose Build Path > Configure Build Path
+ - Select Monolith/Semosssrc and choose “Edit” on the right-hand side
+ - Make sure that the linked folder location is pointing to your Semoss src folder
+ - If there are multiple Semosssrc links, remove all but the necessary one. Click “Finish”
+ - Update, clean and refresh project
**Summary of If Things Go Wrong**
- Refresh your code
diff --git a/docusaurus/docs/Advanced Installation/Windows Developer Install.md b/docusaurus/docs/Advanced Installation/Windows Developer Install.md
index 9161430..c904fbd 100644
--- a/docusaurus/docs/Advanced Installation/Windows Developer Install.md
+++ b/docusaurus/docs/Advanced Installation/Windows Developer Install.md
@@ -6,92 +6,133 @@ slug: "/windows-developer-install"
import AppName, { DynamicCodeBlock } from "@site/src/components/CustomFields";
-Download softwares and tools from below links to be able to install Semoss.
+## AI Core Installation for Windows
+
+## What you’re installing
+This guide sets up the backend on Windows (Java + Maven projects running on Tomcat). When you are done, this URL should return JSON:
+```
+http://localhost:9090/Monolith/api/config
+```
+
+## Before you start
+- **Terminal**: on Windows, this guide uses either **Command Prompt** (`cmd`) or **PowerShell** (both are apps you can search for in the Start menu).
+- You will be downloading and unzipping several `.zip` files. To unzip: right-click the `.zip` file and choose **Extract All…**.
+- If you run into an error at any point, check the [Troubleshooting Tips](Troubleshooting%20Tips.md) guide before continuing.
+
## Create the workspace folder
The workspace folder is where all the code will sit.
-- Create a folder in your C drive called workspace. The path to this folder should look like this: ```C:\workspace```
+- Create a folder in your `C:` drive called `workspace`. The path to this folder should look like this: `C:\workspace`
+- Inside `C:\workspace`, create a `tools` folder (for downloads you unzip), so you have: `C:\workspace\tools`
+
+## Recommended editor
+We recommend using Visual Studio Code:
+- Download: https://code.visualstudio.com/Download
## Software Dependencies
-These are the pre-requisites to be able to install Semoss
+These are the prerequisites to be able to install .
-### Java JDK 21
+### Java JDK 25
-Click on [java21](https://www.azul.com/downloads/?version=java-21-lts&architecture=x86-64-bit&package=jdk-fx#zulu)
+> **Note:** This guide installs Java 25, which matches the latest version of . If you're setting up against an older, already-deployed instance, check with your team which version of they're on — for example, v5.x runs on Java 21 instead. Semoss version 6 is compatable with Java 21, the container is built using Java 25.
-Scroll down to Java 21 and click on Download next to Windows x86 64-bit
+Click on [Azul Zulu Builds of OpenJDK](https://www.azul.com/downloads/)
-Use the MSI installer
+Choose these filters:
+- Java Version: **Java 25**
+- Operating System: **Windows**
+- Architecture: **x86 64-bit**
+- Java Package: **JDK FX**
+
+Download the **.msi** installer and run it.
+
+After installing, open a new terminal and verify:
+```
+java -version
+```
### Eclipse IDE for Enterprise Java Developers
-Click on [Eclipse IDE](https://www.eclipse.org/downloads/packages/release/2025-06/r/eclipse-ide-enterprise-java-and-web-developers)
-- Select the link under ‘Download Links’ -> 
-- Windows 64-bit
-- Unzip this to Desktop or Default location
-
-### Apache Tomcat (v9)
-Click on [Apache Tomacat](https://tomcat.apache.org/download-90.cgi)
-- Choose Binary Distributions, Core, 64 bit Windows .zip file under the latest 9.0 section
-- Unzip the apache-tomcat folder into your workspace
-- The folder will most likely be named apache-tomcat-9.0.## (with ## being the version number!)
-
+Click on [Eclipse Download](https://www.eclipse.org/downloads/packages)
+- Find **Eclipse IDE for Enterprise Java and Web Developers** and select **Windows x86_64**
+- Select the link under ‘Download Links’ -> 
+- Unzip this anywhere you like (for example: `C:\\workspace\\tools\\eclipse`)
+
+### Apache Tomcat (v11)
+Click on [Apache Tomcat](https://tomcat.apache.org/download-11.cgi)
+- Choose Binary Distributions, Core, 64 bit Windows .zip file under the latest 11.0 section
+- Unzip the apache-tomcat folder into your workspace (`C:\workspace`)
+- The folder will most likely be named apache-tomcat-11.0.xx (with `xx` being your Tomcat patch version)
+
### Git
Download [Git](https://git-scm.com/downloads)
+After installing, open a new terminal and verify:
+```
+git --version
+```
### Notepad++
Choose [Notepad++ Installer](https://notepad-plus-plus.org/downloads/v7.8.2/)
> Note: Please download the 64-bit x64 installer version (not the zip file)
-### NVM and Node.js
-Click on [nvm-windows](https://github.com/coreybutler/nvm-windows/releases)
-- Download nvm-setup.zip from the assets table. Extract it and run the installation by clicking on the downloaded file.
-
-- To check whether NVM has been successfully installed,
- - Go to terminal
- - Type 'nvm -v' and hit enter
- - This should return the version of the NVM installed
-
-To install Node.js using NVM
-- Run `nvm install latest` in terminal
-- Run `nvm use latest` afterwards
-- Verify installation with `node -v` and `npm -v`
-- If 'npm -v' has an error, run Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
-
-
### Maven
Click on [Maven](https://maven.apache.org/download.cgi)
-- Click the download link beside Binary zip archive, and unzip this to your Documents folder
-
-- To check whether Maven has been successfully installed,
- - Go to terminal
- - Type 'mvn --version' and hit enter
- - This should return the version of the node installed
+- Click the download link beside Binary zip archive, and unzip this to your workspace (for example: `C:\\workspace\\tools`)
+- You will verify Maven after you set `MVN_HOME` and update your `Path` below
> **Note**
> Use Google Chrome for all downloads. Then you can quickly navigate to the downloads folder, right click, and Run as Administrator.
-### Visual Studio Code
-Download [from this link](https://code.visualstudio.com/Download)
+### Visual Studio Build Tools (C++ compiler)
+Some Python packages require a C++ compiler to install locally on Windows.
+- Download the Visual Studio Installer from: **https://visualstudio.microsoft.com/downloads/**
+ - Install the latest **Visual Studio Community** (or your organization's preferred edition), or **Build Tools for Visual Studio**
+- In the installer, select the **Desktop development with C++** workload (this provides the C++ toolchain)
+- Run the installer as Administrator if prompted
+
+## Environment Variables
+Set these before importing the projects into Eclipse.
+
+### Java (`JAVA_HOME`)
+- In Windows, from your start menu/search bar, navigate to your Control Panel > **System and Security** > System > Advanced system settings.
+- On the Systems Properties window that appears, select **Environment Variables**
+
+- Under system variables (bottom section), select **New...**
+ - For variable name, type **JAVA_HOME**
+ - For variable value, choose **Browse Directory**, go to Program Files, go to Java, and select the JDK folder (wherever you installed it)
+ - For example, **C:\Program Files\Zulu\zulu-25**
+
+### Maven (`MVN_HOME`)
+- Under system variables (bottom section), select **New...**
+ - For variable name, type **MVN_HOME**
+ - For variable value, choose **Browse Directory**, go to your workspace, and select the `apache-maven-#.#.#` folder you unzipped.
+ - For example, **C:\workspace\tools\apache-maven-#.#.#**
+
+### Update `Path`
+- Under system variables (bottom section), locate the **Path** variable, select it, and click Edit.
+- Add these entries if they do not exist:
+ - `%JAVA_HOME%\bin`
+ - `%MVN_HOME%\bin`
-### Visual Studio Installer
-- Download Microsoft Visual Studio Installer from this link: **https://visualstudio.microsoft.com/vs/older-downloads/**
- - We need to Install the 2022 latest community version
- - Visual Studio Installer is needed for a C++ compiler (many Python packages require this)
-- To install, find the installation file (likely in your Downloads folder), right click and **Run as administrator**. You’ll need to enter login credentials at least a few times during installation.
+### Verify
+Open a new terminal and verify:
+```
+java -version
+mvn --version
+```
## Clone Code Repos
### Clone Semoss Code
-1. Navigate to your workspace at `C:\workspace`
+1. Navigate to your workspace at `C:\workspace`
-2. Open a terminal (cmd, powershell) at this location
+2. Open a terminal (cmd, powershell) at this location
3. Run the command
```
git clone https://github.com/SEMOSS/Semoss.git
```
-4. Ensure you are on the `dev` branch by running
+4. Ensure you are on the `dev` branch by running
```
git status
```
@@ -99,64 +140,26 @@ within the Semoss folder
### Clone Monolith Code
-1. Navigate to your workspace at `C:\workspace`
+1. Navigate to your workspace at `C:\workspace`
-2. Open a terminal (cmd, powershell) at this location
+2. Open a terminal (cmd, powershell) at this location
3. Run the command
```
git clone https://github.com/SEMOSS/Monolith.git
```
-4. Ensure you are on the dev branch by running
+4. Ensure you are on the dev branch by running
```
git status
```
within the Monolith folder
-### Clone semoss-ui code
-
-1. Navigate to your Tomcat webapps folder
-
-Since we placed the tomcat folder in the workspace, the path is: `C:\workspace\apache-tomcat-9.0.##\webapps`
-
-2. Open terminal at this location and run the command
-```
-git clone https://github.com/SEMOSS/semoss-ui.git
-```
-
-3. Ensure you are on the dev branch by running
-```
-git status
-```
-within the semoss-ui folder
-
-4. Rename semoss-ui folder to `SemossWeb`
-
-5. In the SemossWeb folder create a new file named `.env.local`, and copy the following contents into that folder
-
-
-```
-ENDPOINT=../../..
-MODULE=/Monolith
-
-
-
-THEME_TITLE={SEMOSSName}
-THEME_FAVICON=./src/assets/favicon.svg
-
-
-NODE_ENV=development
-```
-
-Your SemossWeb folder should look like this
-
-
## Eclipse Setup
### Setup Eclipse Workspace Folder
Once your Eclipse & JDK are installed, open Eclipse and specify where you want your workspace to be
- Specify `C:\workspace` instead of the default name that shows up
- We recommend that you pin eclipse to your Taskbar and pin your workspace to your Quick Access Bar
-
+
### Import Semoss and Monolith into Eclipse
@@ -170,7 +173,7 @@ Once your Eclipse & JDK are installed, open Eclipse and specify where you want y
2) Check "Semoss"
3) Uncheck all others including "SemossWeb"
-
+
- At the bottom of the import window, click **Finish** to import your projects
@@ -179,20 +182,28 @@ Once your Eclipse & JDK are installed, open Eclipse and specify where you want y
- Now go to **General** and then go to **Project Explorer**
- Under the **Project Explorer** tab, right click on the **Monolith** project and select **Build Path >> Configure Build Path**
-
+
- Click on the **Source tab**, Select the **Monolith/src** folder and click **Edit**.
-
+
- Browse for the correct workspace location under **Linked folder location**: **C:\workspace\Semoss\src**
- Then, on the Source Folder screen update the Folder Name field to say: `Semosssrc`. Click **Finish** >> **Apply and Close**
- This may take a few minutes. Please allow the workspace to update.
-
+
## Setup Tomcat
+### Update `server.xml` (ports)
+If your organization blocks port `8080` or you already have something running there, update Tomcat to use `9090`.
+
+- Open `C:\workspace\apache-tomcat-11.0.xx\conf\server.xml` (replace `xx` with your Tomcat patch version)
+- Find the HTTP connector (look for ``) and change it to:
+ - `port="9090"`
+- If you later get a startup error about port `8005` being in use, change the Tomcat shutdown port from `8005` to another unused port (for example `8006`) in the same `server.xml`.
+
### Create a Tomcat Server
- In the top bar of Eclipse, click **Window -> Show View -> Other**
- Expand the Server drop-down, select **Servers**, and click **OK**
@@ -200,25 +211,27 @@ Once your Eclipse & JDK are installed, open Eclipse and specify where you want y
> **Note**
> If you cannot find or search for Servers in the Show View window, revisit which Java you downloaded at the beginning to ensure you have the IDE for Enterprise Java Developers.
-
+
- In the New Server window that appears, expand Apache, and select the version of the **Tomcat vX.X Server** you installed and click **Next**.
> **Note**
> You may need to expand the pop-up window to view the server options.
+>
+> If you do not see a Tomcat v11 server option, confirm you installed **Eclipse IDE for Enterprise Java and Web Developers** (WTP/server adapters), or install the Apache Tomcat server adapter in Eclipse.
- Expand Server, select Servers and click OK.
-
+
-- In the **Tomcat installation directory** field, enter (the location of your tomcat file): **C:\workspace\apache-tomcat-X.X.##** and click **NEXT**.
+- In the **Tomcat installation directory** field, enter (the location of your tomcat file): **C:\workspace\apache-tomcat-11.0.xx** and click **NEXT**.
-
+
- From the Add/Remove window that appears, under Available, select Monolith, click **Add** to move it to the configured side, then click the **Finish** button at the bottom. This window will then close.
-
+
-- Back in Eclipse, in the bottom panel area, on the Servers tab, double-click your new server (Tomcat v9.0 Server at localhost).
-
+- Back in Eclipse, in the bottom panel area, on the Servers tab, double-click your new server (Tomcat v11.0 Server at localhost).
+
- In the new window that appears, under Server Locations:
- Select “Use Tomcat installation”
@@ -227,36 +240,37 @@ Once your Eclipse & JDK are installed, open Eclipse and specify where you want y
- Under Timeouts, change start time to “900 seconds”
- Under Ports, ensure the HTTP/1.1 Port Number matches the port number you defined in your server.xml (likely 9090). Leave the other ports as is. Change admin port to 8105.
- Switch from Overview to Modules tab (at the bottom of the opened window)
-
+
- Select the Monolith Web Module that appears in the table and click Edit on the right
-
+
- Make sure the Path accurately reflects what you named your Monolith Folder
- E.g. “/Monolith”
- Click **Save** in Eclipse
-## Change Environment Variables
+## Configure Backend Files
### Update RDF Map for Semoss
- In the **Project Explorer** panel on the left, expand Semoss and scroll down to find File.
-
+
- Right click on **RDF_Map.prop** and Open With Notepad++ or double click and just open in Eclipse
-
+
--Make sure all references to the C drive (i.e. "C:\\...") are the correct file path.
+- Make sure all references to the C drive (i.e. "C:\\...") are the correct file path.
- Check that all of your paths begin with the path to your workspace. Either **C:\\workspace\\Semoss\\** or **C:\\\\workspace\\\\Semoss\\\\** will work. The last of these should occur on the line which starts with EMAIL_TEMPLATES. This will be around line 58.
-
+
- If you make any changes, save the file and close it.
### Update Catalina.properties
-- Open catalina.properties in eclipse or Notepad++. It is located in **C:\workspace\apache-tomcat-9.0.56\conf**, your Servers Tomcat folder.
-- Replace line 108 with the following: **tomcat.util.scan.StandardJarScanFilter.jarsToSkip=*.jar,\
-- Resave the file. This will improve the startup time of your server.
+- Open `catalina.properties` in Eclipse or Notepad++. It is located in **`C:\workspace\apache-tomcat-11.0.xx\conf`** (replace `xx` with your Tomcat patch version), in your Tomcat folder.
+- Optional: If Tomcat startup is slow, you can tune JAR scanning.
+ - Find `tomcat.util.scan.StandardJarScanFilter.jarsToSkip` and update it according to your team’s standard settings (avoid deleting the existing value unless you know why).
+ - Save the file and restart Tomcat.
-
+
### Update web.xml for Semoss
- Navigate to **C:\workspace\Monolith\WebContent\WEB-INF**
@@ -267,52 +281,7 @@ Once your Eclipse & JDK are installed, open Eclipse and specify where you want y
> **Note**
> Your exact line numbers may be off. Reference the image below and CTRL+F for **RDF** to find the correct lines.
-
-
-### General
-- In Windows, from your start menu/search bar, navigate to your Control Panel > **System and Security** > System > Advanced system settings.
-- On the Systems Properties window that appears, select **Environment Variables**
-
-- Under system variables (bottom section), select **New...**
- - For variable name, type **JAVA_HOME**
- - For variable value, choose **Browse Directory**, go to Program Files, go to Java, and select the jdk folder (wherever you downloaded/moved it to)
- - For example, **C:\Program Files\Zulu\zulu-21**
-
-> Note: Environment variables are case-sensitive
-
-- Click OK
-
-
-- Next, Under system variables (bottom section), locate the **Path** variable, select it, and click Edit
- - In the window that appears, click New
- - In the new row that appears, paste **%JAVA_HOME%\bin** without the quotation marks
- - Click OK
-
-> Note: Environment variables are case-sensitive
-
-
-
-- Keep these windows open for the next steps
-- Under system variables (bottom section), select **New...**
- - For variable name, type **MVN_HOME**
- - For variable value, choose **Browse Directory**, go to Documents, and select the apache-maven folder.
- - For example, **C:\Users\[your username]\Documents\apache-maven-#.#.#**
-
-> Note: Environment variables are case-sensitive
- - Click OK
-
-
-
-- Next, Under system variables (bottom section), locate the **Path** variable, select it, and click Edit
- - In the window that appears, click New
- - In the new row that appears, paste **%MVN_HOME%\bin** without the quotation marks
- - Click OK
-
- > Note: Environment variables are case-sensitive
-
-
-
-- Click Ok to close the window. Close out the remaining Systems Properties windows.
+
## Adding settings.xml to .m2 (maven) repository
- Navigate to **C:\Users\YOUR_USERNAME**
@@ -361,12 +330,12 @@ Set-Content -Path "$env:USERPROFILE\.m2\settings.xml" -Value $content -Encoding
- Go to **C:\Program Files\Symantec\WSS Agent**
- **If you do not have this folder on your PC, you may skip this section.**
- 
+ 
- Click the file path at the top, and copy it to your clipboard
- Click the Windows start button and type **CMD**. Select **Run as Administrator**. Note that you will need to provide your admin credentials
- 
+ 
- In the command prompt, type: cd
- Then type a space, a quotation mark: `'`**, right-click to paste the path, another quotation mark:**, and then hit Enter
@@ -374,7 +343,7 @@ Set-Content -Path "$env:USERPROFILE\.m2\settings.xml" -Value $content -Encoding
- Copy and paste (by right-clicking) the following line into the command prompt:
- `keytool -importcert -noprompt -trustcacerts -keystore **%JAVA_HOME%/jre/lib/security/cacerts** -file CertEmulationCA.crt -alias CertEmulationCA -storepass changeit`
- 
+ 
- Hit Enter
@@ -387,7 +356,7 @@ Set-Content -Path "$env:USERPROFILE\.m2\settings.xml" -Value $content -Encoding
### In Eclipse
- In Eclipse, ensure your Project Explorer panel is being displayed (typically on the left-hand side).
- If you don’t see the “Project Explorer” window, select **Window -> Show View -> Project Explorer** to show them.
-
+
- Update each project **(first do this for Semoss, then repeat for Monolith)**
- Right-click on the project in the project explorer panel
@@ -395,11 +364,11 @@ Set-Content -Path "$env:USERPROFILE\.m2\settings.xml" -Value $content -Encoding
- Place a checkmark in the “Force Update of Snapshots/Releases” box. Click Ok.
- The workspace will start updating and you can see the progress in the bottom right corner in Eclipse. This may take some time to build.**[click on the bottom right icon to see background progress]**
-
+
- If you get the following error while maven updating, just click ok and let the update proceed.
-
+
> **Note**
> - If you run into issues of Maven not downloading the dependencies, please see the Tips & Tricks section for downloading a new .m2 folder
@@ -410,49 +379,42 @@ To install Maven for Semoss/Monolith from the CLI, we need to navigate to each p
- In Eclipse, first for **Semoss project** and then **Monolith project**, do the following:
- Right-click the project in the project explorer. Choose **Show In > System Explorer**
-
+
- Double-click and open the project folder
- In the file explorer window, click the file path at the top, and simply type “cmd” and hit enter
- This will open a command prompt at this location
-
+
- Copy and right-click to paste the following line into the command prompt, and hit enter:
- mvn clean install -U -DskipTests=true
-
-
-## Install visual studio installer
-- Download Microsoft Visual Studio Installer from **[this link](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community&channel=Stable&version=VS18&source=VSLandingPage&cid=2500&passive=false)**
- - To install, find the installation file (likely in your Downloads folder), right click and **Run as administrator**. You’ll need to enter login credentials at least a few times during installation.
-- Under Windows, select user installer x64, and then click next through all the default options
-- Select ASP.NET and Python development then click install
+
## Run the Backend
-### Update Eclipse to Use Java 21
-- **Go to Preferences > Java > Installed JREs.**
-- **Add your new Java 21 JDK** if it’s not already listed.
-- Set Java 21 as the default JRE
- 
-- Click Apply and Close.
-- Allow SEMOSS to rebuild with the new JDK.
-- If your eclipse does not allow you to go up to java 21, then you must download the latest version of Eclipse.
-- On your project build paths, verify that you see **“JRE System Library [zulu-21].”**
- - If not, click **“Add Library…”** and add JRE System Library and choose Java 21. Do this for both Monolith and SEMOSS
-
-### Start Semoss Web
+### Update Eclipse to Use Java 25
+- **Go to Preferences > Java > Installed JREs.**
+- **Add your new Java 25 JDK** if it’s not already listed.
+- Set Java 25 as the default JRE
+ 
+- Click Apply and Close.
+- Allow SEMOSS to rebuild with the new JDK.
+- If your eclipse does not allow you to go up to java 25, then you must download the latest version of Eclipse.
+- On your project build paths, verify that you see **“JRE System Library [zulu-25].”**
+ - If not, click **“Add Library…”** and add JRE System Library and choose Java 25. Do this for both Monolith and SEMOSS
+
+### Start Tomcat (Monolith)
- Restart Eclipse (so that Eclipse loads the new Environment Variables we’ve added)
- Select the Monolith project and make sure under **Project -> Properties -> Java Build Path**, maintain the following order under **Order and Export** tab. You will likely need to select JRE System Library and click **Top** to move it to the top.
-
+
- Apache Tomcat should not be in [unbound] state. If so, then Select Apache to add to the classpath under Libraries tab.
- Once completed, click Apply and Close
- Within Eclipse, in the bottom Servers panel tab, right-click on the **Tomcat Server** and click **Publish**
- After republishing, double check your modules path to ensure it accurately reflects what you named your Monolith Folder and re-save
- E.g. “/Monolith” in the screenshot below
-
- - Double click on the server to open the Overview folder. Find the Port tab and next to the "Tomcat admin port", change the port number to 8105.
+
- Next, click **Start**
- A progress bar will appear at the bottom of Eclipse.
@@ -460,69 +422,27 @@ To install Maven for Semoss/Monolith from the CLI, we need to navigate to each p
> **Note**
> If you have run into any errors that might prevent your server from starting correctly, verify your server Web Module Path is /Monolith
-> To ensure the backend is running correctly,
- - Navigate to http://localhost:9090/Monolith/api/config
- - A json file should appear here
-
-> If there is error when you click on start due to Port 8005, please change it to 8006 or some other port
-- Now open terminal in Semoss folder and enter pnpm dev to run the front end if its not already running
-- Open Chrome and enter **http://localhost:9090/SemossWeb/packages/client/dist/#/login**
+> If there is an error when you click on start due to port `8005`, update the shutdown port in `server.xml` (see the `server.xml` section above).
+### Verify the Backend is Running
-## Build and run the Frontend
-### Build the Frontend
+Before proceeding, confirm your backend is working. Open a browser and navigate to:
-- Navigate to the following path in your command prompt/terminal:
-```
-C:/workspace/apache-tomcat 9.0.##/webapps/SemossWeb (this is your root directory)
-```
-- In the terminal type in:
-```
-npm install -g pnpm
-```
-- In the same terminal type in:
-```
-pnpm install
-```
-
-- Then, for these three paths: `libs/ui`, `libs/renderer`, `libs/sdk`, navigate to the paths in your command prompt/terminal and type the command
-```
-pnpm build
-```
-- Then, navigate to `packages/client` in your command prompt/terminal and type the command
```
-pnpm build
+http://localhost:9090/Monolith/api/config
```
-### Run the Frontend
+**You should see a JSON response.** If you do not get a JSON response, your backend is not running correctly — do not proceed to the frontend installation until this is resolved.
-Ensure your tomcat server is running in Eclipse (reminder that http://localhost:9090/Monolith/api/config will have text if the backend is running correctly)
-
-> Navigate to http://localhost:9090/SemossWeb/
- - If all everything is working properly this should redirect you to a set admin page
- - Type in the username you want to register with
-
-> Then go back to http://localhost:9090/SemossWeb/ , and at the bottom of the page, hit register new user.
- - Fill out the required fields
- - Make sure the username you register is the same as the one typed into the admin page
-
-> Once the new user is registered, you can sign in using the same information.
-
-- Congratulations! You’re all set to start using SEMOSSName!
-
-
-> To ensure the backend is running correctly,
- - Navigate to http://localhost:9090/Monolith/api/config
- - A json file should appear here
+## Build and Run the Frontend
-> If there is error when you click on start due to Port 8005, please change it to 8006 or some other port
-- Now open terminal in Semoss folder and enter pnpm dev to run the front end if its not already running
-- Open Chrome and enter **http://localhost:9090/SemossWeb/packages/client/dist/#/login**
+Once you have verified the backend is returning JSON at the URL above, follow the [Front End Installation Guide](Front%20End%20Installation.md) to build and run the frontend.
## Install Python
-This uses the `pyproject.toml` file to install the necessary packages for the SEMOSSName Python environment. This setup is intended to be used with the [Astral UV](https://docs.astral.sh/uv/) platform.
+
+This uses the `pyproject.toml` file to install the necessary packages for the Python environment. This setup is intended to be used with the [Astral UV](https://docs.astral.sh/uv/) platform.
### Install uv
Within your command prompt, install [uv](https://docs.astral.sh/uv/getting-started/installation/) with the powershell command:
@@ -532,33 +452,35 @@ powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | ie
#### Install Python in uv
Once you have installed UV run
```
-uv python install 3.12.9 --default --preview
+uv python install 3.13 --default
```
-If you get an error run this instead
+If the download fails on a corporate network, this is usually because `uv` doesn't read the certificates your organization's proxy already installed in your system's certificate store. Try again with:
```
-uv python install 3.12.9 --default --preview --allow-insecure-host github.com
-```
+uv python install 3.13 --default --native-tls
+```
Check that python was installed by running
```
python --version
```
-Afterwards, feel free to test by running `python` to open the Python 3.12.9 Shell. Type in `2+2` and see if it returns the correct response of 4.
+Afterwards, feel free to test by running `python` to open the Python 3.13 Shell. Type in `2+2` and see if it returns the correct response of 4.
#### Create a virtual environment
-In your command line, go to `/py/install_config` and run:
+In your command line, go to `C:\\workspace\\Semoss\\py\\install_config` (this is your `SEMOSS_HOME`) and run:
```
-uv venv
+uv venv --python 3.13 .venv
```
Install the necessary packages depending on your system's capabilities
```
-uv pip install .[cpu]
+uv sync --extra cpu
```
OR if you have a GPU enabled system
```
-uv pip install .[gpu]
+uv sync --extra gpu
```
+> Note: If either command fails on a corporate network with a certificate error, add `--native-tls` as above.
+
Verify the packages are installed
```
uv pip list
@@ -573,6 +495,7 @@ TCP_WORKER prerna.tcp.SocketServer
TCP_CLIENT prerna.tcp.client.NativePySocketClient
NATIVE_PY_SERVER true
```
+Make sure `python.exe` exists under the `PYTHONHOME` path above.
Additionally make sure the following are also enabled, they are just below above lines:
```
USE_PYTHON true
@@ -604,7 +527,7 @@ Add Python to your system environment variables, this environment will be used f
- On your machine, search up "Edit your system variables", click on **Environment variables**, under System variables, click on **Path** and click **Edit**
- Add the path to your virtual environment: `C:\workspace\Semoss\py\install_config\.venv\Scripts` and move it to the top of the list. Click OK once done
-
+
## (OPTIONAL) Install R
- Navigate to this website: **https://cran.r-project.org/bin/windows/base/old/4.2.3/**
@@ -614,7 +537,7 @@ Add Python to your system environment variables, this environment will be used f
- Next, create the R folder in Documents to match the variable value.
- Click next all the way through
-
+
- Download will result in R being placed in your Documents Folder
@@ -637,12 +560,12 @@ Add Python to your system environment variables, this environment will be used f
- Variable value: **C:\Users\YOUR_USERNAME\Documents\R\R-4.2.3**
- Create new/edit your R_LIBS variable
- Variable Name: R_LIBS
- - Variable Value: **C:\Users\YOUR_USERNAME\Documents\R\win-library\4.1**
+ - Variable Value: **C:\Users\YOUR_USERNAME\Documents\R\win-library\4.2**
- Change out YOUR_USERNAME with your actual username **(Note that the path above may not exist yet, as the folder has not yet been created. Create this folder to match the variable value. Change the red text to your user name.)**
> Note: Environment variables are case-sensitive
-
+
- Edit your Path variable under System variables. Add the following:
- %R_HOME%\bin
@@ -662,7 +585,7 @@ Add Python to your system environment variables, this environment will be used f
> This process will take a while to finish
> Only copy paste small sections of the script to run at a time (~30 lines chunk)
-
+
**Testing to See if rJava is installed properly**
@@ -675,7 +598,3 @@ s <- .jnew("java/lang/String", "Hello World")
.jcall(s, "I", "length")
```
-This should return 11 and this means that rJava is working
-
-
-
diff --git a/docusaurus/docs/Integrating with SEMOSS/Packages and Pre-requisites.md b/docusaurus/docs/Integrating with SEMOSS/Packages and Pre-requisites.md
index 3e7f7bb..d0ada45 100644
--- a/docusaurus/docs/Integrating with SEMOSS/Packages and Pre-requisites.md
+++ b/docusaurus/docs/Integrating with SEMOSS/Packages and Pre-requisites.md
@@ -5,11 +5,11 @@ slug: "/prerequisites"
---
import AppName from "@site/src/components/CustomFields";
-# Packages and Prerequisites for SEMOSSName Apps
+# Packages and Prerequisites for AI Core Apps
## Overview
-In this section we will go through what front end and back end packages are necessary for most SEMOSSName apps.
+In this section we will go through what front end and back end packages are necessary for most apps.
## Front End Prerequisities
@@ -44,7 +44,7 @@ To do so open a terminal and install it using:
#### Installing the SEMOSS SDK
-The SEMOSS SDK includes software-building tools for a connecting SEMOSSName to a custom React app. To use the SDK, ensure you have node, node package manager, and code editor installed.
+The SEMOSS SDK includes software-building tools for a connecting to a custom React app. To use the SDK, ensure you have node, node package manager, and code editor installed.
Use PNPM/NPM to install the following packages and add them to your project.
@@ -58,43 +58,41 @@ For a deep dive into the directory structure of your project, see the [React App
### Optional: Fully Local Front End Installation
-You **do NOT need a fully local front end installation** to build apps that run on SEMOSSName.
+You **do NOT need a fully local front end installation** to build apps that run on .
-However, if you wish to contribute to the SEMOSSName project or want visibility into the front end source code, please follow this guide: [Frontend Local Installation Guide](../../Advanced%20Installation/Frontend%20Installation.md)
+However, if you wish to contribute to the project or want visibility into the front end source code, please follow this guide: [Front End Installation Guide](../../Advanced%20Installation/Front%20End%20Installation.md)
## Back End Prerequisities
-Please Note that these are only necessary if you are planning on running a local back end. The majority of projects do not need to do so. Please refer to the [Docker BE Install Guide](../../Advanced%20Installation/Docker%20BE%20Install%20Guide.md) to see if you need to go through a back end installation.
+Please Note that these are only necessary if you are planning on running a local back end. The majority of projects do not need to do so. Please refer to the [Docker Back End Installation guide](../../Advanced%20Installation/Docker%20Back%20End%20Installation.md) to see if you need to go through a back end installation.
### Back End Setup Overview
-Though it is possible to develop apps solely with front end frameworks, SEMOSSName allows you to incorporate custom back end logic using **Java** and **Python**. To get started with custom back end development, follow the [Java Setup](#java-setup) and [Python Setup](#python-setup) sections below.
+Though it is possible to develop apps solely with front end frameworks, allows you to incorporate custom back end logic using **Java** and **Python**. To get started with custom back end development, follow the [Java Setup](#java-setup) and [Python Setup](#python-setup) sections below.
**Optional - Web Server vs. Local Instance: Which should I choose?**
-Next, choose whether you want to connect with the **web version** of SEMOSSName, or if you want to run a **local instance** of SEMOSSName instead.
-Note that the primary way that most users will interact with the SEMOSSName back end is through its **[live web server](https://MonoLithURL/SemossWeb/packages/client/dist/#/)**. If you followed the previous section on [generating access and secret keys](./ConnectingToAI.md#generating-access-and-secret-keys), then you already can access this web server.
+Next, choose whether you want to connect with the **web version** of , or if you want to run a **local instance** of instead.
+Note that the primary way that most users will interact with the back end is through its **[live web server](https://workshop.cfg.deloitte.com/cfg-ai-demo/SemossWeb/packages/client/dist/#/)**. If you followed the previous section on [generating access and secret keys](./Connecting%20to%20CFG%20AI.md#generating-access-and-secret-keys), then you already can access this web server.
-However, if you wish to have **admin privileges** or **greater control of an SEMOSSName instance**, you can choose to run the SEMOSSName server locally. SEMOSSName provides two methods to run a SEMOSSName instance locally, which are:
+However, if you wish to have **admin privileges** or **greater control of an instance**, you can choose to run the server locally. provides two methods to run a instance locally, which are:
1. [Docker Container](#optional-starting-the-dockerized-back-end)
2. [Fully Local Installation](#optional-fully-local-back-end-installation)
### Java Setup
-#### Java SE Development Kit 8u831 (JDK8) Download
+#### Java Development Kit 25 (JDK 25) Download
-> **Important** > _Please note that the specific edition of Java that SEMOSSName requires is **Java SE Development Kit 8u381**. You MUST use this version of Java SE._
+> **Important**
+> Use **JDK 25** for local back end development. Semoss version 6 is compatable with Java 21, the container is built using Java 25.
-If you already have **Java SE Development Kit 8u831 (JDK8)** installed, skip to the next section: **[`JAVA_HOME` Environment Variable](#java_home-environment-variable)**.
+If you already have **JDK 25** installed, skip to the next section: **[`JAVA_HOME` Environment Variable](#java_home-environment-variable)**.
-1. Click on the following link to access the Java downloads page: [Java SE Development Kit (JDK8)](https://www.oracle.com/java/technologies/downloads/#java8)
-2. Scroll down to find **‘Java SE Development Kit 8u381’** and select the download that matches your computer's **OS and bit version.**
-3. Accept License Agreement and download
- - You will need to create an Oracle account using your email address
-4. Open up the file once it has finished downloading
-5. Select next, next, next, all the way through;
- - By default, the installer will place Java into your `C:\Program Files` directory
+1. Download a JDK from [Azul Zulu Builds of OpenJDK](https://www.azul.com/downloads/) (or your organization's preferred JDK distribution).
+2. Select **Java 25**, then download the build that matches your OS and architecture.
+3. Install the JDK.
+ - On Windows, the installer typically places Java under `C:\Program Files\Java`.
#### `JAVA_HOME` Environment Variable
@@ -112,8 +110,8 @@ If you already have **Java SE Development Kit 8u831 (JDK8)** installed, skip to
If you already have **Apache Maven** installed, skip to the next section: **[`MVN_HOME` Environment Variable](#mvn_home-environment-variable)** .
-1. Click on the following link to access the Maven downloads page: [Maven](https://maven.apache.org/download.cgi)
-2. Click the download link beside **Binary zip archive**, and unzip this to your `Documents` folder
+1. Click on the following link to access the Maven downloads page: [Maven](https://maven.apache.org/download.cgi)
+2. Click the download link beside **Binary zip archive**, and unzip this to your `Documents` folder
#### `MVN_HOME` Environment Variable
@@ -160,9 +158,9 @@ If you already have **Python 3.9+** installed, skip to the next section: **[`PYT
8. Click OK, the OK again to save the System Environment variables.
9. If you had any open IDEs or processes that use the `PATH` or `PYTHONHOME` variables, you will need to stop those processes and **restart them** to pull in the new paths.
-#### Python Packages Available within SEMOSS
+#### Python Packages Available within AI Core
-SEMOSSName currently comes bundled with the packages in the below list.
+ currently comes bundled with the packages in the below list.
You can choose to install the relevant packages for your project from the below list by running the following command:
`pip install PACKAGE_NAME==VERSION_NUMBER`
@@ -188,7 +186,7 @@ where `PACKAGE_NAME` and `VERSION_NUMBER` are replaced with the actual name and
After installing the packages, you can view where they are installed by navigating to the `Lib` folder within your `PYTHON_HOME` directory (ex: `C:\Users\YOUR_USERNAME\AppData\Local\Programs\Python\Python310\Lib`).
-If the following packages are not satisfactory for your application, then please email [support-email](mailto:support-email) for support with additional packages.
+If the following packages are not satisfactory for your application, then please email globalaicoreplatform@deloitte.com for support with additional packages.
```
accelerate==0.25.0
@@ -512,12 +510,14 @@ const hello = (name) => {
### Optional: Starting the Dockerized Back End
-For users who wish to have **admin privileges** or want to host a **private instance** of SEMOSSName, SEMOSSName has made it possible for users to run SEMOSSName locally by packaging its back end into a **Docker image**. The Docker image allows users to quickly start running SEMOSSName inside of a container. To run the back end, please follow this guide: [Docker BE Install Guide](../../Advanced%20Installation/Docker%20BE%20Install%20Guide.md)
+For users who wish to have **admin privileges** or want to host a **private instance** of , has made it possible for users to run locally by packaging its back end into a **Docker image**. The Docker image allows users to quickly start running inside of a container. To run the back end, please follow this guide: [Docker Back End Installation](../../Advanced%20Installation/Docker%20Back%20End%20Installation.md)
-If you need **even greater control** over SEMOSSName, including the ability to directly modify core SEMOSSName source code or to bring your own dependencies, please follow the instructions in the next section (Optional: Fully Local Back End Installation).
+If you need **even greater control** over , including the ability to directly modify core source code or to bring your own dependencies, please follow the instructions in the next section (Optional: Fully Local Back End Installation).
### Optional: Fully Local Back End Installation
-You **do NOT need to do a full local installation** in order to run SEMOSSName locally. For most users, it is sufficient to simply download **Java** and **Python**, and then run the back end in a **Docker container** as noted in the previous section.
+You **do NOT need to do a full local installation** in order to run locally. For most users, it is sufficient to simply download **Java** and **Python**, and then run the back end in a **Docker container** as noted in the previous section.
-However, if you wish to **contribute to the SEMOSSName project** or want **visibility into the back end source code**, please follow the instructions in this guide: [Local BE Install Guide](../../Advanced%20Installation/Local%20BE%20Install%20Guide.md).
+However, if you wish to **contribute to the project** or want **visibility into the back end source code**, please follow the appropriate guide for your OS:
+- [Windows Back End Installation](../../Advanced%20Installation/Windows%20Back%20End%20Installation.md)
+- [Mac Back End Installation](../../Advanced%20Installation/Mac%20Back%20End%20Installation.md)
\ No newline at end of file
diff --git a/docusaurus/package.json b/docusaurus/package.json
index a3910a1..fca6562 100644
--- a/docusaurus/package.json
+++ b/docusaurus/package.json
@@ -26,7 +26,6 @@
"@easyops-cn/docusaurus-search-local": "^0.48.5",
"@fontsource/inter": "^5.2.8",
"@mdx-js/react": "^3.1.1",
- "@types/postman-collection": "^3.5.11",
"clsx": "^1.2.1",
"docusaurus-plugin-openapi-docs": "^4.7.1",
"docusaurus-plugin-reactor-docgen": "workspace:*",
@@ -35,8 +34,6 @@
"html2canvas": "^1.4.1",
"js-yaml": "^4.1.1",
"jspdf": "^3.0.4",
- "postman-code-generators": "^2.1.1",
- "postman-collection": "^5.3.0",
"prism-react-renderer": "^2.4.1",
"react": "^18.3.1",
"react-dom": "^18.3.1",
diff --git a/docusaurus/scripts/output/cookbook-recipes.json b/docusaurus/scripts/output/cookbook-recipes.json
index af5c3b6..a7ce1d5 100644
--- a/docusaurus/scripts/output/cookbook-recipes.json
+++ b/docusaurus/scripts/output/cookbook-recipes.json
@@ -2,7 +2,7 @@
{
"title": "Award Generator",
"size": 2764,
- "lastModified": "2026-04-22T18:58:27.242Z",
+ "lastModified": "2026-09-08T17:15:12.379Z",
"isDirectory": false,
"description": "This Award Generator app uses advanced LLMs to automate personalized award citation creation, allowing users to select models, award types, and input candidate details to generate high-quality, consistent recognition text easily",
"difficulty": "",
@@ -17,7 +17,7 @@
{
"title": "Code Modifier",
"size": 8168,
- "lastModified": "2026-04-22T18:58:27.247Z",
+ "lastModified": "2026-09-08T17:15:12.380Z",
"isDirectory": false,
"description": "A no/low-code app named Code Modifier, which uses AI to transform code snippets based on user instructions and selected programming languages, by offering instant modified code with a simple drag-and-drop UI",
"difficulty": "",
@@ -33,7 +33,7 @@
{
"title": "Creating a Vector Database",
"size": 6641,
- "lastModified": "2026-04-22T18:58:27.252Z",
+ "lastModified": "2026-09-08T17:15:12.383Z",
"isDirectory": false,
"description": "A step-by-step instructions for setting up a vector database engine in the AI Core platform, including sample code in JavaScript, Python, and Java for creating and connecting vector databases tailored for AI applications",
"difficulty": "",
@@ -49,7 +49,7 @@
{
"title": "Frames",
"size": 8141,
- "lastModified": "2026-04-22T18:58:27.257Z",
+ "lastModified": "2026-09-08T17:15:12.385Z",
"isDirectory": false,
"description": "The document explains how to use SEMOSS Frames to import, manage, and change the format of datasets within dashboards, using frame types like GRID, PY, R, and GRAPH for flexible data analysis and visualization. It includes step-by-step instructions for creating, updating, and transforming frames using UI actions and command-line pixels",
"difficulty": "",
@@ -65,7 +65,7 @@
{
"title": "Guide for Building a JavaScript App (Node.js)",
"size": 16403,
- "lastModified": "2026-04-27T17:41:07.703Z",
+ "lastModified": "2026-09-08T17:15:12.389Z",
"isDirectory": false,
"description": "This recipe demonstrates building a GenAI application using React on the AI Core platform. It covers project setup, app structure, front-end architecture, SDK integration, local development with Webpack, bundling, and deploying the app into the AI Core App Catalog.",
"difficulty": "",
@@ -82,7 +82,7 @@
{
"title": "Pixel MCP",
"size": 4506,
- "lastModified": "2026-04-22T18:58:27.266Z",
+ "lastModified": "2026-09-08T17:15:12.390Z",
"isDirectory": false,
"description": "This recipe explains how to convert a Pro Code app into a Model Context Protocol (MCP) using the MakePixelMCP reactor. It covers MCP concepts, setup, reactor configuration, execution modes, and generating the pixel_mcp.json manifest for AI Core integration.",
"difficulty": "",
@@ -98,7 +98,7 @@
{
"title": "Policy Bot",
"size": 5324,
- "lastModified": "2026-04-27T17:41:07.705Z",
+ "lastModified": "2026-09-08T17:15:12.394Z",
"isDirectory": false,
"description": "This \"Policy Bot\" app using the React framework and AI Core, enabling automated policy Q&A apps that answer user questions using company documents and LLMs. It covers setup and usage with examples in a Pro-Code Workflow.",
"difficulty": "",
@@ -114,7 +114,7 @@
{
"title": "Python MCP",
"size": 10968,
- "lastModified": "2026-04-22T18:58:27.274Z",
+ "lastModified": "2026-09-08T17:15:12.398Z",
"isDirectory": false,
"description": "This recipe walks through building a Model Context Protocol (MCP) tool in Python for AI Core. It covers writing MCP-enabled Python functions, using execution decorators, generating the mcp.json manifest, and deploying and testing MCP tools within the platform.",
"difficulty": "",
@@ -130,7 +130,7 @@
{
"title": "RAG MCP",
"size": 4782,
- "lastModified": "2026-04-22T18:58:27.278Z",
+ "lastModified": "2026-09-08T17:15:12.399Z",
"isDirectory": false,
"description": "",
"difficulty": "",
@@ -141,7 +141,7 @@
{
"title": "RAG",
"size": 8619,
- "lastModified": "2026-04-22T18:58:27.281Z",
+ "lastModified": "2026-09-08T17:15:12.401Z",
"isDirectory": false,
"description": "This recipe details building an Agent Builder app with Retrieval Augmented Generation (RAG) in AI Core, integrating vector databases to ground LLM answers in enterprise documents for precise, context-aware Q&A.",
"difficulty": "",
@@ -156,7 +156,7 @@
{
"title": "RegressionTestingUsingToPDF",
"size": 4830,
- "lastModified": "2026-04-17T19:40:33.864Z",
+ "lastModified": "2026-09-08T17:15:12.402Z",
"isDirectory": false,
"description": "The Regression testing using ToPDF does automated visual regression testing for dashboards with ToPDF reactor, which snapshots dashboards as PDFs before and after upgrades for comparison. It describes parameters, workflow steps, HTML templates, and automation tips for reliable UI validation",
"difficulty": "",
@@ -171,7 +171,7 @@
{
"title": "Simple Model Interaction",
"size": 16726,
- "lastModified": "2026-04-27T17:41:07.708Z",
+ "lastModified": "2026-09-08T17:15:12.404Z",
"isDirectory": false,
"description": "This document guides users through interacting with AI Core models, showing how to send prompts and receive responses using unique model IDs in both code and notebook environments. It includes code examples and workflows for integrating various LLMs into applications for text generation, and various tasks.",
"difficulty": "",
@@ -187,7 +187,7 @@
{
"title": "Streamlit App Quickstart Guide",
"size": 10810,
- "lastModified": "2026-04-22T18:58:27.289Z",
+ "lastModified": "2026-09-08T17:15:12.407Z",
"isDirectory": false,
"description": "To build a GenAI app with Streamlit, outlining how to integrate AI Core resources and models for local prototyping and data science workflows. It covers setup, authentication, adapting Python code to use AI Core, and provides practical guidance for connecting Streamlit to enterprise AI infrastructure.",
"difficulty": "",
@@ -202,7 +202,7 @@
{
"title": "VanillaJS App Quickstart Guide",
"size": 5992,
- "lastModified": "2026-04-22T18:58:27.293Z",
+ "lastModified": "2026-09-08T17:15:12.410Z",
"isDirectory": false,
"description": "This guide demonstrates how to rapidly build a GenAI app with VanillaJS on the SEMOSS platform, covering setup, AI Core integration, and calling LLMs for natural language or code generation. Designed for beginners, it details app structure, feature integration, and deployment essentials using plain JavaScript.",
"difficulty": "",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index bbfc5c6..f97c96d 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -23,9 +23,6 @@ importers:
'@mdx-js/react':
specifier: ^3.1.1
version: 3.1.1(@types/react@19.2.14)(react@18.3.1)
- '@types/postman-collection':
- specifier: ^3.5.11
- version: 3.5.11
clsx:
specifier: ^1.2.1
version: 1.2.1
@@ -50,12 +47,6 @@ importers:
jspdf:
specifier: ^3.0.4
version: 3.0.4
- postman-code-generators:
- specifier: ^2.1.1
- version: 2.1.1
- postman-collection:
- specifier: ^5.3.0
- version: 5.3.0
prism-react-renderer:
specifier: ^2.4.1
version: 2.4.1(react@18.3.1)
@@ -2068,9 +2059,6 @@ packages:
'@types/pako@2.0.4':
resolution: {integrity: sha512-VWDCbrLeVXJM9fihYodcLiIv0ku+AlOa/TQ1SvYOaBuyrSKgEcro95LJyIsJ4vSo6BXIxOKxiJAat04CmST9Fw==}
- '@types/postman-collection@3.5.11':
- resolution: {integrity: sha512-BZgBJDdX6jyy9hzSTIMRhCsxhF0IlzPr1i98q2wdkDo8rZrbNoBvs+3/Vw+LOIIAFH1G+FyXo5Fjf8qbawGeHg==}
-
'@types/prismjs@1.26.6':
resolution: {integrity: sha512-vqlvI7qlMvcCBbVe0AKAb4f97//Hy0EBTaiW8AalRnG/xAN5zOiWWyrNqNXeq8+KAuvRewjCVY1+IPxk4RdNYw==}
@@ -2139,6 +2127,7 @@ packages:
'@ungap/structured-clone@1.3.0':
resolution: {integrity: sha512-WmoN8qaIAo7WTYWbAZuG8PYEhn5fkz7dZrqTBZ7dtt//lL2Gwms1IcnQ5yHqjDfX8Ft5j4YzDM23f87zBfDe9g==}
+ deprecated: Potential CWE-502 - Update to 1.3.1 or higher
'@webassemblyjs/ast@1.14.1':
resolution: {integrity: sha512-nuBEDgQfm1ccRp/8bCQrx1frohyufl4JlbMMZ4P1wpeOfDhF6FQkxZJ1b/e+PLwr6X1Nhw6OLme5usuBWYBvuQ==}
@@ -2744,6 +2733,7 @@ packages:
crypto-js@4.2.0:
resolution: {integrity: sha512-KALDyEYgpY+Rlob/iriUtjV6d5Eq+Y191A5g4UqLAi8CyGP9N1+FdVbkc1SxKc2r4YAYqG8JzO2KGL+AizD70Q==}
+ deprecated: Active development of CryptoJS has been discontinued. This library is no longer maintained.
crypto-random-string@4.0.0:
resolution: {integrity: sha512-x8dy3RnvYdlUcPOjkEHqozhiwzKNSq7GcPuXFbnyMOCHxX8V3OgIg/pYuabl2sbUPfIJaeAQB7PMOK8DFIdoRA==}
@@ -6021,6 +6011,7 @@ packages:
uuid@8.3.2:
resolution: {integrity: sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==}
+ deprecated: uuid@10 and below is no longer supported. For ESM codebases, update to uuid@latest. For CommonJS codebases, use uuid@11 (but be aware this version will likely be deprecated in 2028).
hasBin: true
validate.io-array@1.0.6:
@@ -9058,10 +9049,6 @@ snapshots:
'@types/pako@2.0.4': {}
- '@types/postman-collection@3.5.11':
- dependencies:
- '@types/node': 24.12.2
-
'@types/prismjs@1.26.6': {}
'@types/qs@6.15.0': {}