mirror of
https://github.com/Significant-Gravitas/AutoGPT.git
synced 2026-11-09 17:53:56 -10:00
dev
3
Commits
| Author | SHA1 | Message | Date | |
|---|---|---|---|---|
|
71de2f0104 |
feat(platform): self-host from the Docker Hub image, with a Windows installer (#14553)
### Why / What / How
**Why:** The single-container image has been public on Docker Hub since
2026-08-11 (`latest` = `v0.8.4`, `linux/amd64` + `linux/arm64`, ~8.9k
pulls). Even so, the root README, the self-hosting guide and the
installer reference said its tags were not public, and sent everyone to
the from-source Compose path. I audited every self-hosting doc against
the code. The audit also turned up instructions that break installs, and
others that point at UI, services and paths that no longer exist.
Windows had no installer at all: #13261 withheld it until standard-user
filesystem checks and the handling of Docker arguments from Windows
PowerShell were validated. Two of #13240's items are still open on
`dev`, the Ollama troubleshooting path and the Llama provider link, and
this PR fixes both. Its other three are already fixed there.
**What:** Docs, the image's description label, and a Windows installer
at parity with `install.sh`.
- Self-hosters now start from the Docker Hub image wherever they land:
the README, the self-hosting guide, the Docker Hub page and the overview
pages.
- The image goes live with the release this PR ships in, so nothing
calls it experimental any more.
- `setup.agpt.co` serves the release installers from `master`, so the
installer page and the guide present the hosted command for Linux, macOS
and Windows.
- Stale instructions are corrected. Each document keeps its own voice
and format.
- The Windows installer was reviewed as #15770 and is folded in here.
**How:**
- Every claim is checked against the code
(`autogpt_platform/single-container/*`, the installer scripts, the
Compose files, the publish workflow), against Docker Hub, and against
the live docs site.
- The `docker run` quick start is byte-identical in the README, the
self-hosting guide and the Docker Hub README, and it matches the live
Docker Hub page.
- GitBook renders two callout syntaxes as literal text: `!!! warning`
and `> [!WARNING]`. They are now `{% hint %}` blocks, which 12 other
platform pages already use.
- GitBook rendering was checked on a preview build of these docs
(#15157, a preview only, not to be merged).
- `install.ps1` follows `install.sh` function by function, with the same
flags, labels, runtime contract and lifecycle marker. The
Windows-specific parts:
- It accepts only a local `npipe://` Docker endpoint.
- The state directory and its files get a protected ACL that makes the
current user their owner and only principal.
- It refuses a path with a junction, symlink, short name, stream or
network drive, and a path where another account can rename, delete or
re-permission a folder.
- It starts `docker.exe` itself, quoting arguments by the Windows rules,
because Windows PowerShell 5.1 strips the double quotes inside Go
templates.
- Merged with `dev` three times, most recently on 2026-10-20. The first
merge, after #15611 rewrote the README, lists how its two conflicts were
resolved. The other merges had none.
Fixes #13240
### Changes 🏗️
**Docker Hub path**
- Nothing calls the image experimental any more. That covers the README,
the Docker Hub README, the self-hosting guide, the single-container
guide's title and `SUMMARY.md` entry, the platform overview, and the
Dockerfile's `org.opencontainers.image.description` label. The Docker
Hub README and the guide still say it is for local and small
installations, not high-availability deployments.
- `README.md`:
- The self-host section is a quick start only: the
`significantgravitas/autogpt` link, the `docker run`, admin promotion,
and links to the single-container and Compose guides. It replaces the
installer sentence. The section's intro and comparison table are
#15611's, and the detail lives in the docs.
- One line points Linux, macOS and Windows users at the installer.
- Adds a Docker Hub version badge next to the Discord badge.
- Comparison table: the Model access row adds "or a local model".
- `docs/platform/getting-started.md`:
- New "Quick Setup with Docker" section before Manual Setup, including
the `AUTOGPT_PUBLIC_URL` rule. The appliance installer section links to
the installer.
- Adds a Compose network-exposure warning.
- Corrects the Manual Setup prerequisites: `make` and Python 3 are
needed, and Node.js only for frontend development or the Supabase
migration.
- Fixes the Makefile table, renders the ports as a list, and scopes the
secrets-upgrade section to Compose installs.
- `autogpt_platform/single-container/README.md`, which is the Docker Hub
page. It reaches the Hub on the next release.
- Sign out and back in after promotion; explicit close-signup steps.
- Remote access, default provider keys, and WSL 2 memory.
- New Upgrading section and a release-notes link.
- Tag wording updated.
- `docs/platform/installer.md`:
- The hosted command is documented for Linux, macOS and Windows, without
the not-live warning. A Windows column joins the Options table.
- The release gates are a checklist for every release: the image gates,
plus fetching each hosted installer and clean installs. The section
lists the three hosted files, which redirect to `master`. Only releases
publish images; `dev` pushes and dispatches don't.
- Ollama defaults corrected (Ornith 1.5 9B, context 262144), with an
example tag that exists.
- Adds the bootstrap prerequisites, a cold-backup link and how to invoke
the scripts.
- `docs/platform/SUMMARY.md`: the single-container guide is listed
before the installer page.
- Entry pages:
- `what-is-autogpt-platform.md`: self-host bullet, plus the image's
bundled third-party licenses, including FalkorDB under SSPL-1.0.
- `getting-started-cloud.md`.
- `docs/home/README.md`: "Self-Host with Docker" link, Integrations
blurb, Classic label.
- `autogpt_platform/README.md` pointer.
**Windows installer**
- `autogpt_platform/installer/install.ps1` (new): the Windows release
installer described under How. It runs on Windows PowerShell 5.1 and
PowerShell 7 as a standard user, and it is kept ASCII, because 5.1 reads
a script without a byte-order mark as ANSI.
- `autogpt_platform/installer/install.bat` (new): runs `install.ps1` the
same way as the documented command. It is there for the `install.bat`
command older tutorials use.
- `autogpt_platform/installer/test-windows-installer.ps1` (new):
- The bash suite's cases, with fake `docker.exe`, `curl.exe` and
`powershell.exe`. The fake `docker.exe` checks each `--format` exactly
as received, so a dropped quote fails.
- Windows path and ACL cases.
- The documented command, read from `installer.md`, and `install.bat`,
run inside a session and with `-File`.
- `autogpt_platform/installer/test-single-container-handoff.sh`: the
bootstrap guard rejects `iwr`, `irm`, `iex`, `Invoke-*` and `curl … |
bash` in all four bootstrap files, and requires the HTTPS-only curl
flags.
- `.github/workflows/platform-installer-ci.yml`: a `windows-2025` job
runs the suite under both PowerShell editions.
- Hosting: `setup.agpt.co/install.ps1` and `/install.bat` redirect to
these files on `master`, the same way `/install.sh` does, so they go
live with this release. Until then they return 404 and run nothing.
**Correctness fixes found in the audit**
- `single-container.md`:
- **Local Ollama profile:** it now pins `GRAPHITI_LLM_MODEL` and
`GRAPHITI_RERANKER_MODEL` to the documented 4B model. Graphiti's local
default moved to Ornith in #14188, so following the profile left memory
calling a model that was never pulled.
- **Embedder key:** documents that `OPENAI_API_KEY` is sent to the local
endpoint unless `GRAPHITI_EMBEDDER_API_KEY` is set.
- **Ollama bind:** on Docker Engine, Ollama must listen beyond loopback.
- **`supervisorctl`:** it needs `-c`; the bare command can't reach the
appliance's socket.
- **WSL 2 memory:** set through `.wslconfig`.
- **`--shm-size` rationale:** corrected; Codex stopped using `/dev/shm`
in #14195.
- **Tags and boot:** `sha-` tags are release-only. Also documents the
skills-catalog publish on boot and the watchdog timing.
- `advanced_setup.md`:
- `cp .env.default .env` overwrote a generated `ENCRYPTION_KEY`.
- Removed the unsupported `./secrets` directory, the nonexistent
`postgres/schema.prisma` and `rnd/` paths, and the Poetry 1 `poetry
shell` steps.
- Documents an external Postgres setup from the code.
- `autogpt_platform/README.md`:
- Uses `make init-env` instead of `cp .env.default .env`; without a
generated `ENCRYPTION_KEY` the backend refuses to start.
- Uses the real service names `rest_server` and `websocket_server`.
- Removes the `--scale executor=3` scenario, which fails on the
executor's fixed host port.
- Explains `down` versus `down -v`.
- Persisting Data now describes the existing bind mount and volumes, and
warns against volumes on the Redis nodes.
- Tutorials and references:
- The marketplace download and import steps match the current UI.
- The first-agent tutorial says how provider keys reach the Docker image
(`--env-file`) and an installer install (the installer's `autogpt.env`),
next to the Compose path.
- The credentials, OAuth redirect URI, External API and local-LLM pages
cover the image.
- `db/docker/README.md` says what the folder does today: its
`.gitignore` keeps local database and storage data out of Git. It links
the upgrade guide and the `db` service the platform runs. The canary-tag
lines and the installer page describe things as they are now, without
"legacy" or "no longer".
**#13240's remaining items**
- `docs/platform/ollama.md`: troubleshooting names the LLM catalog files
that the "Add Custom Models" section uses. It used to name
`backend/api/model.py`, which holds no model list. The section also gets
a relative setup link.
- `docs/platform/what-is-autogpt-platform.md`: the Llama provider links
`https://www.llama.com/`, not LlamaIndex. Meta's Llama API page is gone,
and llama.com points at Meta's current developer site.
- Self-hosting guide links use `agpt.co/docs/platform/self-hosting/...`,
as the README has since #15682.
### Agents and large language models used
- Grok Bot (autogpt-fix local) — model id not exposed (original link
fixes)
- Claude Code — Claude Opus 5.5 (self-hosting docs audit and refresh,
Windows installer)
### 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] #13240 reproduced on `dev` (
|
||
|
Otto
|
7ee94d986c |
docs: add credentials prerequisites to create-basic-agent guide (#11913)
## Summary Addresses #11785 - users were encountering `openai_api_key_credentials` errors when following the create-basic-agent guide because it didn't mention the need to configure API credentials before using AI blocks. ## Changes Added a **Prerequisites** section to `docs/platform/create-basic-agent.md` explaining: - **Cloud users:** Go to Profile → Integrations to add API keys - **Self-hosted (Docker):** Add keys to `autogpt_platform/backend/.env` and restart services Also added a note that the Calculator example doesn't need credentials, making it a good first test. ## Related - Issue: #11785 |
||
|
Nicholas TindleandClaude Opus 4.5
|
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
|