mirror of https://github.com/Significant-Gravitas/AutoGPT.git synced 2026-01-14 17:47:57 -05:00

Files

Nicholas Tindle a318832414 feat(docs): update dev from gitbook changes (#11740 )

<!-- Clearly explain the need for these changes: -->
gitbook branch has changes that need synced to dev
### Changes 🏗️
Pull changes from gitbook into dev
<!-- Concisely describe all of the changes made in this pull request:
-->

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Migrates documentation to GitBook and removes the old MkDocs setup.
> 
> - Removes MkDocs configuration and infra: `docs/mkdocs.yml`,
`docs/netlify.toml`, `docs/overrides/main.html`,
`docs/requirements.txt`, and JS assets (`_javascript/mathjax.js`,
`_javascript/tablesort.js`)
> - Updates `docs/content/contribute/index.md` to describe GitBook
workflow (gitbook branch, editing, previews, and `SUMMARY.md`)
> - Adds GitBook navigation file `docs/platform/SUMMARY.md` and a new
platform overview page `docs/platform/what-is-autogpt-platform.md`
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
e7e118b5a8. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Updated contribution guide for new documentation platform and workflow
  * Added new platform overview and navigation documentation

* **Chores**
  * Removed MkDocs configuration and related dependencies
  * Removed deprecated JavaScript integrations and deployment overrides

<sub>✏️ Tip: You can customize this high-level summary in your review
settings.</sub>

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>

2026-01-09 19:22:05 +00:00

1.9 KiB

Raw Blame History

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:

Check for required prerequisites (Git, Docker, npm)
Clone the AutoGPT repository
Set up the backend services using Docker
Set up the frontend application
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

curl -fsSL https://setup.agpt.co/install.sh -o install.sh && bash install.sh

Windows

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

These scripts are located in the autogpt_platform/installer/ directory.

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:

cd AutoGPT/autogpt_platform
docker compose down

Troubleshooting

If you encounter any issues during installation:

Make sure all prerequisites are correctly installed
Check that Docker is running
Ensure you have a stable internet connection
Verify you have sufficient permissions to create directories and run Docker

1.9 KiB Raw Blame History