Skip to content

Commit

Permalink
docs: Add workspace information to AutoGPT user guide
Browse files Browse the repository at this point in the history
- Added information about the workspace folder in the AutoGPT user guide
- Clarified that files outside the workspace folder are inaccessible unless RESTRICT_TO_WORKSPACE is set to False. Provided a warning against disabling RESTRICT_TO_WORKSPACE unless in a sandbox environment.
  • Loading branch information
Pwuts committed Nov 25, 2023
1 parent 809173c commit e70a612
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/content/AutoGPT/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,17 @@ in various ways:
its history.
* Share your agent!

## Workspace
[workspace]: #workspace

Agents can read and write files. This happens in the `workspace` folder, which
is in `data/agents/<agent_id>/`. Files outside of this folder can not be accessed by the
agent *unless* `RESTRICT_TO_WORKSPACE` is set to `False`.

!!! warning
We do not recommend disabling `RESTRICT_TO_WORKSPACE`, unless AutoGPT is running in
a sandbox environment where it couldn't do any damage (e.g. Docker or a VM).
## Logs
Activity, Error, and Debug logs are located in `logs`.
Expand Down

0 comments on commit e70a612

Please sign in to comment.