mirror of
https://github.com/Significant-Gravitas/AutoGPT.git
synced 2026-01-09 15:17:59 -05:00
22d58367ec
This PR adds two setup scripts that will setup autogpt fully, it has a windows .bat and a linux/mac .sh script, for now they are placed in a new folder called "Installer" ### Note, the installers are supposed to be run outside of the autogpt repo folder like Desktop/in a new empy folder because it will clone the repo into the current directory. I have had to add ``cross-env`` via ``pnpm add cross-env `` as on windows the env is set differently in the ``package.json`` build section ``"build": "cross-env pnpm run generate:api-client && SKIP_STORYBOOK_TESTS=true next build"`` once fully setup i plan to make it so these commands can be run with the following commands Linux/Mac ```bash curl -fsSL https://setup.agpt.co/install.sh -o install.sh && bash install.sh ``` Windows cmd/powershell ```bash powershell -c "iwr https://setup.agpt.co/install.bat -o install.bat; ./install.bat" ``` Currently the commands above dont work but will later on! ### Checklist 📋 #### For code changes: - [x] I have clearly listed my changes in the PR description - [x] I have made a test plan - [x] I have tested my changes according to the test plan: - [x] I have tested the linux ``install.sh`` on a ubuntu system and it setup the platform fully. - [x] I have tested the windows ``install.bat`` on my windows system and it setup the platform fully. - [x] I have tested on both OS's and checked with missing prerequisites to see if it shows the errors and it does
70 lines
2.0 KiB
Markdown
70 lines
2.0 KiB
Markdown
# AutoGPT Platform Installer
|
|
|
|
The AutoGPT Platform provides easy-to-use installers to help you quickly set up the platform on your system. This page covers how to use the installer scripts for both Linux/macOS and Windows.
|
|
|
|
## What the Installer Does
|
|
|
|
The installer scripts will:
|
|
|
|
1. Check for required prerequisites (Git, Docker, npm)
|
|
2. Clone the AutoGPT repository
|
|
3. Set up the backend services using Docker
|
|
4. Set up the frontend application
|
|
5. Start both the backend and frontend services
|
|
|
|
## Prerequisites
|
|
|
|
Before running the installer, make sure you have the following installed:
|
|
|
|
- **Git**: For cloning the repository
|
|
- **Docker**: For running the backend services
|
|
- **Node.js and npm**: For the frontend application
|
|
|
|
## Quick One-Liner Installation
|
|
|
|
For convenience, you can use the following one-liner commands to install AutoGPT Platform:
|
|
|
|
### Linux/macOS
|
|
|
|
```bash
|
|
curl -fsSL https://setup.agpt.co/install.sh -o install.sh && bash install.sh
|
|
```
|
|
|
|
### Windows
|
|
|
|
```powershell
|
|
powershell -c "iwr https://setup.agpt.co/install.bat -o install.bat; ./install.bat"
|
|
```
|
|
|
|
## Manual Installation
|
|
|
|
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.
|
|
|
|
## After Installation
|
|
|
|
Once the installation is complete:
|
|
- The backend services will be running in Docker containers
|
|
- The frontend application will be available at http://localhost:3000
|
|
|
|
## Stopping the Services
|
|
|
|
To stop the services, press Ctrl+C in the terminal where the frontend is running, then run:
|
|
|
|
```bash
|
|
cd AutoGPT/autogpt_platform
|
|
docker compose down
|
|
```
|
|
|
|
## Troubleshooting
|
|
|
|
If you encounter any issues during installation:
|
|
|
|
1. Make sure all prerequisites are correctly installed
|
|
2. Check that Docker is running
|
|
3. Ensure you have a stable internet connection
|
|
4. Verify you have sufficient permissions to create directories and run Docker |