From ebd2ecd84cad66a2d69e47e95ddb968c9a6cb028 Mon Sep 17 00:00:00 2001 From: Aarushi <50577581+aarushik93@users.noreply.github.com> Date: Tue, 10 Sep 2024 10:24:54 +0100 Subject: [PATCH] docs(server): Update docs (#8031) update docs --- docs/content/server/setup.md | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/docs/content/server/setup.md b/docs/content/server/setup.md index 8fe31bc139..2e624c05f2 100644 --- a/docs/content/server/setup.md +++ b/docs/content/server/setup.md @@ -73,6 +73,7 @@ Once you have installed Yarn and Poetry, you can run the following command to in ```bash cd rnd/autogpt_server +cp .env.example .env poetry install ``` @@ -90,7 +91,7 @@ Once you have installed the dependencies, you can proceed to the next step. In order to setup the database, you need to run the following commands, in the same terminal you ran the `poetry install` command: ```sh - docker compose up postgres -d + docker compose up postgres redis -d poetry run prisma migrate dev ``` After deploying the migration, to ensure that the database schema is correctly mapped to your codebase, allowing the application to interact with the database properly, you need to generate the Prisma database model: @@ -101,7 +102,15 @@ poetry run prisma generate Without running this command, the necessary Python modules (prisma.models) won't be available, leading to a `ModuleNotFoundError`. -### Running the server +### Running the server without Docker + +To run the server, you can run the following commands in the same terminal you ran the `poetry install` command: + +```bash +poetry run app +``` + +### Running the server within Docker To run the server, you can run the following commands in the same terminal you ran the `poetry install` command: @@ -110,7 +119,7 @@ docker compose build docker compose up ``` -In the other terminal, you can run the following command to start the frontend: +In the other terminal from autogpt_builder, you can run the following command to start the frontend: ```bash yarn dev @@ -119,3 +128,10 @@ yarn dev ### Checking if the server is running You can check if the server is running by visiting [http://localhost:3000](http://localhost:3000) in your browser. + +### Notes: +By default the daemons for different services run on the following ports: + +Execution Manager Daemon: 8002 +Execution Scheduler Daemon: 8003 +Rest Server Daemon: 8004