Skip to content

Commit b1a9f47

Browse files
committed
docs: add system requirements section to README (#10050)
1 parent 793d056 commit b1a9f47

File tree

1 file changed

+29
-2
lines changed

1 file changed

+29
-2
lines changed

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,35 @@
1515
> Setting up and hosting the AutoGPT Platform yourself is a technical process.
1616
> If you'd rather something that just works, we recommend [joining the waitlist](https://bit.ly/3ZDijAI) for the cloud-hosted beta.
1717
18+
### System Requirements
19+
20+
Before proceeding with the installation, ensure your system meets the following requirements:
21+
22+
#### Hardware Requirements
23+
- CPU: 4+ cores recommended
24+
- RAM: Minimum 8GB, 16GB recommended
25+
- Storage: At least 10GB of free space
26+
27+
#### Software Requirements
28+
- Operating Systems:
29+
- Linux (Ubuntu 20.04 or newer recommended)
30+
- macOS (10.15 or newer)
31+
- Windows 10/11 with WSL2
32+
- Required Software (with minimum versions):
33+
- Docker Engine (20.10.0 or newer)
34+
- Docker Compose (2.0.0 or newer)
35+
- Git (2.30 or newer)
36+
- Node.js (16.x or newer)
37+
- npm (8.x or newer)
38+
- VSCode (1.60 or newer) or any modern code editor
39+
40+
#### Network Requirements
41+
- Stable internet connection
42+
- Access to required ports (will be configured in Docker)
43+
- Ability to make outbound HTTPS connections
44+
1845
### Updated Setup Instructions:
19-
Weve moved to a fully maintained and regularly updated documentation site.
46+
We've moved to a fully maintained and regularly updated documentation site.
2047

2148
👉 [Follow the official self-hosting guide here](https://docs.agpt.co/platform/getting-started/)
2249

@@ -152,7 +179,7 @@ Just clone the repo, install dependencies with `./run setup`, and you should be
152179

153180
[![Join us on Discord](https://invidget.switchblade.xyz/autogpt)](https://discord.gg/autogpt)
154181

155-
To report a bug or request a feature, create a [GitHub Issue](https://github.com/Significant-Gravitas/AutoGPT/issues/new/choose). Please ensure someone else hasnt created an issue for the same topic.
182+
To report a bug or request a feature, create a [GitHub Issue](https://github.com/Significant-Gravitas/AutoGPT/issues/new/choose). Please ensure someone else hasn't created an issue for the same topic.
156183

157184
## 🤝 Sister projects
158185

0 commit comments

Comments
 (0)