From 4258cfeb37c573e21df260f6a74d70acfff7c0cb Mon Sep 17 00:00:00 2001 From: "Ivan Mar (sOkam!)" <7308253+heysokam@users.noreply.github.com> Date: Fri, 9 Feb 2024 13:33:37 -0800 Subject: [PATCH] [all] Refactor installation into a microsite. Add Install to the navbar (#116) * chg: Refactor installation into a microsite. Add Install to the navbar * Revert "chg: Refactor installation into a microsite. Add Install to the navbar" This reverts commit 563a24c6f897ec89b96e79232454835096c8d0b5. * chg: Refactor installation into separate standard/advanced sections * chg: Add Install link to the navbar --- docs/manual/01_concepts/_category_.json | 3 - docs/manual/01_install/01_linux.md | 97 +++++++++++ .../01_macOSX.md => 01_install/02_macOSX.md} | 3 + .../03_windows.md} | 4 + .../03_windowsWSL.md | 6 +- .../04_controlCenter.md | 102 +++++------ docs/manual/01_install/_category_.json | 3 + docs/manual/01_install/index.md | 8 + .../01_projectsOverview.md | 0 .../{01_concepts => 02_concepts}/02_scenes.md | 0 .../03_locations.md | 0 .../04_instances.md | 0 .../05_channels.md | 0 .../06_resources.md | 0 .../{01_concepts => 02_concepts}/07_users.md | 0 .../08_avatars/01_animations.md | 0 .../08_avatars/02_mocap.md | 0 .../08_avatars/03_IK.md | 0 .../08_avatars/_category_.json | 0 .../08_avatars/index.md | 0 .../09_invites.md | 0 .../10_ui/01_customization.md | 0 .../10_ui/02_target.md | 0 .../10_ui/03_xrui/_category_.json | 0 .../10_ui/03_xrui/index.md | 0 .../10_ui/_category_.json | 0 .../10_ui/index.md | 0 docs/manual/02_concepts/_category_.json | 3 + .../images/projects-folder.png | Bin .../{01_concepts => 02_concepts}/index.md | 0 .../01_installation/05_advancedSetup.md | 99 ----------- .../01_installation/09_elasticKibana.md | 2 +- .../01_installation/index.md | 163 +++++++++--------- .../03_devopsDeployment/01_microk8s_linux.md | 6 +- .../_partials/acceptCertificates.md | 0 .../_partials/cloneInstructions.md | 0 .../controlCenter/step_authentication.md | 0 .../controlCenter/step_configurations.md | 0 .../_partials/controlCenter/step_summary.md | 0 .../_partials/controlCenter/step_variables.md | 0 .../_partials/makeUbuntu.md | 0 .../_partials/node/version.md | 0 .../_partials/node/versionHigh.md | 0 .../_partials/node/versionLow.md | 0 .../_partials/pythonUbuntu.md | 0 .../images/controlCenter/admin-dashboard.jpg | Bin .../images/controlCenter/cluster-screen.jpg | Bin .../controlCenter/configure-cluster-1.jpg | Bin .../controlCenter/configure-cluster-2.jpg | Bin .../controlCenter/configure-cluster-3.jpg | Bin .../controlCenter/configure-cluster-4.jpg | Bin .../images/controlCenter/create-cluster-1.jpg | Bin .../images/controlCenter/create-cluster-2.jpg | Bin .../images/controlCenter/create-cluster-3.jpg | Bin .../images/controlCenter/create-cluster-4.jpg | Bin .../images/controlCenter/create-cluster-5.jpg | Bin .../images/controlCenter/create-cluster-6.jpg | Bin .../images/controlCenter/create-cluster-7.jpg | Bin .../images/controlCenter/create-cluster-8.jpg | Bin .../images/controlCenter/engine-launch.jpg | Bin .../images/controlCenter/home-screen.jpg | Bin .../images/controlCenter/hotbar-add.jpg | Bin .../images/controlCenter/hotbar.jpg | Bin .../images/controlCenter/ipfs-web-ui.jpg | Bin .../controlCenter/k8s-dashboard-token.jpg | Bin .../images/controlCenter/k8s-dashboard.jpg | Bin .../images/controlCenter/logs-clear.jpg | Bin .../images/controlCenter/logs-download.jpg | Bin .../images/controlCenter/logs.jpg | Bin .../images/controlCenter/navbar-home.jpg | Bin .../images/controlCenter/navbar-icon.jpg | Bin .../images/controlCenter/navbar-support.jpg | Bin .../images/controlCenter/navbar-theme.jpg | Bin .../images/controlCenter/navbar-user.jpg | Bin .../images/controlCenter/navbar.jpg | Bin .../options-panel-cluster-icon.jpg | Bin .../controlCenter/options-panel-configure.jpg | Bin .../controlCenter/options-panel-delete.jpg | Bin .../options-panel-git-engine.jpg | Bin .../controlCenter/options-panel-git-ops.jpg | Bin .../controlCenter/options-panel-launch.jpg | Bin .../controlCenter/options-panel-refresh.jpg | Bin .../controlCenter/options-panel-settings.jpg | Bin .../images/controlCenter/options-panel.jpg | Bin .../images/controlCenter/rippled-cli.jpg | Bin .../images/controlCenter/status-apps.jpg | Bin .../images/controlCenter/status-engine.jpg | Bin .../images/controlCenter/status-fix.png | Bin .../images/controlCenter/status-info.jpg | Bin .../images/controlCenter/status-system.jpg | Bin .../controlCenter/workloads-screen-logs.jpg | Bin .../controlCenter/workloads-screen-table.jpg | Bin .../controlCenter/workloads-screen-tabs.jpg | Bin .../images/controlCenter/workloads-screen.jpg | Bin .../01_installation => }/images/userid.png | Bin docusaurus.config.ts | 1 + 96 files changed, 262 insertions(+), 238 deletions(-) delete mode 100644 docs/manual/01_concepts/_category_.json create mode 100644 docs/manual/01_install/01_linux.md rename docs/manual/{03_modules/05_infrastructure/01_installation/01_macOSX.md => 01_install/02_macOSX.md} (97%) rename docs/manual/{03_modules/05_infrastructure/01_installation/02_windows.md => 01_install/03_windows.md} (97%) rename docs/manual/{03_modules/05_infrastructure/01_installation => 01_install}/03_windowsWSL.md (96%) rename docs/manual/{03_modules/05_infrastructure/01_installation => 01_install}/04_controlCenter.md (79%) create mode 100644 docs/manual/01_install/_category_.json create mode 100644 docs/manual/01_install/index.md rename docs/manual/{01_concepts => 02_concepts}/01_projectsOverview.md (100%) rename docs/manual/{01_concepts => 02_concepts}/02_scenes.md (100%) rename docs/manual/{01_concepts => 02_concepts}/03_locations.md (100%) rename docs/manual/{01_concepts => 02_concepts}/04_instances.md (100%) rename docs/manual/{01_concepts => 02_concepts}/05_channels.md (100%) rename docs/manual/{01_concepts => 02_concepts}/06_resources.md (100%) rename docs/manual/{01_concepts => 02_concepts}/07_users.md (100%) rename docs/manual/{01_concepts => 02_concepts}/08_avatars/01_animations.md (100%) rename docs/manual/{01_concepts => 02_concepts}/08_avatars/02_mocap.md (100%) rename docs/manual/{01_concepts => 02_concepts}/08_avatars/03_IK.md (100%) rename docs/manual/{01_concepts => 02_concepts}/08_avatars/_category_.json (100%) rename docs/manual/{01_concepts => 02_concepts}/08_avatars/index.md (100%) rename docs/manual/{01_concepts => 02_concepts}/09_invites.md (100%) rename docs/manual/{01_concepts => 02_concepts}/10_ui/01_customization.md (100%) rename docs/manual/{01_concepts => 02_concepts}/10_ui/02_target.md (100%) rename docs/manual/{01_concepts => 02_concepts}/10_ui/03_xrui/_category_.json (100%) rename docs/manual/{01_concepts => 02_concepts}/10_ui/03_xrui/index.md (100%) rename docs/manual/{01_concepts => 02_concepts}/10_ui/_category_.json (100%) rename docs/manual/{01_concepts => 02_concepts}/10_ui/index.md (100%) create mode 100644 docs/manual/02_concepts/_category_.json rename docs/manual/{01_concepts => 02_concepts}/images/projects-folder.png (100%) rename docs/manual/{01_concepts => 02_concepts}/index.md (100%) delete mode 100644 docs/manual/03_modules/05_infrastructure/01_installation/05_advancedSetup.md rename docs/manual/{03_modules/05_infrastructure => }/_partials/acceptCertificates.md (100%) rename docs/manual/{03_modules/05_infrastructure => }/_partials/cloneInstructions.md (100%) rename docs/manual/{03_modules/05_infrastructure => }/_partials/controlCenter/step_authentication.md (100%) rename docs/manual/{03_modules/05_infrastructure => }/_partials/controlCenter/step_configurations.md (100%) rename docs/manual/{03_modules/05_infrastructure => }/_partials/controlCenter/step_summary.md (100%) rename docs/manual/{03_modules/05_infrastructure => }/_partials/controlCenter/step_variables.md (100%) rename docs/manual/{03_modules/05_infrastructure => }/_partials/makeUbuntu.md (100%) rename docs/manual/{03_modules/05_infrastructure => }/_partials/node/version.md (100%) rename docs/manual/{03_modules/05_infrastructure => }/_partials/node/versionHigh.md (100%) rename docs/manual/{03_modules/05_infrastructure => }/_partials/node/versionLow.md (100%) rename docs/manual/{03_modules/05_infrastructure => }/_partials/pythonUbuntu.md (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/admin-dashboard.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/cluster-screen.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/configure-cluster-1.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/configure-cluster-2.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/configure-cluster-3.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/configure-cluster-4.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/create-cluster-1.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/create-cluster-2.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/create-cluster-3.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/create-cluster-4.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/create-cluster-5.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/create-cluster-6.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/create-cluster-7.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/create-cluster-8.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/engine-launch.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/home-screen.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/hotbar-add.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/hotbar.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/ipfs-web-ui.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/k8s-dashboard-token.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/k8s-dashboard.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/logs-clear.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/logs-download.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/logs.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/navbar-home.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/navbar-icon.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/navbar-support.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/navbar-theme.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/navbar-user.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/navbar.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/options-panel-cluster-icon.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/options-panel-configure.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/options-panel-delete.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/options-panel-git-engine.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/options-panel-git-ops.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/options-panel-launch.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/options-panel-refresh.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/options-panel-settings.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/options-panel.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/rippled-cli.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/status-apps.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/status-engine.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/status-fix.png (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/status-info.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/status-system.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/workloads-screen-logs.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/workloads-screen-table.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/workloads-screen-tabs.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/controlCenter/workloads-screen.jpg (100%) rename docs/manual/{03_modules/05_infrastructure/01_installation => }/images/userid.png (100%) diff --git a/docs/manual/01_concepts/_category_.json b/docs/manual/01_concepts/_category_.json deleted file mode 100644 index 429163165677..000000000000 --- a/docs/manual/01_concepts/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "position": 01, -} diff --git a/docs/manual/01_install/01_linux.md b/docs/manual/01_install/01_linux.md new file mode 100644 index 000000000000..4aa747b18caa --- /dev/null +++ b/docs/manual/01_install/01_linux.md @@ -0,0 +1,97 @@ +--- +sidebar_label: Linux +--- + +import CloneInstructions from '../_partials/cloneInstructions.md' +import AcceptCertificates from '../_partials/acceptCertificates.md' + +# Installation on Linux + +## Pre-Install Checklist +1. Ensure you have at least 16GB of RAM + _You may run int issues running the full development setup with less_ +2. Clone the repository to a location whose path **contains no spaces**. +3. Install Node.js 18 + _(versions earlier than 16 are not guaranteed to work)_ +4. Install Python >=3.6, [PIP](https://pypi.org/project/pip/), C++, and other build tools + _See the [Mediasoup install instructions](https://mediasoup.org/documentation/v3/mediasoup/installation/) for full details._ +5. Install Docker + _Optionally: If you're NOT using docker, install MariaDB, Redis and MinIO manually and update repo's `.env.local` accordingly._ + +You should now be ready to follow the [Quick Start](#quick-start) instructions. + +### Clone the repository +A lot has changed during development, and our monorepo has gotten quite large. +To avoid cloning everything, use this command: + + + +### Ensure you are running Node 18 +The engine to date has only been confirmed to work with Node 16.x and 18.x. +Earlier or later major versions are not guaranteed to work properly. + +The best way to install and manage Node.js versions is by using a version manager: +1. Install [NVM](https://github.com/nvm-sh/nvm) +2. Install Node.js 18 with `nvm install 18` +3. _(Optional)_ Make Node.js 18 your default node version with `nvm alias default 18` + +_Note: Polyglot [ASDF](https://github.com/asdf-vm/asdf) can also be used for managing node versions._ + +Please check the output of `node --version` before running the engine. +If you are using a node version below 16, please update or nothing will work. +You will know that you are having issues if you try to install packages at root with `npm install` and you get package dependency errors. + +### Docker is your friend +You don't need to use [Docker](https://docs.docker.com/), but it will make your life much easier. +If you don't wish to use Docker, you will need to setup mariadb and redis on your machine. You can find credentials in `/scripts/docker-compose.yml` + +## Quick Start +If you are lucky, this will just work. However, you may encounter some issues. +Make sure you are running Node 18, and check your dependencies. +``` +cd path/to/etherealengine +cp .env.local.default .env.local +npm install +npm run dev-docker +npm run dev-reinit +npm run dev +``` +Now run Ethereal Engine in your browser by navigating to [this link](https://localhost:3000/location/default). + +### Accept Certificates + + +### Admin System and User Setup +You can administrate many features from the admin panel found at the `/admin` route of your deployment. +_eg: `https://localhost:3000/admin` when working in a local deployment._ + +To give administration rights to a user: +- Open any page in your Ethereal Engine deployment +- Open the user menu _(icon at the top-right of the screen)_ +- Click on `Show API key` +- Copy that key to your clipboard _(note: there is an icon to the right of this box for this purpose)_ +- Open a terminal and go to the folder where EtherealEngine was cloned. +- Run the command `npm run make-user-admin -- --id={COPIED_USER_ID}` where `COPIED_USER_ID` is the key you just copied on the previous step. + Example: `npm run make-user-admin -- --id=c06b0210-453e-11ec-afc3-c57a57eeb1ac` + +![image](../images/userid.png) + +> Alternate Method: +> Open the `User` table of your deployment's database and change `userRole` to `admin` +_(It helps to use a graphical database explorer, we recommend [beekeeperstudio.io](https://beekeeperstudio.io/))_ +The location of the database can be found in your `.env.local` file. + +Test user Admin privileges by going to the `/admin` route of your deployment. + + +## Advanced Installation and Troubleshooting +If you run into any trouble with the Quick Start instructions: +- Please make sure you've followed the + [Mediasoup installation instructions](https://mediasoup.org/documentation/v3/mediasoup/installation/) +- Check your OS-specific instructions: + - [Installing on Windows (10+)](./02_windows.md) + - [Installing on Mac OS X](./01_macOSX.md) +- [Installation Troubleshooting](./06_troubleshooting.md) +- [Advanced Setup](./04_advancedSetup.md) +- [Vite dev server is stalling](https://vitejs.dev/guide/troubleshooting.html#dev-server) + diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/01_macOSX.md b/docs/manual/01_install/02_macOSX.md similarity index 97% rename from docs/manual/03_modules/05_infrastructure/01_installation/01_macOSX.md rename to docs/manual/01_install/02_macOSX.md index e7bc793da384..c3755c8e4840 100644 --- a/docs/manual/03_modules/05_infrastructure/01_installation/01_macOSX.md +++ b/docs/manual/01_install/02_macOSX.md @@ -1,3 +1,6 @@ +--- +sidebar_label: Mac OS X +--- # Installing on Mac OS X 1. Go to the root folder where Ethereal Engine is stored and run diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/02_windows.md b/docs/manual/01_install/03_windows.md similarity index 97% rename from docs/manual/03_modules/05_infrastructure/01_installation/02_windows.md rename to docs/manual/01_install/03_windows.md index 42fd59f1cd60..fdf1b281a121 100644 --- a/docs/manual/03_modules/05_infrastructure/01_installation/02_windows.md +++ b/docs/manual/01_install/03_windows.md @@ -1,3 +1,7 @@ +--- +sidebar_label: Windows 10+ +--- + # Installing on Windows 10+ 1. Install Python 3 and add python installation directory path to `PATH` env variable. 2. Install Node.js 18 diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/03_windowsWSL.md b/docs/manual/01_install/03_windowsWSL.md similarity index 96% rename from docs/manual/03_modules/05_infrastructure/01_installation/03_windowsWSL.md rename to docs/manual/01_install/03_windowsWSL.md index 693a16497e2d..c6fe055fda80 100644 --- a/docs/manual/03_modules/05_infrastructure/01_installation/03_windowsWSL.md +++ b/docs/manual/01_install/03_windowsWSL.md @@ -1,3 +1,7 @@ +--- +sidebar_label: Windows WSL2 +--- + import CloneInstructions from '../_partials/cloneInstructions.md' import AcceptCertificates from '../_partials/acceptCertificates.md' import PythonUbuntu from '../_partials/pythonUbuntu.md' @@ -30,7 +34,7 @@ Make sure to enable your WSL distribution once docker desktop is installed and r You can do so from Docker Desktop App by visiting `Settings > Resources > WSL Integration`. Enable integration with Ubuntu, and make sure to hit `Apply & Restart`. -![Docker Desktop WSL Distro](../03_devopsDeployment/images/docker-desktop-wsl-distro.jpg) +![Docker Desktop WSL Distro](../03_modules/05_infrastructure/03_devopsDeployment/images/docker-desktop-wsl-distro.jpg) ## Install Node If Node is not already installed on your machine _(check with `node --version`)_, you can do so by first installing `nvm` and then installing Node with nvm. diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/04_controlCenter.md b/docs/manual/01_install/04_controlCenter.md similarity index 79% rename from docs/manual/03_modules/05_infrastructure/01_installation/04_controlCenter.md rename to docs/manual/01_install/04_controlCenter.md index c585ab687ac5..670703c407d5 100644 --- a/docs/manual/03_modules/05_infrastructure/01_installation/04_controlCenter.md +++ b/docs/manual/01_install/04_controlCenter.md @@ -48,7 +48,7 @@ In order to download Ethereal Engine Control Center App, navigate to [releases]( You will see this screen when you launch the app for the first time: -![Home Screen](./images/controlCenter/home-screen.jpg) +![Home Screen](../images/controlCenter/home-screen.jpg) Here you will need to create a cluster. You can do so by: @@ -58,7 +58,7 @@ You can do so by: ### 2.1. Cluster Information These are the different sections of the create cluster dialog. -![Create Cluster - Cluster Information](./images/controlCenter/create-cluster-1.jpg) +![Create Cluster - Cluster Information](../images/controlCenter/create-cluster-1.jpg) In this step, you will need to provide the following information: - **Cluster Name:** @@ -81,25 +81,25 @@ In this step, you will need to provide the following information: You will see the options below if you selected your cluster type as MicroK8s or Minikube. ### 2.2.1. Authentication -![Create Cluster - Authentication](./images/controlCenter/create-cluster-2.jpg) +![Create Cluster - Authentication](../images/controlCenter/create-cluster-2.jpg) ### 2.2.2. Configurations -![Create Cluster - Configurations](./images/controlCenter/create-cluster-3.jpg) +![Create Cluster - Configurations](../images/controlCenter/create-cluster-3.jpg) ### 2.2.3. Variables -![Create Cluster - Variables](./images/controlCenter/create-cluster-4.jpg) +![Create Cluster - Variables](../images/controlCenter/create-cluster-4.jpg) ### 2.2.4. Summary -![Create Cluster - Summary](./images/controlCenter/create-cluster-5.jpg) +![Create Cluster - Summary](../images/controlCenter/create-cluster-5.jpg) @@ -119,7 +119,7 @@ The Custom cluster type allows to connect to an existing kubernetes cluster. You will see the options below if you selected this type. ### 2.3.1. Kubeconfig -![Create Cluster - Kubeconfig](./images/controlCenter/create-cluster-6.jpg) +![Create Cluster - Kubeconfig](../images/controlCenter/create-cluster-6.jpg) In this step, you will need to provide following information regarding desired cluster's kubeconfig: - **Config Type: Default** @@ -133,7 +133,7 @@ In this step, you will need to provide following information regarding desired c The dropdown will show all contexts that exist for the selected config type. ### 2.3.2. Deployment -![Create Cluster - Deployment](./images/controlCenter/create-cluster-7.jpg) +![Create Cluster - Deployment](../images/controlCenter/create-cluster-7.jpg) In this step you will need to provide the following deployment information: - **Release Name**: @@ -143,7 +143,7 @@ In this step you will need to provide the following deployment information: > eg: `prod-etherealengine-client` ### 2.3.3. Summary -![Create Cluster - Summary](./images/controlCenter/create-cluster-8.jpg) +![Create Cluster - Summary](../images/controlCenter/create-cluster-8.jpg) @@ -154,26 +154,26 @@ In this step you will need to provide the following deployment information: You will be sent to this screen once you have created a cluster. > _Also know as the `config` page_. -![Cluster Screen](./images/controlCenter/cluster-screen.jpg) +![Cluster Screen](../images/controlCenter/cluster-screen.jpg) Lets explain various sections of this screen. ### 3.1. Hotbar -![Hotbar](./images/controlCenter/hotbar.jpg) +![Hotbar](../images/controlCenter/hotbar.jpg) Shows a list of all the clusters you have created. You can click on each of them to view the cluster screen of them. -![Add Cluster Icon](./images/controlCenter/hotbar-add.jpg) The plus icon at the bottom of this bar is used to create a new cluster. +![Add Cluster Icon](../images/controlCenter/hotbar-add.jpg) The plus icon at the bottom of this bar is used to create a new cluster. ### 3.2. Navbar -![Navbar](./images/controlCenter/navbar.jpg) +![Navbar](../images/controlCenter/navbar.jpg) The Navbar allows navigation and various utility options. -- **App Icon**: ![App Icon](./images/controlCenter/navbar-icon.jpg) +- **App Icon**: ![App Icon](../images/controlCenter/navbar-icon.jpg) The logo of this application. -- **Home Icon**: ![Home Icon](./images/controlCenter/navbar-home.jpg) +- **Home Icon**: ![Home Icon](../images/controlCenter/navbar-home.jpg) Navigate to home. - **Config**: @@ -195,66 +195,66 @@ The Navbar allows navigation and various utility options. Navigates to rippled [server cli](#10-rippled-cli) of selected cluster. Visible only when ripple stack is enabled. -- **Change Theme Icon**: ![Change Theme Icon](./images/controlCenter/navbar-theme.jpg) +- **Change Theme Icon**: ![Change Theme Icon](../images/controlCenter/navbar-theme.jpg) Allows to toggle between vaporware, light & dark themes. The color scheme of these themes are similar to ethereal engine. -- **Support Icon**: ![Support Icon](./images/controlCenter/navbar-support.jpg) +- **Support Icon**: ![Support Icon](../images/controlCenter/navbar-support.jpg) Opens a dropdown menu to allow reaching out to support via Discord or Github. -- **User Icon**: ![User Icon](./images/controlCenter/navbar-user.jpg) +- **User Icon**: ![User Icon](../images/controlCenter/navbar-user.jpg) The functionality for this button is coming soon. ### 3.3. Options Panel -![Options Panel](./images/controlCenter/options-panel.jpg) +![Options Panel](../images/controlCenter/options-panel.jpg) This section shows various actions that can be activated on the currently selected cluster: -- **Cluster Icon**: ![Cluster Icon](./images/controlCenter/options-panel-cluster-icon.jpg) +- **Cluster Icon**: ![Cluster Icon](../images/controlCenter/options-panel-cluster-icon.jpg) Logo of the selected cluster type. It can be MicroK8s or Minikube logo. - **Cluster Name**: Name that you entered in create cluster dialog. _eg: `Local`_ -- **Engine Git Status**: ![Cluster Icon](./images/controlCenter/options-panel-git-engine.jpg) +- **Engine Git Status**: ![Cluster Icon](../images/controlCenter/options-panel-git-engine.jpg) View and change the state of your local Ethereal Engine GitHub repo. View current branch, pull incoming changes and push outgoing changes. -- **Ops Git Status**: ![Cluster Icon](./images/controlCenter/options-panel-git-ops.jpg) +- **Ops Git Status**: ![Cluster Icon](../images/controlCenter/options-panel-git-ops.jpg) View the current status of your local Ethereal Engine ops GitHub repo. You can perform the same actions explained in the previous bullet point _(Engine Git Status)_. -- **Refresh Icon**: ![Refresh Icon](./images/controlCenter/options-panel-refresh.jpg) +- **Refresh Icon**: ![Refresh Icon](../images/controlCenter/options-panel-refresh.jpg) Will recheck the status of prerequisites, system, apps & engine. It also rechecks the status of the engine and ops git repositories. It will be disabled, until its finished, when a refresh is already in process. -- **Delete Icon**: ![Delete Icon](./images/controlCenter/options-panel-delete.jpg) +- **Delete Icon**: ![Delete Icon](../images/controlCenter/options-panel-delete.jpg) Deletes a cluster. It will not make any changes in the associated local kubernetes, app, etc. -- **Settings Icon**: ![Settings Icon](./images/controlCenter/options-panel-settings.jpg) +- **Settings Icon**: ![Settings Icon](../images/controlCenter/options-panel-settings.jpg) Will open the settings dialog. This dialog contains specific settings for the selected cluster, in addition to other general app settings. -- **Configure Button**: ![Configure Button](./images/controlCenter/options-panel-configure.jpg) +- **Configure Button**: ![Configure Button](../images/controlCenter/options-panel-configure.jpg) Will open the configure dialog which will be [discussed](#4-configure-cluster) later. It will be disabled and have a spinner in it when a configuration is already running. -- **Launch Button**: ![Launch Button](./images/controlCenter/options-panel-launch.jpg) +- **Launch Button**: ![Launch Button](../images/controlCenter/options-panel-launch.jpg) This button will open Ethereal Engine's default location in your browser as [discussed](#5-launch-ethereal-engine) later. ### 3.4. System Status This section will show whether or not the system requirements are currently met. > On Windows: It will also show the status of the prerequisites. -![System Status](./images/controlCenter/status-system.jpg) +![System Status](../images/controlCenter/status-system.jpg) The status will be displayed right next to each item. -You can find more details by hovering over the ![Info Icon](./images/controlCenter/status-info.jpg) info icon. +You can find more details by hovering over the ![Info Icon](../images/controlCenter/status-info.jpg) info icon. Very useful when one of the items is not configured correctly. -Some items might have an ![Fix Icon](./images/controlCenter/status-fix.png) auto fix icon attached. +Some items might have an ![Fix Icon](../images/controlCenter/status-fix.png) auto fix icon attached. Clicking this button will try to auto fix the problem. If it fails: Use the configure dialog [discussed](#4-configure-cluster) later. @@ -265,26 +265,26 @@ Otherwise you will need to use the configure dialog. ### 3.5. Apps Status This section shows the current status of all the apps required to run an Ethereal Engine deployment. -![Apps Status](./images/controlCenter/status-apps.jpg) +![Apps Status](../images/controlCenter/status-apps.jpg) ### 3.6. Engine Status This section shows the current status of various components of an Ethereal Engine deployment in your local kubernetes distribution. -![Engine Status](./images/controlCenter/status-engine.jpg) +![Engine Status](../images/controlCenter/status-engine.jpg) ### 3.7. Logs This section shows all logs for the current session. There are logs for most actions performed by the Control Center and their outputs. -![Logs](./images/controlCenter/logs.jpg) +![Logs](../images/controlCenter/logs.jpg) -- **Download Button**: ![Download Button](./images/controlCenter/logs-download.jpg) +- **Download Button**: ![Download Button](../images/controlCenter/logs-download.jpg) Will download all displayed logs. -- **Clear Button**: ![Clear Button](./images/controlCenter/logs-clear.jpg) +- **Clear Button**: ![Clear Button](../images/controlCenter/logs-clear.jpg) Will clear all displayed logs. ## 4. Configure Cluster You will need to run the configure script to automatically fix any of the status entries of the [cluster screen](#3-cluster-screen). -You can do so with the ![Configure Button](./images/controlCenter/options-panel-configure.jpg) button in the [options panel](#33-options-panel) +You can do so with the ![Configure Button](../images/controlCenter/options-panel-configure.jpg) button in the [options panel](#33-options-panel) Following are the different sections of configure cluster dialog: :::important[recommended] @@ -293,25 +293,25 @@ Always clear your logs before running the configure script to trace its output e ### 4.1. Authentication -![Configure Cluster - Authentication](./images/controlCenter/configure-cluster-1.jpg) +![Configure Cluster - Authentication](../images/controlCenter/configure-cluster-1.jpg) ### 4.2. Configurations -![Configure Cluster - Configurations](./images/controlCenter/configure-cluster-2.jpg) +![Configure Cluster - Configurations](../images/controlCenter/configure-cluster-2.jpg) ### 4.3. Variables -![Configure Cluster - Variables](./images/controlCenter/configure-cluster-3.jpg) +![Configure Cluster - Variables](../images/controlCenter/configure-cluster-3.jpg) ### 4.4. Summary -![Configure Cluster - Summary](./images/controlCenter/configure-cluster-4.jpg) +![Configure Cluster - Summary](../images/controlCenter/configure-cluster-4.jpg) @@ -319,7 +319,7 @@ Always clear your logs before running the configure script to trace its output e This will start the configuration script which will ensure that things are correctly setup. You can track the output of each step of the process with its [logs](#37-logs). It can take a while to setup things depending on your system and the status of your applications. - The ![Configure Button](./images/controlCenter/options-panel-configure.jpg) button will be disabled and have a spinner in it when a configuration process is already running. + The ![Configure Button](../images/controlCenter/options-panel-configure.jpg) button will be disabled and have a spinner in it when a configuration process is already running. :::note The cluster status will be automatically refreshed once the script finished its execution. ::: @@ -329,7 +329,7 @@ Always clear your logs before running the configure script to trace its output e ::: ## 5. Launch Ethereal Engine -![Launch Ethereal Engine](./images/controlCenter/engine-launch.jpg) +![Launch Ethereal Engine](../images/controlCenter/engine-launch.jpg) If everything was configured correctly and all ticks are green on the "config" page _(aka [Cluster Screen](#3-cluster-screen))_, you will now be able to `Launch` the engine from the [options panel](#33-options-panel). @@ -342,17 +342,17 @@ Make sure to allow certificates as explained [here](https://etherealengine.githu ## 6. Workloads Workloads are the k8s pods of the components of an Ethereal Engine deployment. -![Workloads](./images/controlCenter/workloads-screen.jpg) +![Workloads](../images/controlCenter/workloads-screen.jpg) ### 6.1. Workload Tabs The Workload Tabs section allows you to filter workloads based on their types. The default tab will be `All`, which displays all workloads. The number below each tab's label displays: `currently ready count`/`total count`. -![Workload Tabs](./images/controlCenter/workloads-screen-tabs.jpg) +![Workload Tabs](../images/controlCenter/workloads-screen-tabs.jpg) ### 6.2. Workloads Table This section displays data based on selected workload [tab](#61-workload-tabs). -![Workloads Table](./images/controlCenter/workloads-screen-table.jpg) +![Workloads Table](../images/controlCenter/workloads-screen-table.jpg) For each workload, it contains pod name and other details. Hovering over a container's circle will display further details. Moreover, there is a `Logs` button to view kubernetes container logs as discussed in next [section](#63-workload-logs). `Delete` button will allow to remove the pod from current kubernetes distribution. @@ -360,7 +360,7 @@ Additionally, there is refresh icon button on right top of this table. This will ### 6.3. Workload Logs -![Workload Logs](./images/controlCenter/workloads-screen-logs.jpg) +![Workload Logs](../images/controlCenter/workloads-screen-logs.jpg) This section will by default display cluster [logs](#37-logs). Though if user clicked `Logs` button as discussed in previous [section](#62-workloads-table), then the logs of that workload will be displayed. The cluster [logs](#37-logs) will then be displayed under `Config` log tab. User can toggle between these log tabs, while workload logs can be closed as well. @@ -370,7 +370,7 @@ Beside these icons there is also a container drop down through which user can se ## 7. Admin Dashboard -![Admin Dashboard](./images/controlCenter/admin-dashboard.jpg) +![Admin Dashboard](../images/controlCenter/admin-dashboard.jpg) Once, everything is configured correctly and all ticks are green on config page ([Cluster Screen](#3-cluster-screen)) then you can click on `Admin` button in [navbar](#32-navbar). This will show the admin dashboard of ethereal engine deployed in your local k8s cluster. @@ -378,19 +378,19 @@ You can perform various actions from admin dashboard including installing projec ## 8. K8 Dashboard -![K8 Dashboard](./images/controlCenter/k8s-dashboard.jpg) +![K8 Dashboard](../images/controlCenter/k8s-dashboard.jpg) Once, your selected local k8s distribution (Microk8s or Minikube) has a green tick on config page ([Cluster Screen](#3-cluster-screen)) then you can click on `K8 Dashboard` button in [navbar](#32-navbar). This will show the k8s dashboard. For MicroK8s, when you launch it for the first time then you will be asked regarding token configurations. You can use `Skip` button to pass through it. -![K8 Dashboard Token](./images/controlCenter/k8s-dashboard-token.jpg) +![K8 Dashboard Token](../images/controlCenter/k8s-dashboard-token.jpg) You can perform various actions from k8s dashboard including managing pods, jobs, deployments, services, etc. ## 9. IPFS -![IPFS Web UI](./images/controlCenter/ipfs-web-ui.jpg) +![IPFS Web UI](../images/controlCenter/ipfs-web-ui.jpg) If ripple stack is enabled and once, IPFS has a green tick on config page ([Cluster Screen](#3-cluster-screen)) then you can click on `IPFS` button in [navbar](#32-navbar). This will show the IPFS web UI. @@ -398,7 +398,7 @@ You can view and manage various aspects of the IPFS running in your local cluste ## 10. Rippled CLI -![Rippled CLI](./images/controlCenter/rippled-cli.jpg) +![Rippled CLI](../images/controlCenter/rippled-cli.jpg) If ripple stack is enabled and once, Rippled has a green tick on config page ([Cluster Screen](#3-cluster-screen)) then you can click on `Rippled CLI` button in [navbar](#32-navbar). This will show the Rippled CLI page. diff --git a/docs/manual/01_install/_category_.json b/docs/manual/01_install/_category_.json new file mode 100644 index 000000000000..e0d3b8be94f4 --- /dev/null +++ b/docs/manual/01_install/_category_.json @@ -0,0 +1,3 @@ +{ + "position": 02, +} diff --git a/docs/manual/01_install/index.md b/docs/manual/01_install/index.md new file mode 100644 index 000000000000..0cf7c6a53708 --- /dev/null +++ b/docs/manual/01_install/index.md @@ -0,0 +1,8 @@ +import DocCardList from '@theme/DocCardList' + +# Installation + +Getting up and running requires just a few steps, but this can be tricky depending on your platform and current environment. +Please follow the instructions for your specific environment. + + diff --git a/docs/manual/01_concepts/01_projectsOverview.md b/docs/manual/02_concepts/01_projectsOverview.md similarity index 100% rename from docs/manual/01_concepts/01_projectsOverview.md rename to docs/manual/02_concepts/01_projectsOverview.md diff --git a/docs/manual/01_concepts/02_scenes.md b/docs/manual/02_concepts/02_scenes.md similarity index 100% rename from docs/manual/01_concepts/02_scenes.md rename to docs/manual/02_concepts/02_scenes.md diff --git a/docs/manual/01_concepts/03_locations.md b/docs/manual/02_concepts/03_locations.md similarity index 100% rename from docs/manual/01_concepts/03_locations.md rename to docs/manual/02_concepts/03_locations.md diff --git a/docs/manual/01_concepts/04_instances.md b/docs/manual/02_concepts/04_instances.md similarity index 100% rename from docs/manual/01_concepts/04_instances.md rename to docs/manual/02_concepts/04_instances.md diff --git a/docs/manual/01_concepts/05_channels.md b/docs/manual/02_concepts/05_channels.md similarity index 100% rename from docs/manual/01_concepts/05_channels.md rename to docs/manual/02_concepts/05_channels.md diff --git a/docs/manual/01_concepts/06_resources.md b/docs/manual/02_concepts/06_resources.md similarity index 100% rename from docs/manual/01_concepts/06_resources.md rename to docs/manual/02_concepts/06_resources.md diff --git a/docs/manual/01_concepts/07_users.md b/docs/manual/02_concepts/07_users.md similarity index 100% rename from docs/manual/01_concepts/07_users.md rename to docs/manual/02_concepts/07_users.md diff --git a/docs/manual/01_concepts/08_avatars/01_animations.md b/docs/manual/02_concepts/08_avatars/01_animations.md similarity index 100% rename from docs/manual/01_concepts/08_avatars/01_animations.md rename to docs/manual/02_concepts/08_avatars/01_animations.md diff --git a/docs/manual/01_concepts/08_avatars/02_mocap.md b/docs/manual/02_concepts/08_avatars/02_mocap.md similarity index 100% rename from docs/manual/01_concepts/08_avatars/02_mocap.md rename to docs/manual/02_concepts/08_avatars/02_mocap.md diff --git a/docs/manual/01_concepts/08_avatars/03_IK.md b/docs/manual/02_concepts/08_avatars/03_IK.md similarity index 100% rename from docs/manual/01_concepts/08_avatars/03_IK.md rename to docs/manual/02_concepts/08_avatars/03_IK.md diff --git a/docs/manual/01_concepts/08_avatars/_category_.json b/docs/manual/02_concepts/08_avatars/_category_.json similarity index 100% rename from docs/manual/01_concepts/08_avatars/_category_.json rename to docs/manual/02_concepts/08_avatars/_category_.json diff --git a/docs/manual/01_concepts/08_avatars/index.md b/docs/manual/02_concepts/08_avatars/index.md similarity index 100% rename from docs/manual/01_concepts/08_avatars/index.md rename to docs/manual/02_concepts/08_avatars/index.md diff --git a/docs/manual/01_concepts/09_invites.md b/docs/manual/02_concepts/09_invites.md similarity index 100% rename from docs/manual/01_concepts/09_invites.md rename to docs/manual/02_concepts/09_invites.md diff --git a/docs/manual/01_concepts/10_ui/01_customization.md b/docs/manual/02_concepts/10_ui/01_customization.md similarity index 100% rename from docs/manual/01_concepts/10_ui/01_customization.md rename to docs/manual/02_concepts/10_ui/01_customization.md diff --git a/docs/manual/01_concepts/10_ui/02_target.md b/docs/manual/02_concepts/10_ui/02_target.md similarity index 100% rename from docs/manual/01_concepts/10_ui/02_target.md rename to docs/manual/02_concepts/10_ui/02_target.md diff --git a/docs/manual/01_concepts/10_ui/03_xrui/_category_.json b/docs/manual/02_concepts/10_ui/03_xrui/_category_.json similarity index 100% rename from docs/manual/01_concepts/10_ui/03_xrui/_category_.json rename to docs/manual/02_concepts/10_ui/03_xrui/_category_.json diff --git a/docs/manual/01_concepts/10_ui/03_xrui/index.md b/docs/manual/02_concepts/10_ui/03_xrui/index.md similarity index 100% rename from docs/manual/01_concepts/10_ui/03_xrui/index.md rename to docs/manual/02_concepts/10_ui/03_xrui/index.md diff --git a/docs/manual/01_concepts/10_ui/_category_.json b/docs/manual/02_concepts/10_ui/_category_.json similarity index 100% rename from docs/manual/01_concepts/10_ui/_category_.json rename to docs/manual/02_concepts/10_ui/_category_.json diff --git a/docs/manual/01_concepts/10_ui/index.md b/docs/manual/02_concepts/10_ui/index.md similarity index 100% rename from docs/manual/01_concepts/10_ui/index.md rename to docs/manual/02_concepts/10_ui/index.md diff --git a/docs/manual/02_concepts/_category_.json b/docs/manual/02_concepts/_category_.json new file mode 100644 index 000000000000..e0d3b8be94f4 --- /dev/null +++ b/docs/manual/02_concepts/_category_.json @@ -0,0 +1,3 @@ +{ + "position": 02, +} diff --git a/docs/manual/01_concepts/images/projects-folder.png b/docs/manual/02_concepts/images/projects-folder.png similarity index 100% rename from docs/manual/01_concepts/images/projects-folder.png rename to docs/manual/02_concepts/images/projects-folder.png diff --git a/docs/manual/01_concepts/index.md b/docs/manual/02_concepts/index.md similarity index 100% rename from docs/manual/01_concepts/index.md rename to docs/manual/02_concepts/index.md diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/05_advancedSetup.md b/docs/manual/03_modules/05_infrastructure/01_installation/05_advancedSetup.md deleted file mode 100644 index ed03793008f5..000000000000 --- a/docs/manual/03_modules/05_infrastructure/01_installation/05_advancedSetup.md +++ /dev/null @@ -1,99 +0,0 @@ -import AcceptCertificates from '../_partials/acceptCertificates.md' - -# Advanced Setup - -The advanced setup is recommended for users who want to understand the internals of how the Ethereal Engine's deployment stack works. -These instructions will explain how to manually setup Ethereal Engine docker instances, client, server and/or instance-server. - -## 1. Install dependencies -```bash -cd path/to/etherealengine -npm install -npm run dev-docker -npm run dev-reinit -``` -_Note how you don't need to use sudo for any of these commands._ - -> If you find errors with mediasoup: -> - Follow the [Mediasoup Installation](https://mediasoup.org/documentation/v3/mediasoup/installation/) instructions -> - Check that your version of python is up to date: `python --version` -> - Make sure that the path where you installed Ethereal Engine has no whitespaces - -## 2. Start the MySQL database -Make sure you have a MySQL database installed and running. Our recommendation is `MariaDB`. - -We provide a docker container for easily setting up the database. This command will create a Docker container of MariaDB named `etherealengine_db`: -```bash -cd scripts && sudo bash start-db.sh -``` -> Note: You must have docker installed on your machine for this script to work. -If you do not have Docker installed, and do not wish to install it, you will have to manually create a MariaDB server. - - -The default database information is: -| | | -|-|-| -| Username | `server` | -| Password | `password` | -| Database | `etherealengine` | -| Hostname | `127.0.0.1` | -| Port | `3306` | -> Note: If you have errors connecting to the local database, you might need to shut off your local firewall. - - -## 3. Start Agones -Open a new terminal and start the Agones sidecar in local mode -```bash -cd scripts && sudo bash start-agones.sh -``` -Alternatively, you can also go to `etherealengine/vendor/agones/` and run: -- Linux: `./sdk-server.linux.amd64 --local` -- Windows: `sdk-server.windows.amd64.exe --local` -- Mac: `./sdk-server.darwin.amd64 --local` - -## 4. Start the server in database seed mode -Several tables in the database need to be seeded with default values. -To do so, run: -- Unix: `npm run dev-reinit` -- Windows: `npm run dev-reinit-windows` - -There should be no more logging after several seconds. -If the database has been correctly seeded, some of the final lines should read like this: -```bash -Server Ready -Executing (default): SET FOREIGN_KEY_CHECKS = 1 -Server EXIT -``` - -## 5. Local file server configuration (Optional) -If the `.env.local` file you have has this line, the Scene Editor will save components, models, scenes, etc. locally, instead of storing them on the `S3` cloud server: -```bash -STORAGE_PROVIDER=local -``` -You will need to start a local server to serve these files and make sure that your `.env.local` file has this line: -```bash -LOCAL_STORAGE_PROVIDER="localhost:8642" -``` -In a new terminal, go to `packages/server` and run -```bash -npm run serve-local-files -``` -This will start up the `http-server` that will serve local files from `packages/server/upload` on `localhost:8642`. -> Note: You may have to accept the invalid self-signed certificate in the browser the first time it is loaded. See the `Allow local file http-server connection with invalid certificate` section below. - -## 6. Start the API server, instance-server and client -Open two/three separate terminals and run: -- Run `npm run dev` inside `packages/server`. - This will launch the API, world, media and file servers. - _Note: If you are not using instanceservers, you can instead run `npm run dev-api-server` inside the API server folder._ -- Run `npm run dev` inside `packages/client` - _Note: If you are on windows you need to use `npm run dev-windows` instead of `npm run dev`._ - -## 7. Open the Engine -If everything went well, you can now open the engine by navigating to [this link](https://localhost:3000/location/default) in your browser. - -The database seeding process creates a default empty location called `default`, which can be accessed by opening `https://localhost:3000/location/default`. - -## 8. Accept the Certificates - - diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/09_elasticKibana.md b/docs/manual/03_modules/05_infrastructure/01_installation/09_elasticKibana.md index 4a98fce8b081..25480fe76ef7 100644 --- a/docs/manual/03_modules/05_infrastructure/01_installation/09_elasticKibana.md +++ b/docs/manual/03_modules/05_infrastructure/01_installation/09_elasticKibana.md @@ -1,4 +1,4 @@ -import AcceptCertificates from '../_partials/acceptCertificates.md' +import AcceptCertificates from '../../../_partials/acceptCertificates.md' # Setup Elastic Search & Kibana diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/index.md b/docs/manual/03_modules/05_infrastructure/01_installation/index.md index dc3a0f2ad837..917f72f6cc28 100644 --- a/docs/manual/03_modules/05_infrastructure/01_installation/index.md +++ b/docs/manual/03_modules/05_infrastructure/01_installation/index.md @@ -1,96 +1,99 @@ -import CloneInstructions from '../_partials/cloneInstructions.md' -import AcceptCertificates from '../_partials/acceptCertificates.md' +import AcceptCertificates from '../../../_partials/acceptCertificates.md' -# Installation +# Advanced Setup -Getting up and running requires just a few steps, but this can be tricky, depending on your platform and current environment. -Please follow the directions for your specific environment. +The advanced setup is recommended for users who want to understand the internals of how the Ethereal Engine's deployment stack works. +These instructions will explain how to manually setup Ethereal Engine docker instances, client, server and/or instance-server. -## Pre-Install Checklist -1. Ensure you have at least 16GB of RAM - _You may run int issues running the full development setup with less_ -2. Clone the repository to a location whose path **contains no spaces**. -3. Install Node.js 18 - _(versions earlier than 16 are not guaranteed to work)_ -4. Install Python >=3.6, [PIP](https://pypi.org/project/pip/), C++, and other build tools - _See the [Mediasoup install instructions](https://mediasoup.org/documentation/v3/mediasoup/installation/) for full details._ -5. Install Docker - _Optionally: If you're NOT using docker, install MariaDB, Redis and MinIO manually and update repo's `.env.local` accordingly._ - -You should now be ready to follow the [Quick Start](#quick-start) instructions. +## 1. Install dependencies +```bash +cd path/to/etherealengine +npm install +npm run dev-docker +npm run dev-reinit +``` +_Note how you don't need to use sudo for any of these commands._ -### Clone the repository -A lot has changed during development, and our monorepo has gotten quite large. -To avoid cloning everything, use this command: +> If you find errors with mediasoup: +> - Follow the [Mediasoup Installation](https://mediasoup.org/documentation/v3/mediasoup/installation/) instructions +> - Check that your version of python is up to date: `python --version` +> - Make sure that the path where you installed Ethereal Engine has no whitespaces - +## 2. Start the MySQL database +Make sure you have a MySQL database installed and running. Our recommendation is `MariaDB`. -### Ensure you are running Node 18 -The engine to date has only been confirmed to work with Node 16.x and 18.x. -Earlier or later major versions are not guaranteed to work properly. +We provide a docker container for easily setting up the database. This command will create a Docker container of MariaDB named `etherealengine_db`: +```bash +cd scripts && sudo bash start-db.sh +``` +> Note: You must have docker installed on your machine for this script to work. +If you do not have Docker installed, and do not wish to install it, you will have to manually create a MariaDB server. -The best way to install and manage Node.js versions is by using a version manager: -1. Install [NVM](https://github.com/nvm-sh/nvm) -2. Install Node.js 18 with `nvm install 18` -3. _(Optional)_ Make Node.js 18 your default node version with `nvm alias default 18` -_Note: Polyglot [ASDF](https://github.com/asdf-vm/asdf) can also be used for managing node versions._ +The default database information is: +| | | +|-|-| +| Username | `server` | +| Password | `password` | +| Database | `etherealengine` | +| Hostname | `127.0.0.1` | +| Port | `3306` | +> Note: If you have errors connecting to the local database, you might need to shut off your local firewall. -Please check the output of `node --version` before running the engine. -If you are using a node version below 16, please update or nothing will work. -You will know that you are having issues if you try to install packages at root with `npm install` and you get package dependency errors. -### Docker is your friend -You don't need to use [Docker](https://docs.docker.com/), but it will make your life much easier. -If you don't wish to use Docker, you will need to setup mariadb and redis on your machine. You can find credentials in `/scripts/docker-compose.yml` +## 3. Start Agones +Open a new terminal and start the Agones sidecar in local mode +```bash +cd scripts && sudo bash start-agones.sh +``` +Alternatively, you can also go to `etherealengine/vendor/agones/` and run: +- Linux: `./sdk-server.linux.amd64 --local` +- Windows: `sdk-server.windows.amd64.exe --local` +- Mac: `./sdk-server.darwin.amd64 --local` + +## 4. Start the server in database seed mode +Several tables in the database need to be seeded with default values. +To do so, run: +- Unix: `npm run dev-reinit` +- Windows: `npm run dev-reinit-windows` + +There should be no more logging after several seconds. +If the database has been correctly seeded, some of the final lines should read like this: +```bash +Server Ready +Executing (default): SET FOREIGN_KEY_CHECKS = 1 +Server EXIT +``` -## Quick Start -If you are lucky, this will just work. However, you may encounter some issues. -Make sure you are running Node 18, and check your dependencies. +## 5. Local file server configuration (Optional) +If the `.env.local` file you have has this line, the Scene Editor will save components, models, scenes, etc. locally, instead of storing them on the `S3` cloud server: +```bash +STORAGE_PROVIDER=local ``` -cd path/to/etherealengine -cp .env.local.default .env.local -npm install -npm run dev-docker -npm run dev-reinit -npm run dev +You will need to start a local server to serve these files and make sure that your `.env.local` file has this line: +```bash +LOCAL_STORAGE_PROVIDER="localhost:8642" +``` +In a new terminal, go to `packages/server` and run +```bash +npm run serve-local-files ``` -Now run Ethereal Engine in your browser by navigating to [this link](https://localhost:3000/location/default). +This will start up the `http-server` that will serve local files from `packages/server/upload` on `localhost:8642`. +> Note: You may have to accept the invalid self-signed certificate in the browser the first time it is loaded. See the `Allow local file http-server connection with invalid certificate` section below. -### Accept Certificates - +## 6. Start the API server, instance-server and client +Open two/three separate terminals and run: +- Run `npm run dev` inside `packages/server`. + This will launch the API, world, media and file servers. + _Note: If you are not using instanceservers, you can instead run `npm run dev-api-server` inside the API server folder._ +- Run `npm run dev` inside `packages/client` + _Note: If you are on windows you need to use `npm run dev-windows` instead of `npm run dev`._ + +## 7. Open the Engine +If everything went well, you can now open the engine by navigating to [this link](https://localhost:3000/location/default) in your browser. -### Admin System and User Setup -You can administrate many features from the admin panel found at the `/admin` route of your deployment. -_eg: `https://localhost:3000/admin` when working in a local deployment._ - -To give administration rights to a user: -- Open any page in your Ethereal Engine deployment -- Open the user menu _(icon at the top-right of the screen)_ -- Click on `Show API key` -- Copy that key to your clipboard _(note: there is an icon to the right of this box for this purpose)_ -- Open a terminal and go to the folder where EtherealEngine was cloned. -- Run the command `npm run make-user-admin -- --id={COPIED_USER_ID}` where `COPIED_USER_ID` is the key you just copied on the previous step. - Example: `npm run make-user-admin -- --id=c06b0210-453e-11ec-afc3-c57a57eeb1ac` - -![image](./images/userid.png) - -> Alternate Method: -> Open the `User` table of your deployment's database and change `userRole` to `admin` -_(It helps to use a graphical database explorer, we recommend [beekeeperstudio.io](https://beekeeperstudio.io/))_ -The location of the database can be found in your `.env.local` file. - -Test user Admin privileges by going to the `/admin` route of your deployment. - - -## Advanced Installation and Troubleshooting -If you run into any trouble with the Quick Start instructions: -- Please make sure you've followed the - [Mediasoup installation instructions](https://mediasoup.org/documentation/v3/mediasoup/installation/) -- Check your OS-specific instructions: - - [Installing on Windows (10+)](./02_windows.md) - - [Installing on Mac OS X](./01_macOSX.md) -- [Installation Troubleshooting](./06_troubleshooting.md) -- [Advanced Setup](./04_advancedSetup.md) -- [Vite dev server is stalling](https://vitejs.dev/guide/troubleshooting.html#dev-server) +The database seeding process creates a default empty location called `default`, which can be accessed by opening `https://localhost:3000/location/default`. + +## 8. Accept the Certificates + diff --git a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/01_microk8s_linux.md b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/01_microk8s_linux.md index 3e20fc4dee20..ac9c318710e3 100644 --- a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/01_microk8s_linux.md +++ b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/01_microk8s_linux.md @@ -1,6 +1,6 @@ -import AcceptCertificates from '../_partials/acceptCertificates.md' -import PythonUbuntu from '../_partials/pythonUbuntu.md' -import MakeUbuntu from '../_partials/makeUbuntu.md' +import AcceptCertificates from '../../../_partials/acceptCertificates.md' +import PythonUbuntu from '../../../_partials/pythonUbuntu.md' +import MakeUbuntu from '../../../_partials/makeUbuntu.md' # Ethereal Engine on MicroK8s (Linux) diff --git a/docs/manual/03_modules/05_infrastructure/_partials/acceptCertificates.md b/docs/manual/_partials/acceptCertificates.md similarity index 100% rename from docs/manual/03_modules/05_infrastructure/_partials/acceptCertificates.md rename to docs/manual/_partials/acceptCertificates.md diff --git a/docs/manual/03_modules/05_infrastructure/_partials/cloneInstructions.md b/docs/manual/_partials/cloneInstructions.md similarity index 100% rename from docs/manual/03_modules/05_infrastructure/_partials/cloneInstructions.md rename to docs/manual/_partials/cloneInstructions.md diff --git a/docs/manual/03_modules/05_infrastructure/_partials/controlCenter/step_authentication.md b/docs/manual/_partials/controlCenter/step_authentication.md similarity index 100% rename from docs/manual/03_modules/05_infrastructure/_partials/controlCenter/step_authentication.md rename to docs/manual/_partials/controlCenter/step_authentication.md diff --git a/docs/manual/03_modules/05_infrastructure/_partials/controlCenter/step_configurations.md b/docs/manual/_partials/controlCenter/step_configurations.md similarity index 100% rename from docs/manual/03_modules/05_infrastructure/_partials/controlCenter/step_configurations.md rename to docs/manual/_partials/controlCenter/step_configurations.md diff --git a/docs/manual/03_modules/05_infrastructure/_partials/controlCenter/step_summary.md b/docs/manual/_partials/controlCenter/step_summary.md similarity index 100% rename from docs/manual/03_modules/05_infrastructure/_partials/controlCenter/step_summary.md rename to docs/manual/_partials/controlCenter/step_summary.md diff --git a/docs/manual/03_modules/05_infrastructure/_partials/controlCenter/step_variables.md b/docs/manual/_partials/controlCenter/step_variables.md similarity index 100% rename from docs/manual/03_modules/05_infrastructure/_partials/controlCenter/step_variables.md rename to docs/manual/_partials/controlCenter/step_variables.md diff --git a/docs/manual/03_modules/05_infrastructure/_partials/makeUbuntu.md b/docs/manual/_partials/makeUbuntu.md similarity index 100% rename from docs/manual/03_modules/05_infrastructure/_partials/makeUbuntu.md rename to docs/manual/_partials/makeUbuntu.md diff --git a/docs/manual/03_modules/05_infrastructure/_partials/node/version.md b/docs/manual/_partials/node/version.md similarity index 100% rename from docs/manual/03_modules/05_infrastructure/_partials/node/version.md rename to docs/manual/_partials/node/version.md diff --git a/docs/manual/03_modules/05_infrastructure/_partials/node/versionHigh.md b/docs/manual/_partials/node/versionHigh.md similarity index 100% rename from docs/manual/03_modules/05_infrastructure/_partials/node/versionHigh.md rename to docs/manual/_partials/node/versionHigh.md diff --git a/docs/manual/03_modules/05_infrastructure/_partials/node/versionLow.md b/docs/manual/_partials/node/versionLow.md similarity index 100% rename from docs/manual/03_modules/05_infrastructure/_partials/node/versionLow.md rename to docs/manual/_partials/node/versionLow.md diff --git a/docs/manual/03_modules/05_infrastructure/_partials/pythonUbuntu.md b/docs/manual/_partials/pythonUbuntu.md similarity index 100% rename from docs/manual/03_modules/05_infrastructure/_partials/pythonUbuntu.md rename to docs/manual/_partials/pythonUbuntu.md diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/admin-dashboard.jpg b/docs/manual/images/controlCenter/admin-dashboard.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/admin-dashboard.jpg rename to docs/manual/images/controlCenter/admin-dashboard.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/cluster-screen.jpg b/docs/manual/images/controlCenter/cluster-screen.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/cluster-screen.jpg rename to docs/manual/images/controlCenter/cluster-screen.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/configure-cluster-1.jpg b/docs/manual/images/controlCenter/configure-cluster-1.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/configure-cluster-1.jpg rename to docs/manual/images/controlCenter/configure-cluster-1.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/configure-cluster-2.jpg b/docs/manual/images/controlCenter/configure-cluster-2.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/configure-cluster-2.jpg rename to docs/manual/images/controlCenter/configure-cluster-2.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/configure-cluster-3.jpg b/docs/manual/images/controlCenter/configure-cluster-3.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/configure-cluster-3.jpg rename to docs/manual/images/controlCenter/configure-cluster-3.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/configure-cluster-4.jpg b/docs/manual/images/controlCenter/configure-cluster-4.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/configure-cluster-4.jpg rename to docs/manual/images/controlCenter/configure-cluster-4.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/create-cluster-1.jpg b/docs/manual/images/controlCenter/create-cluster-1.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/create-cluster-1.jpg rename to docs/manual/images/controlCenter/create-cluster-1.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/create-cluster-2.jpg b/docs/manual/images/controlCenter/create-cluster-2.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/create-cluster-2.jpg rename to docs/manual/images/controlCenter/create-cluster-2.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/create-cluster-3.jpg b/docs/manual/images/controlCenter/create-cluster-3.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/create-cluster-3.jpg rename to docs/manual/images/controlCenter/create-cluster-3.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/create-cluster-4.jpg b/docs/manual/images/controlCenter/create-cluster-4.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/create-cluster-4.jpg rename to docs/manual/images/controlCenter/create-cluster-4.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/create-cluster-5.jpg b/docs/manual/images/controlCenter/create-cluster-5.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/create-cluster-5.jpg rename to docs/manual/images/controlCenter/create-cluster-5.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/create-cluster-6.jpg b/docs/manual/images/controlCenter/create-cluster-6.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/create-cluster-6.jpg rename to docs/manual/images/controlCenter/create-cluster-6.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/create-cluster-7.jpg b/docs/manual/images/controlCenter/create-cluster-7.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/create-cluster-7.jpg rename to docs/manual/images/controlCenter/create-cluster-7.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/create-cluster-8.jpg b/docs/manual/images/controlCenter/create-cluster-8.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/create-cluster-8.jpg rename to docs/manual/images/controlCenter/create-cluster-8.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/engine-launch.jpg b/docs/manual/images/controlCenter/engine-launch.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/engine-launch.jpg rename to docs/manual/images/controlCenter/engine-launch.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/home-screen.jpg b/docs/manual/images/controlCenter/home-screen.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/home-screen.jpg rename to docs/manual/images/controlCenter/home-screen.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/hotbar-add.jpg b/docs/manual/images/controlCenter/hotbar-add.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/hotbar-add.jpg rename to docs/manual/images/controlCenter/hotbar-add.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/hotbar.jpg b/docs/manual/images/controlCenter/hotbar.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/hotbar.jpg rename to docs/manual/images/controlCenter/hotbar.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/ipfs-web-ui.jpg b/docs/manual/images/controlCenter/ipfs-web-ui.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/ipfs-web-ui.jpg rename to docs/manual/images/controlCenter/ipfs-web-ui.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/k8s-dashboard-token.jpg b/docs/manual/images/controlCenter/k8s-dashboard-token.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/k8s-dashboard-token.jpg rename to docs/manual/images/controlCenter/k8s-dashboard-token.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/k8s-dashboard.jpg b/docs/manual/images/controlCenter/k8s-dashboard.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/k8s-dashboard.jpg rename to docs/manual/images/controlCenter/k8s-dashboard.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/logs-clear.jpg b/docs/manual/images/controlCenter/logs-clear.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/logs-clear.jpg rename to docs/manual/images/controlCenter/logs-clear.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/logs-download.jpg b/docs/manual/images/controlCenter/logs-download.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/logs-download.jpg rename to docs/manual/images/controlCenter/logs-download.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/logs.jpg b/docs/manual/images/controlCenter/logs.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/logs.jpg rename to docs/manual/images/controlCenter/logs.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/navbar-home.jpg b/docs/manual/images/controlCenter/navbar-home.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/navbar-home.jpg rename to docs/manual/images/controlCenter/navbar-home.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/navbar-icon.jpg b/docs/manual/images/controlCenter/navbar-icon.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/navbar-icon.jpg rename to docs/manual/images/controlCenter/navbar-icon.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/navbar-support.jpg b/docs/manual/images/controlCenter/navbar-support.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/navbar-support.jpg rename to docs/manual/images/controlCenter/navbar-support.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/navbar-theme.jpg b/docs/manual/images/controlCenter/navbar-theme.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/navbar-theme.jpg rename to docs/manual/images/controlCenter/navbar-theme.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/navbar-user.jpg b/docs/manual/images/controlCenter/navbar-user.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/navbar-user.jpg rename to docs/manual/images/controlCenter/navbar-user.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/navbar.jpg b/docs/manual/images/controlCenter/navbar.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/navbar.jpg rename to docs/manual/images/controlCenter/navbar.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/options-panel-cluster-icon.jpg b/docs/manual/images/controlCenter/options-panel-cluster-icon.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/options-panel-cluster-icon.jpg rename to docs/manual/images/controlCenter/options-panel-cluster-icon.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/options-panel-configure.jpg b/docs/manual/images/controlCenter/options-panel-configure.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/options-panel-configure.jpg rename to docs/manual/images/controlCenter/options-panel-configure.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/options-panel-delete.jpg b/docs/manual/images/controlCenter/options-panel-delete.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/options-panel-delete.jpg rename to docs/manual/images/controlCenter/options-panel-delete.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/options-panel-git-engine.jpg b/docs/manual/images/controlCenter/options-panel-git-engine.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/options-panel-git-engine.jpg rename to docs/manual/images/controlCenter/options-panel-git-engine.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/options-panel-git-ops.jpg b/docs/manual/images/controlCenter/options-panel-git-ops.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/options-panel-git-ops.jpg rename to docs/manual/images/controlCenter/options-panel-git-ops.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/options-panel-launch.jpg b/docs/manual/images/controlCenter/options-panel-launch.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/options-panel-launch.jpg rename to docs/manual/images/controlCenter/options-panel-launch.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/options-panel-refresh.jpg b/docs/manual/images/controlCenter/options-panel-refresh.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/options-panel-refresh.jpg rename to docs/manual/images/controlCenter/options-panel-refresh.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/options-panel-settings.jpg b/docs/manual/images/controlCenter/options-panel-settings.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/options-panel-settings.jpg rename to docs/manual/images/controlCenter/options-panel-settings.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/options-panel.jpg b/docs/manual/images/controlCenter/options-panel.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/options-panel.jpg rename to docs/manual/images/controlCenter/options-panel.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/rippled-cli.jpg b/docs/manual/images/controlCenter/rippled-cli.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/rippled-cli.jpg rename to docs/manual/images/controlCenter/rippled-cli.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/status-apps.jpg b/docs/manual/images/controlCenter/status-apps.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/status-apps.jpg rename to docs/manual/images/controlCenter/status-apps.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/status-engine.jpg b/docs/manual/images/controlCenter/status-engine.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/status-engine.jpg rename to docs/manual/images/controlCenter/status-engine.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/status-fix.png b/docs/manual/images/controlCenter/status-fix.png similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/status-fix.png rename to docs/manual/images/controlCenter/status-fix.png diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/status-info.jpg b/docs/manual/images/controlCenter/status-info.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/status-info.jpg rename to docs/manual/images/controlCenter/status-info.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/status-system.jpg b/docs/manual/images/controlCenter/status-system.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/status-system.jpg rename to docs/manual/images/controlCenter/status-system.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/workloads-screen-logs.jpg b/docs/manual/images/controlCenter/workloads-screen-logs.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/workloads-screen-logs.jpg rename to docs/manual/images/controlCenter/workloads-screen-logs.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/workloads-screen-table.jpg b/docs/manual/images/controlCenter/workloads-screen-table.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/workloads-screen-table.jpg rename to docs/manual/images/controlCenter/workloads-screen-table.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/workloads-screen-tabs.jpg b/docs/manual/images/controlCenter/workloads-screen-tabs.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/workloads-screen-tabs.jpg rename to docs/manual/images/controlCenter/workloads-screen-tabs.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/workloads-screen.jpg b/docs/manual/images/controlCenter/workloads-screen.jpg similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/controlCenter/workloads-screen.jpg rename to docs/manual/images/controlCenter/workloads-screen.jpg diff --git a/docs/manual/03_modules/05_infrastructure/01_installation/images/userid.png b/docs/manual/images/userid.png similarity index 100% rename from docs/manual/03_modules/05_infrastructure/01_installation/images/userid.png rename to docs/manual/images/userid.png diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 1826dd2b1e75..0f2d62679cc7 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -86,6 +86,7 @@ const config: Config = { // ] //}, //{ label: 'Examples', position: cfg.navbar.menu.position, to: 'examples', }, // TODO: Uncomment when the examples pages is ready + { label: 'Install', position: cfg.navbar.menu.position, href: '/manual/install' }, { label: 'Manual', position: cfg.navbar.menu.position, to: 'manual', }, //{ label: cfg.typedoc.label, position: cfg.navbar.menu.position, href: cfg.typedoc.url }, { "aria-label": "GitHub", position: cfg.navbar.menu.position, className: "header-github-link", href: cfg.github.projectURL, },