github/AutoGPT
1
1
Fork 0
mirror of https://github.com/Significant-Gravitas/AutoGPT.git synced 2026-01-09 15:17:59 -05:00
Code Issues Packages Projects Releases Wiki Activity

feat(docs): Add info about auto setup script to docs + readme (#10347)

Browse Source 
Updates to the readme + docs to add info about the newly added auto
setup script.

Changes to ``new_blocks.md`` and ``installer.md`` are to make netlify CI
happy and pass

---------

Co-authored-by: Reinier van der Leer <pwuts@agpt.co>
This commit is contained in:
Bently
2025-07-15 18:39:12 +01:00
committed by GitHub
parent 0deaaf9e8f
commit f45bf53681
4 changed files with 39 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/content/platform/getting-started.md
View File

@@ -79,7 +79,23 @@ Once you have Docker and Docker Compose installed, you can proceed to the next s
See <a href="https://github.com/supabase/supabase/issues/33816">supabase/supabase #33816</a> for additional context.
</details>
## Setup
## Quick Setup with Auto Setup Script (Recommended)
If you're self-hosting AutoGPT locally, we recommend using our official setup script to simplify the process. This will install dependencies (like Docker), pull the latest code, and launch the app with minimal effort.
For macOS/Linux:
```
curl -fsSL https://setup.agpt.co/install.sh -o install.sh && bash install.sh
```
For Windows (PowerShell):
```
powershell -c "iwr https://setup.agpt.co/install.bat -o install.bat; ./install.bat"
```
This method is ideal if you're setting up for development or testing and want to skip manual configuration.
## Manual Setup
### Cloning the Repository
The first step is cloning the AutoGPT repository to your computer.

2
docs/content/platform/installer.md
View File

@@ -43,7 +43,7 @@ If you prefer, you can manually download and run the installer scripts:
- **Linux/macOS:** `setup-autogpt.sh`
- **Windows:** `setup-autogpt.bat`
Follow the instructions in the [installer README](../../../../autogpt_platform/installer/README.md) for more details.
These scripts are located in the `autogpt_platform/installer/` directory.
## After Installation

6
docs/content/platform/new_blocks.md
View File

@@ -337,10 +337,10 @@ You will need to add the provider (api or oauth) to the `CredentialsInput` compo
--8<-- "autogpt_platform/frontend/src/components/integrations/credentials-input.tsx:ProviderIconsEmbed"
```
You will also need to add the provider to the `CredentialsProvider` component in [`frontend/src/components/integrations/credentials-provider.tsx`](https://github.com/Significant-Gravitas/AutoGPT/blob/master/autogpt_platform/frontend/src/components/integrations/credentials-provider.tsx).
You will also need to add the provider to the credentials provider list in [`frontend/src/components/integrations/helper.ts`](https://github.com/Significant-Gravitas/AutoGPT/blob/master/autogpt_platform/frontend/src/components/integrations/helper.ts).
```ts title="frontend/src/components/integrations/credentials-provider.tsx"
--8<-- "autogpt_platform/frontend/src/components/integrations/credentials-provider.tsx:CredentialsProviderNames"
```ts title="frontend/src/components/integrations/helper.ts"
--8<-- "autogpt_platform/frontend/src/components/integrations/helper.ts:CredentialsProviderNames"
```
Finally you will need to add the provider to the `CredentialsType` enum in [`frontend/src/lib/autogpt-server-api/types.ts`](https://github.com/Significant-Gravitas/AutoGPT/blob/master/autogpt_platform/frontend/src/lib/autogpt-server-api/types.ts).