summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorHeiner Lohaus <hlohaus@users.noreply.github.com>2024-11-17 11:06:37 +0100
committerHeiner Lohaus <hlohaus@users.noreply.github.com>2024-11-17 11:06:37 +0100
commitea1448001df9c66f05a52618eb3e40a88df5efe8 (patch)
tree3f113ea8beb7c43920871019512aeb8de9d1b4f7 /docs
parentFix api streaming, fix AsyncClient (#2357) (diff)
downloadgpt4free-ea1448001df9c66f05a52618eb3e40a88df5efe8.tar
gpt4free-ea1448001df9c66f05a52618eb3e40a88df5efe8.tar.gz
gpt4free-ea1448001df9c66f05a52618eb3e40a88df5efe8.tar.bz2
gpt4free-ea1448001df9c66f05a52618eb3e40a88df5efe8.tar.lz
gpt4free-ea1448001df9c66f05a52618eb3e40a88df5efe8.tar.xz
gpt4free-ea1448001df9c66f05a52618eb3e40a88df5efe8.tar.zst
gpt4free-ea1448001df9c66f05a52618eb3e40a88df5efe8.zip
Diffstat (limited to 'docs')
-rw-r--r--docs/docker.md24
1 files changed, 19 insertions, 5 deletions
diff --git a/docs/docker.md b/docs/docker.md
index 8017715c..ce7fd466 100644
--- a/docs/docker.md
+++ b/docs/docker.md
@@ -28,12 +28,22 @@
```
2. **Build and Run with Docker Compose**
+
+ Pull the latest image and run a container with Google Chrome support:
+ ```bash
+ docker pull hlohaus789/g4f
+ docker-compose up -d
+ ```
+ Or run the small docker images without Google Chrome:
```bash
- docker-compose up --build
+ docker-compose -f docker-compose-slim.yml up -d
```
-3. **Access the API**
- The server will be accessible at `http://localhost:1337`
+3. **Access the API or the GUI**
+
+ The api server will be accessible at `http://localhost:1337`
+
+ And the gui at this url: `http://localhost:8080`
### Non-Docker Method
If you encounter issues with Docker, you can run the project directly using Python:
@@ -54,8 +64,12 @@ If you encounter issues with Docker, you can run the project directly using Pyth
python -m g4f.api.run
```
-4. **Access the API**
- The server will be accessible at `http://localhost:1337`
+4. **Access the API or the GUI**
+
+ The api server will be accessible at `http://localhost:1337`
+
+ And the gui at this url: `http://localhost:8080`
+
## Testing the API
**You can test the API using curl or by creating a simple Python script:**