From af653f2eea08c761b2a7c819c4efc6a3bca2ace2 Mon Sep 17 00:00:00 2001 From: JeffMboya Date: Tue, 8 Oct 2024 15:20:23 +0300 Subject: [PATCH 01/13] Enhance user creation and login docs Signed-off-by: JeffMboya --- docs/getting-started.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index db3965f..1b2cf59 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,22 +1,29 @@ # Getting Started -Connect to Cube AI deployed instance on port `:6193`. Login with your username and password. If you can't log in ask the instance administrator to create a new user. +Before logging in or interacting with Cube AI, you need to make sure that Cube AI has been deployed and is running. Deployment can be done by the instance administrator or by you if you have the necessary access permissions. + +### Steps to Connect + +1. Ensure that Cube AI is deployed and running on your instance. +2. Connect to the deployed Cube AI instance on port `6193` using your login credentials (username and password). +3. If you are unable to log in, contact the administrator of the instance and request that they create a new user account for you. ## Create a new user -Follow [this demonstration](https://jam.dev/c/f8d3fa47-7505-4201-b8ca-c0f724826237) to learn how to create a new user. Below are the summarized steps: +If you are the administrator, follow [this demonstration](https://jam.dev/c/f8d3fa47-7505-4201-b8ca-c0f724826237) to learn how to create a new user. Below are the summarized steps: -1. Admin login with their credentials -2. Create a new domain if there is none -3. Login to the new domain or already existing domain +1. Log in with admin credentials +2. Create a new domain (if needed) +3. Login to the newly created domain (or already existing domain) 4. Click profile icon and navigate to `Manage Users` 5. Click create 6. Fill in the form 7. Click `Create` +8. Share the login credentials (username and password) with the new user ## Login -Get a token from using your login credentials. +Once the administrator creates your account and shares your login details, use the credentials to log in to Cube AI and obtain an authentication token as shown below. ```bash curl -ksSiX POST https:///users/tokens/issue -H "Content-Type: application/json" -d @- << EOF @@ -27,7 +34,7 @@ curl -ksSiX POST https:///users/tokens/issue -H "Content-Type: EOF ``` -You'll receive a response similar to this: +Be sure to replace `` and `` with your actual login details. You'll receive a response similar to this: ```bash HTTP/2 201 @@ -40,7 +47,7 @@ content-length: 591 {"access_token":"","refresh_token":""} ``` -The `access_token` field in the response is your API token, which will be used for authentication in future API calls. +The `access_token` field in the response is your API token, which will be used for authentication in future API calls. The `refresh_token` field is a token you can use to obtain a new access token once the current one expires. ## VS Code Setup From bd215f3bf8a32bfdba08955f4805ec99df33e704 Mon Sep 17 00:00:00 2001 From: JeffMboya Date: Tue, 8 Oct 2024 17:10:38 +0300 Subject: [PATCH 02/13] Add developer guide Signed-off-by: JeffMboya --- docs/developer-guide.md | 63 +++++++++++++++++++++++++++++++++++++++++ docs/getting-started.md | 6 ++-- 2 files changed, 65 insertions(+), 4 deletions(-) diff --git a/docs/developer-guide.md b/docs/developer-guide.md index 2b0b7f6..e25c828 100644 --- a/docs/developer-guide.md +++ b/docs/developer-guide.md @@ -1 +1,64 @@ # Developer Guide + +This guide will help you get started with developing, deploying, and running Cube AI. + +## Cloning the Repository + +In order to pull Cube AI Docker images and code from GitHub, you will need to generate a personal access token. Make sure to grant the following permissions to the token: + +- **`repo`**: Full control of private repositories (to clone and pull private code). +- **`read:packages`**: Download and install Docker images from the GitHub Container Registry. + +Follow [this guide](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) to create a token with these permissions. + +Once you have the token, log in to the Docker registry: + +```bash +docker login ghcr.io +``` + +- **Username**: Your GitHub username +- **Password**: The personal access token you generated. + +Clone the repository: + +```bash +git clone https://github.com/ultravioletrs/cube.git +``` + +Use your GitHub username and the personal access token when prompted for credentials. + +## Pulling Pre-built Docker Images + +To pull all necessary Docker images for Cube AI from the container registry, use the following command: + +```bash +cd cube/docker +docker compose pull +``` + +## Running Services with Docker Compose + +To run the Cube AI services using Docker Compose, ensure you have your environment variables set in the `docker/.env` file and run: + +```bash +docker-compose up -d +``` + +This will start up all the core services such as NATS, Jaeger, SpiceDB, Auth, Users, Invitations, and the Cube UI. + +To properly access Cube AI UI locally, you need to update the IP address entries in `docker/.env` to point to your server IP address. Replace the following entries as follows: + +```bash +UV_CUBE_UI_BASE_URL=http://localhost:3001 +UV_CUBE_NEXTAUTH_URL=http://localhost:3001/api/auth +UV_CUBE_PUBLIC_BASE_URL=http://localhost:3001 +``` + +The Cube AI UI can then be accessed through your browser at: + +```bash +http://localhost:3001 +``` + +You can log in using the administrator credentials. diff --git a/docs/getting-started.md b/docs/getting-started.md index 1b2cf59..4e556c4 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,8 +1,6 @@ # Getting Started -Before logging in or interacting with Cube AI, you need to make sure that Cube AI has been deployed and is running. Deployment can be done by the instance administrator or by you if you have the necessary access permissions. - -### Steps to Connect +Before logging in or interacting with Cube AI, you need to make sure that Cube AI has been deployed and is running. Deployment can be done by the instance administrator or by you if you have the necessary access permissions. Therefore, to Connect: 1. Ensure that Cube AI is deployed and running on your instance. 2. Connect to the deployed Cube AI instance on port `6193` using your login credentials (username and password). @@ -10,7 +8,7 @@ Before logging in or interacting with Cube AI, you need to make sure that Cube A ## Create a new user -If you are the administrator, follow [this demonstration](https://jam.dev/c/f8d3fa47-7505-4201-b8ca-c0f724826237) to learn how to create a new user. Below are the summarized steps: +If you are the instance administrator (or have administrator credentials), follow [this demonstration](https://jam.dev/c/f8d3fa47-7505-4201-b8ca-c0f724826237) to create a new user. Below are the summarized steps: 1. Log in with admin credentials 2. Create a new domain (if needed) From 3a3f0f55d7e26e0b1aaaa09d2f8de5a56c99cc36 Mon Sep 17 00:00:00 2001 From: JeffMboya Date: Tue, 8 Oct 2024 17:36:56 +0300 Subject: [PATCH 03/13] Add steps to build docker images Signed-off-by: JeffMboya --- docs/developer-guide.md | 53 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) diff --git a/docs/developer-guide.md b/docs/developer-guide.md index e25c828..14d3d56 100644 --- a/docs/developer-guide.md +++ b/docs/developer-guide.md @@ -37,6 +37,25 @@ cd cube/docker docker compose pull ``` +## Building Docker Images + +The Docker images for Cube AI can be built using the following commands in the project's root directory: + +1. **Build the Cube Proxy image**: + Navigate to the `proxy` directory and run: + + ```bash + cd proxy + make latest + ``` + +2. **Building development Docker images**: + For a development build of the Docker images, use the following command: + + ```bash + make docker-dev + ``` + ## Running Services with Docker Compose To run the Cube AI services using Docker Compose, ensure you have your environment variables set in the `docker/.env` file and run: @@ -62,3 +81,37 @@ http://localhost:3001 ``` You can log in using the administrator credentials. + +## Cleaning up your Dockerized Cube AI Setup + +If you want to stop and remove the Cube AI services, volumes, and networks created during the setup, follow these steps: + +### Stop and Remove Running Containers + +First, stop all running containers: + +```bash +docker-compose down +``` + +### Remove Volumes and Networks + +```bash +docker-compose down --volumes --remove-orphans +``` + +### Remove Images (Optional) + +If you also want to remove the Docker images you pulled or built, run: + +```bash +docker rmi $(docker images -q ghcr.io/ultravioletrs/cube/*) +``` + +### Clean Build Artifacts + +To clean up the build artifacts and remove compiled files, use: + +```bash +make clean +``` From 3e8063bde754e973fee7b3433cd6b5be3ecb7969 Mon Sep 17 00:00:00 2001 From: JeffMboya Date: Tue, 8 Oct 2024 18:06:58 +0300 Subject: [PATCH 04/13] Add HAL set-up Signed-off-by: JeffMboya --- docs/developer-guide.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/developer-guide.md b/docs/developer-guide.md index 14d3d56..295e78c 100644 --- a/docs/developer-guide.md +++ b/docs/developer-guide.md @@ -80,7 +80,13 @@ The Cube AI UI can then be accessed through your browser at: http://localhost:3001 ``` -You can log in using the administrator credentials. +## Hardware Abstraction Layer (HAL) for Confidential Computing + +For detailed instructions on setting up and building Cube HAL, please refer to the [HAL Buildroot README](https://github.com/ultravioletrs/cube/blob/d995e64e43eeb51cb0c50481cc9bbc0e619e3a6d/buildroot/linux/README.md). This document covers: + +- Cloning the Buildroot and Cube repositories +- Configuring and building Cube HAL +- Running Cube HAL in a virtual machine ## Cleaning up your Dockerized Cube AI Setup From 3b859252002d7019cf80dc134f4622c77e2555ff Mon Sep 17 00:00:00 2001 From: JeffMboya Date: Tue, 8 Oct 2024 18:26:38 +0300 Subject: [PATCH 05/13] Remove duplicated steps Signed-off-by: JeffMboya --- docs/developer-guide.md | 48 +++++++++-------------------------------- 1 file changed, 10 insertions(+), 38 deletions(-) diff --git a/docs/developer-guide.md b/docs/developer-guide.md index 295e78c..cd39300 100644 --- a/docs/developer-guide.md +++ b/docs/developer-guide.md @@ -11,35 +11,15 @@ In order to pull Cube AI Docker images and code from GitHub, you will need to ge Follow [this guide](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) to create a token with these permissions. -Once you have the token, log in to the Docker registry: +Once you have the token, follow the instructions provided in [this guide](https://github.com/ultravioletrs/cube/blob/main/hal/ubuntu/README.md) to: -```bash -docker login ghcr.io -``` - -- **Username**: Your GitHub username -- **Password**: The personal access token you generated. - -Clone the repository: - -```bash -git clone https://github.com/ultravioletrs/cube.git -``` - -Use your GitHub username and the personal access token when prompted for credentials. - -## Pulling Pre-built Docker Images - -To pull all necessary Docker images for Cube AI from the container registry, use the following command: - -```bash -cd cube/docker -docker compose pull -``` +- Clone Cube AI repository +- Pull pre-built Cube AI Docker images +- Start Cube AI Docker containers ## Building Docker Images -The Docker images for Cube AI can be built using the following commands in the project's root directory: +Once you have cloned the repository and pulled the necessary Docker images, you can build the Docker images for Cube AI using the following commands in the project's root directory: 1. **Build the Cube Proxy image**: Navigate to the `proxy` directory and run: @@ -58,23 +38,15 @@ The Docker images for Cube AI can be built using the following commands in the p ## Running Services with Docker Compose -To run the Cube AI services using Docker Compose, ensure you have your environment variables set in the `docker/.env` file and run: - -```bash -docker-compose up -d -``` - -This will start up all the core services such as NATS, Jaeger, SpiceDB, Auth, Users, Invitations, and the Cube UI. +After pulling the Docker images and setting up your environment, you can run the Cube AI services using Docker Compose as described in [this guide](https://github.com/ultravioletrs/cube/blob/main/hal/ubuntu/README.md). -To properly access Cube AI UI locally, you need to update the IP address entries in `docker/.env` to point to your server IP address. Replace the following entries as follows: +To properly access Cube AI UI deployed on a different server, update the IP address entries in `docker/.env` to point to your server IP address. The Cube AI UI can then be accessed through your browser at: ```bash -UV_CUBE_UI_BASE_URL=http://localhost:3001 -UV_CUBE_NEXTAUTH_URL=http://localhost:3001/api/auth -UV_CUBE_PUBLIC_BASE_URL=http://localhost:3001 +http://:3001 ``` -The Cube AI UI can then be accessed through your browser at: +For example, if you have deployed locally, use: ```bash http://localhost:3001 @@ -82,7 +54,7 @@ http://localhost:3001 ## Hardware Abstraction Layer (HAL) for Confidential Computing -For detailed instructions on setting up and building Cube HAL, please refer to the [HAL Buildroot README](https://github.com/ultravioletrs/cube/blob/d995e64e43eeb51cb0c50481cc9bbc0e619e3a6d/buildroot/linux/README.md). This document covers: +For detailed instructions on setting up and building Cube HAL, please refer to [this guide](https://github.com/ultravioletrs/cube/blob/d995e64e43eeb51cb0c50481cc9bbc0e619e3a6d/buildroot/linux/README.md). It covers: - Cloning the Buildroot and Cube repositories - Configuring and building Cube HAL From 4663bcb6a7d0d74be5e4ddbce798eecf3447a230 Mon Sep 17 00:00:00 2001 From: JeffMboya Date: Wed, 9 Oct 2024 12:29:55 +0300 Subject: [PATCH 06/13] Address comments Signed-off-by: JeffMboya --- docs/developer-guide.md | 72 +++++++++++++++++++---------------------- 1 file changed, 34 insertions(+), 38 deletions(-) diff --git a/docs/developer-guide.md b/docs/developer-guide.md index cd39300..68f8156 100644 --- a/docs/developer-guide.md +++ b/docs/developer-guide.md @@ -4,57 +4,59 @@ This guide will help you get started with developing, deploying, and running Cub ## Cloning the Repository -In order to pull Cube AI Docker images and code from GitHub, you will need to generate a personal access token. Make sure to grant the following permissions to the token: +```bash + https://github.com/ultravioletrs/cube.git + cd cube +``` -- **`repo`**: Full control of private repositories (to clone and pull private code). -- **`read:packages`**: Download and install Docker images from the GitHub Container Registry. +## Pulling Docker Images -Follow [this guide](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) to create a token with these permissions. +```bash +cd cube/docker/ +docker compose pull +``` -Once you have the token, follow the instructions provided in [this guide](https://github.com/ultravioletrs/cube/blob/main/hal/ubuntu/README.md) to: +## Running Services with Docker Compose -- Clone Cube AI repository -- Pull pre-built Cube AI Docker images -- Start Cube AI Docker containers +You can run/start Cube AI services using Docker Compose as described in [this guide](https://github.com/ultravioletrs/cube/blob/main/hal/ubuntu/README.md). -## Building Docker Images +To properly access Cube AI UI deployed on a different server, update the IP address entries in `docker/.env` as described in the above guide to point to your server IP address. The Cube AI UI can then be accessed through your browser at: -Once you have cloned the repository and pulled the necessary Docker images, you can build the Docker images for Cube AI using the following commands in the project's root directory: +```bash +http://:3001 +``` -1. **Build the Cube Proxy image**: - Navigate to the `proxy` directory and run: +For example, if you have deployed locally, use: - ```bash - cd proxy - make latest - ``` +```bash +http://localhost:3001 +``` -2. **Building development Docker images**: - For a development build of the Docker images, use the following command: +## Building Docker Images - ```bash - make docker-dev - ``` +You can build the Docker images for Cube AI and related services using the following commands in the project's root directory. -## Running Services with Docker Compose +To build the Cube Proxy image, use the `docker/Dockerfile` provided in the project. -After pulling the Docker images and setting up your environment, you can run the Cube AI services using Docker Compose as described in [this guide](https://github.com/ultravioletrs/cube/blob/main/hal/ubuntu/README.md). +```bash +docker build -t ghcr.io/ultravioletrs/cube/proxy:latest -f docker/Dockerfile . +``` -To properly access Cube AI UI deployed on a different server, update the IP address entries in `docker/.env` to point to your server IP address. The Cube AI UI can then be accessed through your browser at: +For development builds, use the `docker/Dockerfile.dev` provided in the project. ```bash -http://:3001 +docker build -t cube-proxy:dev -f docker/Dockerfile.dev . ``` -For example, if you have deployed locally, use: +If you prefer using `make`, the `Makefile` in the project includes a command to build the latest Docker image: ```bash -http://localhost:3001 +make latest ``` ## Hardware Abstraction Layer (HAL) for Confidential Computing -For detailed instructions on setting up and building Cube HAL, please refer to [this guide](https://github.com/ultravioletrs/cube/blob/d995e64e43eeb51cb0c50481cc9bbc0e619e3a6d/buildroot/linux/README.md). It covers: +For detailed instructions on setting up and building Cube HAL, please refer to [this guide](https://github.com/ultravioletrs/cube/blob/main/hal/buildroot/README.md). It covers: - Cloning the Buildroot and Cube repositories - Configuring and building Cube HAL @@ -64,30 +66,24 @@ For detailed instructions on setting up and building Cube HAL, please refer to [ If you want to stop and remove the Cube AI services, volumes, and networks created during the setup, follow these steps: -### Stop and Remove Running Containers - First, stop all running containers: ```bash -docker-compose down +docker compose down ``` -### Remove Volumes and Networks +Remove volumes and vetworks: ```bash -docker-compose down --volumes --remove-orphans +docker compose down --volumes --remove-orphans ``` -### Remove Images (Optional) - If you also want to remove the Docker images you pulled or built, run: ```bash -docker rmi $(docker images -q ghcr.io/ultravioletrs/cube/*) +docker rmi $(docker images -q "ghcr.io/ultravioletrs/cube/*") ``` -### Clean Build Artifacts - To clean up the build artifacts and remove compiled files, use: ```bash From 5ce0895a56b96a873ee9b99bbd9f0d28179e4d70 Mon Sep 17 00:00:00 2001 From: JeffMboya Date: Wed, 9 Oct 2024 12:30:36 +0300 Subject: [PATCH 07/13] Fix indentation Signed-off-by: JeffMboya --- docs/developer-guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/developer-guide.md b/docs/developer-guide.md index 68f8156..81b5bba 100644 --- a/docs/developer-guide.md +++ b/docs/developer-guide.md @@ -5,8 +5,8 @@ This guide will help you get started with developing, deploying, and running Cub ## Cloning the Repository ```bash - https://github.com/ultravioletrs/cube.git - cd cube +https://github.com/ultravioletrs/cube.git +cd cube ``` ## Pulling Docker Images From 5c40ef90d4c27ef0b49a69d66d76d86705a1e42a Mon Sep 17 00:00:00 2001 From: JeffMboya Date: Wed, 9 Oct 2024 13:03:01 +0300 Subject: [PATCH 08/13] Fix indentation Signed-off-by: JeffMboya --- docs/developer-guide.md | 24 ++++++------------------ 1 file changed, 6 insertions(+), 18 deletions(-) diff --git a/docs/developer-guide.md b/docs/developer-guide.md index 81b5bba..a88e10a 100644 --- a/docs/developer-guide.md +++ b/docs/developer-guide.md @@ -5,7 +5,7 @@ This guide will help you get started with developing, deploying, and running Cub ## Cloning the Repository ```bash -https://github.com/ultravioletrs/cube.git +git clone https://github.com/ultravioletrs/cube.git cd cube ``` @@ -34,24 +34,18 @@ http://localhost:3001 ## Building Docker Images -You can build the Docker images for Cube AI and related services using the following commands in the project's root directory. +You can build the Docker images for Cube AI and related services using the `make` command in the project's root directory. -To build the Cube Proxy image, use the `docker/Dockerfile` provided in the project. +To build the production Docker image, use: ```bash -docker build -t ghcr.io/ultravioletrs/cube/proxy:latest -f docker/Dockerfile . +make docker ``` -For development builds, use the `docker/Dockerfile.dev` provided in the project. +For the development Docker image, use: ```bash -docker build -t cube-proxy:dev -f docker/Dockerfile.dev . -``` - -If you prefer using `make`, the `Makefile` in the project includes a command to build the latest Docker image: - -```bash -make latest +make docker-dev ``` ## Hardware Abstraction Layer (HAL) for Confidential Computing @@ -78,12 +72,6 @@ Remove volumes and vetworks: docker compose down --volumes --remove-orphans ``` -If you also want to remove the Docker images you pulled or built, run: - -```bash -docker rmi $(docker images -q "ghcr.io/ultravioletrs/cube/*") -``` - To clean up the build artifacts and remove compiled files, use: ```bash From e6de659d400f19c664cb92bdee9fb9744dd9b85c Mon Sep 17 00:00:00 2001 From: JeffMboya Date: Wed, 9 Oct 2024 13:47:03 +0300 Subject: [PATCH 09/13] Clarify default Cube AI port Signed-off-by: JeffMboya --- docs/getting-started.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/getting-started.md b/docs/getting-started.md index 4e556c4..0e68583 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -6,6 +6,8 @@ Before logging in or interacting with Cube AI, you need to make sure that Cube A 2. Connect to the deployed Cube AI instance on port `6193` using your login credentials (username and password). 3. If you are unable to log in, contact the administrator of the instance and request that they create a new user account for you. +Port `6193` is our default port for accessing Cube AI deployment. It is configurable through the `.env` file, meaning you can change it to any port that suits your deployment needs as described in [this guide](https://github.com/ultravioletrs/cube/blob/main/hal/ubuntu/README.md) + ## Create a new user If you are the instance administrator (or have administrator credentials), follow [this demonstration](https://jam.dev/c/f8d3fa47-7505-4201-b8ca-c0f724826237) to create a new user. Below are the summarized steps: From fd0ef3c8d418e5a9921fcd728bf6d8a378de1342 Mon Sep 17 00:00:00 2001 From: JeffMboya Date: Wed, 9 Oct 2024 13:47:54 +0300 Subject: [PATCH 10/13] Clarify default Cube AI port Signed-off-by: JeffMboya --- docs/getting-started.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/getting-started.md b/docs/getting-started.md index 0e68583..7d4eafa 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -8,6 +8,14 @@ Before logging in or interacting with Cube AI, you need to make sure that Cube A Port `6193` is our default port for accessing Cube AI deployment. It is configurable through the `.env` file, meaning you can change it to any port that suits your deployment needs as described in [this guide](https://github.com/ultravioletrs/cube/blob/main/hal/ubuntu/README.md) +For example, to customize the port: + +```bash +UV_CUBE_UI_BASE_URL=http://: +``` + +If you are running Cube AI on a different port, make sure to update the environment variable accordingly. + ## Create a new user If you are the instance administrator (or have administrator credentials), follow [this demonstration](https://jam.dev/c/f8d3fa47-7505-4201-b8ca-c0f724826237) to create a new user. Below are the summarized steps: From dad2e8d69c3c229efe67e2a76d2b4ddcbc85a164 Mon Sep 17 00:00:00 2001 From: JeffMboya Date: Wed, 9 Oct 2024 13:48:39 +0300 Subject: [PATCH 11/13] Clarify default Cube AI port Signed-off-by: JeffMboya --- docs/getting-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 7d4eafa..ef6c5a1 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -6,7 +6,7 @@ Before logging in or interacting with Cube AI, you need to make sure that Cube A 2. Connect to the deployed Cube AI instance on port `6193` using your login credentials (username and password). 3. If you are unable to log in, contact the administrator of the instance and request that they create a new user account for you. -Port `6193` is our default port for accessing Cube AI deployment. It is configurable through the `.env` file, meaning you can change it to any port that suits your deployment needs as described in [this guide](https://github.com/ultravioletrs/cube/blob/main/hal/ubuntu/README.md) +Port `6193` is our default port for accessing Cube AI deployment. It is user-definable and configurable through the `.env` file, meaning you can change it to any port that suits your deployment needs as described in [this guide](https://github.com/ultravioletrs/cube/blob/main/hal/ubuntu/README.md) For example, to customize the port: From 679958ba17bd1ceac3f1b299f8fa244078f6696c Mon Sep 17 00:00:00 2001 From: JeffMboya Date: Wed, 9 Oct 2024 13:50:27 +0300 Subject: [PATCH 12/13] Fix grammar Signed-off-by: JeffMboya --- docs/getting-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index ef6c5a1..7d4eafa 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -6,7 +6,7 @@ Before logging in or interacting with Cube AI, you need to make sure that Cube A 2. Connect to the deployed Cube AI instance on port `6193` using your login credentials (username and password). 3. If you are unable to log in, contact the administrator of the instance and request that they create a new user account for you. -Port `6193` is our default port for accessing Cube AI deployment. It is user-definable and configurable through the `.env` file, meaning you can change it to any port that suits your deployment needs as described in [this guide](https://github.com/ultravioletrs/cube/blob/main/hal/ubuntu/README.md) +Port `6193` is our default port for accessing Cube AI deployment. It is configurable through the `.env` file, meaning you can change it to any port that suits your deployment needs as described in [this guide](https://github.com/ultravioletrs/cube/blob/main/hal/ubuntu/README.md) For example, to customize the port: From ca9ecd409d0fc5d7113030b49b5993cfc2fa0431 Mon Sep 17 00:00:00 2001 From: JeffMboya Date: Wed, 9 Oct 2024 13:51:30 +0300 Subject: [PATCH 13/13] Remove unnecessary instructions Signed-off-by: JeffMboya --- docs/getting-started.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 7d4eafa..92ce631 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -4,7 +4,6 @@ Before logging in or interacting with Cube AI, you need to make sure that Cube A 1. Ensure that Cube AI is deployed and running on your instance. 2. Connect to the deployed Cube AI instance on port `6193` using your login credentials (username and password). -3. If you are unable to log in, contact the administrator of the instance and request that they create a new user account for you. Port `6193` is our default port for accessing Cube AI deployment. It is configurable through the `.env` file, meaning you can change it to any port that suits your deployment needs as described in [this guide](https://github.com/ultravioletrs/cube/blob/main/hal/ubuntu/README.md)