summaryrefslogtreecommitdiffstats
path: root/docs/docker.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/docker.md')
-rw-r--r--docs/docker.md19
1 files changed, 9 insertions, 10 deletions
diff --git a/docs/docker.md b/docs/docker.md
index 6baf386a..db33b925 100644
--- a/docs/docker.md
+++ b/docs/docker.md
@@ -1,38 +1,37 @@
-### G4F - Docker
+### G4F - Docker Setup
-If you have Docker installed, you can easily set up and run the project without manually installing dependencies.
-
-1. First, ensure you have both Docker and Docker Compose installed.
+Easily set up and run the G4F project using Docker without the hassle of manual dependency installation.
+1. **Prerequisites:**
- [Install Docker](https://docs.docker.com/get-docker/)
- [Install Docker Compose](https://docs.docker.com/compose/install/)
-2. Clone the GitHub repo:
+2. **Clone the Repository:**
```bash
git clone https://github.com/xtekky/gpt4free.git
```
-3. Navigate to the project directory:
+3. **Navigate to the Project Directory:**
```bash
cd gpt4free
```
-4. Build the Docker image:
+4. **Build the Docker Image:**
```bash
docker pull selenium/node-chrome
docker-compose build
```
-5. Start the service using Docker Compose:
+5. **Start the Service:**
```bash
docker-compose up
```
-Your server will now be running at `http://localhost:1337`. You can interact with the API or run your tests as you would normally.
+Your server will now be accessible at `http://localhost:1337`. Interact with the API or run tests as usual.
To stop the Docker containers, simply run:
@@ -41,6 +40,6 @@ docker-compose down
```
> [!Note]
-> When using Docker, any changes you make to your local files will be reflected in the Docker container thanks to the volume mapping in the `docker-compose.yml` file. If you add or remove dependencies, however, you'll need to rebuild the Docker image using `docker-compose build`.
+> Changes made to local files reflect in the Docker container due to volume mapping in `docker-compose.yml`. However, if you add or remove dependencies, rebuild the Docker image using `docker-compose build`.
[Return to Home](/) \ No newline at end of file