Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

mention docker rebuild is necessary if changing requirements.txt #4136

Merged
merged 5 commits into from
May 17, 2023
Merged

mention docker rebuild is necessary if changing requirements.txt #4136

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bd08c4d
mention that the docker rebuild is necessary if requirements.txt is m…
Boostrix May 12, 2023
89c4cb2
mention docker being required for some features
Boostrix May 12, 2023
0dbc451
Merge branch 'master' into topics/requirements.txt-and-docker-build
ntindle May 17, 2023
fdcdfc7
Merge branch 'master' into topics/requirements.txt-and-docker-build
ntindle May 17, 2023
aad979c
Merge branch 'master' into topics/requirements.txt-and-docker-build
ntindle May 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Get your OpenAI API key from: [https://platform.openai.com/account/api-keys](htt
### Set up without Git/Docker

!!! warning
We recommend to use Git or Docker, to make updating easier.
We recommend to use Git or Docker, to make updating easier. Also note that some features such as Python execution will only work inside docker for security reasons.

1. Download `Source code (zip)` from the [latest stable release](https://github.com/Significant-Gravitas/Auto-GPT/releases/latest)
2. Extract the zip-file into a folder
Expand Down Expand Up @@ -169,7 +169,7 @@ If you need to upgrade Docker Compose to a newer version, you can follow the ins

Once you have a recent version of docker-compose, run the commands below in your Auto-GPT folder.

1. Build the image. If you have pulled the image from Docker Hub, skip this step.
1. Build the image. If you have pulled the image from Docker Hub, skip this step (NOTE: You *will* need to do this if you are modifying requirements.txt to add/remove depedencies like Python libs/frameworks)

:::shell
docker-compose build auto-gpt
Expand Down Expand Up @@ -211,6 +211,9 @@ docker run -it --env-file=.env -v $PWD:/app --rm auto-gpt --gpt3only --continuou

### Run without Docker

!!! warning
Due to security reasons, certain features (like Python execution) will by default be disabled when running without docker. So, even if you want to run the program outside a docker container, you currently still need docker to actually run scripts.

Simply run the startup script in your terminal. This will install any necessary Python
packages and launch Auto-GPT.

Expand Down