Skip to content

Commit bf6b15c

Browse files
authored
Update to docker tag names (#76)
* devcontainer Docker name update * Installation Docker name update * Contributor guide Docker name update * Contributor guide Docker name update
1 parent e90aee4 commit bf6b15c

File tree

4 files changed

+23
-23
lines changed

4 files changed

+23
-23
lines changed

.devcontainer/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,21 @@ These configurations can be used with Codespaces and locally.
1010

1111
- **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.
1212
- **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.
1414
- **Using with Codespaces**: `Code > Codespaces > Click on +` By default + creates a Codespace on the current branch.
1515

1616
### full
1717

1818
- **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.
1919
- **Usage**: Suited for advanced users who need the full range of AutoGen's capabilities.
20-
- **Building the Image**: Execute `docker build -f full/Dockerfile -t autogen_ai_full_img .`.
20+
- **Building the Image**: Execute `docker build -f full/Dockerfile -t autogenhub_full_img .`.
2121
- **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.
2222

2323
### dev
2424

2525
- **Purpose**: Tailored for AutoGen project developers, this Dockerfile, i.e., `./dev/Dockerfile` includes tools and configurations aiding in development and contribution.
2626
- **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 .`.
2828
- **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.
2929
- **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.
3030

website/docs/contributor-guide/docker.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@
22

33
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.
44

5-
## Autogen Developer Image (autogen_ai_dev_img)
5+
## Autogen Developer Image (autogenhub_dev_img)
66

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.
88
- **Usage**: This image is recommended for developers who intend to contribute code or documentation to AutoGen.
99
- **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.
1010
- **Updating Dockerfile**: Modify your copy of `Dockerfile` in the `dev` folder as needed for your development work.
1111
- **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.
1212

1313
## Building the Developer Docker Image
1414

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:
1616

1717
```bash
18-
docker build -f .devcontainer/dev/Dockerfile -t autogen_ai_dev_img https://github.com/autogenhub/autogen.git#main
18+
docker build -f .devcontainer/dev/Dockerfile -t autogenhub_dev_img https://github.com/autogenhub/autogen.git#main
1919
```
2020

2121
- 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
3333

3434
## Using the Developer Docker Image
3535

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.
3737

3838
```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
4040
```
4141

4242
- 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
4343

4444
```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
4646
```
4747

4848
## Develop in Remote Container

website/docs/contributor-guide/documentation.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,13 @@ Most changes are reflected live without having to restart the server.
3939
To build and test documentation within a docker container. Use the Dockerfile in the `dev` folder as described above to build your image:
4040

4141
```bash
42-
docker build -f .devcontainer/dev/Dockerfile -t autogen_ai_dev_img https://github.com/autogenhub/autogen.git#main
42+
docker build -f .devcontainer/dev/Dockerfile -t autogenhub_dev_img https://github.com/autogenhub/autogen.git#main
4343
```
4444

4545
Then start the container like so, this will log you in and ensure that Docker port 3000 is mapped to port 8081 on your local machine
4646

4747
```bash
48-
docker run -it -p 8081:3000 -v `pwd`/autogen-newcode:newstuff/ autogen_ai_dev_img bash
48+
docker run -it -p 8081:3000 -v `pwd`/autogen-newcode:newstuff/ autogenhub_dev_img bash
4949
```
5050

5151
Once at the CLI in Docker run the following commands:

website/docs/installation/Docker.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ Docker, an indispensable tool in modern software development, offers a compellin
44

55
**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
66

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.
99

1010
## Step 1: Install Docker
1111

@@ -20,13 +20,13 @@ AutoGen now provides updated Dockerfiles tailored for different needs. Building
2020
- **Autogen Basic**: Ideal for general use, this setup includes common Python libraries and essential dependencies. Perfect for those just starting with AutoGen.
2121

2222
```bash
23-
docker build -f .devcontainer/Dockerfile -t autogen_ai_base_img https://github.com/autogenhub/autogen.git#main
23+
docker build -f .devcontainer/Dockerfile -t autogenhub_base_img https://github.com/autogenhub/autogen.git#main
2424
```
2525

26-
- **Autogen Advanced**: Advanced users or those requiring all the things that AutoGen has to offer `autogen_ai_full_img`
26+
- **Autogen Advanced**: Advanced users or those requiring all the things that AutoGen has to offer `autogenhub_full_img`
2727

2828
```bash
29-
docker build -f .devcontainer/full/Dockerfile -t autogen_ai_full_img https://github.com/autogenhub/autogen.git#main
29+
docker build -f .devcontainer/full/Dockerfile -t autogenhub_full_img https://github.com/autogenhub/autogen.git#main
3030
```
3131

3232
## 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
3636
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:
3737

3838
```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
4040
```
4141

4242
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
4545

4646
```python
4747
# 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
4949
```
5050

5151
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:
5252

5353
```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
5555
```
5656

5757
In this command, `-p 8080:3000` maps port 3000 from the container to port 8080 on your local machine.
@@ -65,19 +65,19 @@ docker run -it -p {WorkstationPortNum}:{DockerPortNum} -v {WorkStation_Dir}:{Doc
6565
- _Simple Script_: Run a Python script located in your local `myapp` directory.
6666

6767
```bash
68-
docker run -it -v `pwd`/myapp:/myapp autogen_ai_base_img:latest python /myapp/my_script.py
68+
docker run -it -v `pwd`/myapp:/myapp autogenhub_base_img:latest python /myapp/my_script.py
6969
```
7070

7171
- _Web Application_: If your application includes a web server running on port 5000.
7272

7373
```bash
74-
docker run -it -p 8080:5000 -v $(pwd)/myapp:/myapp autogen_ai_base_img:latest
74+
docker run -it -p 8080:5000 -v $(pwd)/myapp:/myapp autogenhub_base_img:latest
7575
```
7676

7777
- _Data Processing_: For tasks that involve processing data stored in a local directory.
7878

7979
```bash
80-
docker run -it -v $(pwd)/data:/data autogen_ai_base_img:latest python /myapp/process_data.py
80+
docker run -it -v $(pwd)/data:/data autogenhub_base_img:latest python /myapp/process_data.py
8181
```
8282

8383
## Additional Resources

0 commit comments

Comments
 (0)