You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .devcontainer/README.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -10,21 +10,21 @@ These configurations can be used with Codespaces and locally.
10
10
11
11
-**Purpose**: This Dockerfile, i.e., `./Dockerfile`, is designed for basic setups. It includes common Python libraries and essential dependencies required for general usage of AutoGen.
12
12
-**Usage**: Ideal for those just starting with AutoGen or for general-purpose applications.
13
-
-**Building the Image**: Run `docker build -f ./Dockerfile -t autogen_ai_base_img .` in this directory.
13
+
-**Building the Image**: Run `docker build -f ./Dockerfile -t autogenhub_base_img .` in this directory.
14
14
-**Using with Codespaces**: `Code > Codespaces > Click on +` By default + creates a Codespace on the current branch.
15
15
16
16
### full
17
17
18
18
-**Purpose**: This Dockerfile, i.e., `./full/Dockerfile` is for advanced features. It includes additional dependencies and is configured for more complex or feature-rich AutoGen applications.
19
19
-**Usage**: Suited for advanced users who need the full range of AutoGen's capabilities.
-**Using with Codespaces**: `Code > Codespaces > Click on ...> New with options > Choose "full" as devcontainer configuration`. This image may require a Codespace with at least 64GB of disk space.
22
22
23
23
### dev
24
24
25
25
-**Purpose**: Tailored for AutoGen project developers, this Dockerfile, i.e., `./dev/Dockerfile` includes tools and configurations aiding in development and contribution.
26
26
-**Usage**: Recommended for developers who are contributing to the AutoGen project.
27
-
-**Building the Image**: Run `docker build -f dev/Dockerfile -t autogen_ai_dev_img .`.
27
+
-**Building the Image**: Run `docker build -f dev/Dockerfile -t autogenhub_dev_img .`.
28
28
-**Using with Codespaces**: `Code > Codespaces > Click on ...> New with options > Choose "dev" as devcontainer configuration`. This image may require a Codespace with at least 64GB of disk space.
29
29
-**Before using**: We highly encourage all potential contributors to read the [AutoGen Contributing](https://autogenhub.github.io/autogen/docs/Contribute) page prior to submitting any pull requests.
Copy file name to clipboardExpand all lines: website/docs/contributor-guide/docker.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -2,20 +2,20 @@
2
2
3
3
For developers contributing to the AutoGen project, we offer a specialized Docker environment. This setup is designed to streamline the development process, ensuring that all contributors work within a consistent and well-equipped environment.
4
4
5
-
## Autogen Developer Image (autogen_ai_dev_img)
5
+
## Autogen Developer Image (autogenhub_dev_img)
6
6
7
-
-**Purpose**: The `autogen_ai_dev_img` is tailored for contributors to the AutoGen project. It includes a suite of tools and configurations that aid in the development and testing of new features or fixes.
7
+
-**Purpose**: The `autogenhub_dev_img` is tailored for contributors to the AutoGen project. It includes a suite of tools and configurations that aid in the development and testing of new features or fixes.
8
8
-**Usage**: This image is recommended for developers who intend to contribute code or documentation to AutoGen.
9
9
-**Forking the Project**: It's advisable to fork the AutoGen GitHub project to your own repository. This allows you to make changes in a separate environment without affecting the main project.
10
10
-**Updating Dockerfile**: Modify your copy of `Dockerfile` in the `dev` folder as needed for your development work.
11
11
-**Submitting Pull Requests**: Once your changes are ready, submit a pull request from your branch to the upstream AutoGen GitHub project for review and integration. For more details on contributing, see the [AutoGen Contributing](https://autogenhub.github.io/autogen/docs/Contribute) page.
12
12
13
13
## Building the Developer Docker Image
14
14
15
-
- To build the developer Docker image (`autogen_ai_dev_img`), use the following commands:
15
+
- To build the developer Docker image (`autogenhub_dev_img`), use the following commands:
- For building the developer image built from a specific Dockerfile in a branch other than main/master
@@ -33,16 +33,16 @@ For developers contributing to the AutoGen project, we offer a specialized Docke
33
33
34
34
## Using the Developer Docker Image
35
35
36
-
Once you have built the `autogen_ai_dev_img`, you can run it using the standard Docker commands. This will place you inside the containerized development environment where you can run tests, develop code, and ensure everything is functioning as expected before submitting your contributions.
36
+
Once you have built the `autogenhub_dev_img`, you can run it using the standard Docker commands. This will place you inside the containerized development environment where you can run tests, develop code, and ensure everything is functioning as expected before submitting your contributions.
37
37
38
38
```bash
39
-
docker run -it -p 8081:3000 -v `pwd`/autogen-newcode:newstuff/ autogen_ai_dev_img bash
39
+
docker run -it -p 8081:3000 -v `pwd`/autogen-newcode:newstuff/ autogenhub_dev_img bash
40
40
```
41
41
42
42
- Note that the `pwd` is shorthand for present working directory. Thus, any path after the pwd is relative to that. If you want a more verbose method you could remove the "`pwd`/autogen-newcode" and replace it with the full path to your directory
43
43
44
44
```bash
45
-
docker run -it -p 8081:3000 -v /home/AutoGenDeveloper/autogen-newcode:newstuff/ autogen_ai_dev_img bash
45
+
docker run -it -p 8081:3000 -v /home/AutoGenDeveloper/autogen-newcode:newstuff/ autogenhub_dev_img bash
Copy file name to clipboardExpand all lines: website/docs/installation/Docker.md
+11-11
Original file line number
Diff line number
Diff line change
@@ -4,8 +4,8 @@ Docker, an indispensable tool in modern software development, offers a compellin
4
4
5
5
**Pre-configured DockerFiles**: The AutoGen Project offers pre-configured Dockerfiles for your use. These Dockerfiles will run as is, however they can be modified to suit your development needs. Please see the README.md file in autogen/.devcontainer
6
6
7
-
-**autogen_ai_base_img**: For a basic setup, you can use the `autogen_ai_base_img` to run simple scripts or applications. This is ideal for general users or those new to AutoGen.
8
-
-**autogen_ai_full_img**: Advanced users or those requiring more features can use `autogen_ai_full_img`. Be aware that this version loads ALL THE THINGS and thus is very large. Take this into consideration if you build your application off of it.
7
+
-**autogenhub_base_img**: For a basic setup, you can use the `autogenhub_base_img` to run simple scripts or applications. This is ideal for general users or those new to AutoGen.
8
+
-**autogenhub_full_img**: Advanced users or those requiring more features can use `autogenhub_full_img`. Be aware that this version loads ALL THE THINGS and thus is very large. Take this into consideration if you build your application off of it.
9
9
10
10
## Step 1: Install Docker
11
11
@@ -20,13 +20,13 @@ AutoGen now provides updated Dockerfiles tailored for different needs. Building
20
20
-**Autogen Basic**: Ideal for general use, this setup includes common Python libraries and essential dependencies. Perfect for those just starting with AutoGen.
## Step 3: Run AutoGen Applications from Docker Image
@@ -36,7 +36,7 @@ Here's how you can run an application built with AutoGen, using the Docker image
36
36
1.**Mount Your Directory**: Use the Docker `-v` flag to mount your local application directory to the Docker container. This allows you to develop on your local machine while running the code in a consistent Docker environment. For example:
37
37
38
38
```bash
39
-
docker run -it -v $(pwd)/myapp:/home/autogenhub/autogen/myapp autogen_ai_base_img:latest python /home/autogenhub/autogen/myapp/main.py
39
+
docker run -it -v $(pwd)/myapp:/home/autogenhub/autogen/myapp autogenhub_base_img:latest python /home/autogenhub/autogen/myapp/main.py
40
40
```
41
41
42
42
Here, `$(pwd)/myapp` is your local directory, and `/home/autogenhub/autogen/myapp` is the path in the Docker container where your code will be located.
@@ -45,13 +45,13 @@ Here's how you can run an application built with AutoGen, using the Docker image
45
45
46
46
```python
47
47
# Mount the local folder `myapp` into docker image and run the script named "twoagent.py" in the docker.
48
-
docker run -it -v `pwd`/myapp:/myapp autogen_ai_base_img:latest python /myapp/main_twoagent.py
48
+
docker run -it -v `pwd`/myapp:/myapp autogenhub_base_img:latest python /myapp/main_twoagent.py
49
49
```
50
50
51
51
3.**Port Mapping**: If your application requires a specific port, use the `-p` flag to map the container's port to your host. For instance, if your app runs on port 3000 inside Docker and you want it accessible on port 8080 on your host machine:
52
52
53
53
```bash
54
-
docker run -it -p 8080:3000 -v $(pwd)/myapp:/myapp autogen_ai_base_img:latest python /myapp
54
+
docker run -it -p 8080:3000 -v $(pwd)/myapp:/myapp autogenhub_base_img:latest python /myapp
55
55
```
56
56
57
57
In this command, `-p 8080:3000` maps port 3000 from the container to port 8080 on your local machine.
0 commit comments