summaryrefslogtreecommitdiffstats
path: root/docs/docker.md
diff options
context:
space:
mode:
authorHeiner Lohaus <hlohaus@users.noreply.github.com>2024-02-19 19:34:28 +0100
committerHeiner Lohaus <hlohaus@users.noreply.github.com>2024-02-19 19:34:28 +0100
commit5612ee4c8d9ffbd0ddc958c1a16f588d9994b223 (patch)
tree626701d8b12e4c2e1bfa45dda16e8d69208551a7 /docs/docker.md
parentAdd MathJax to GUI #1563, Add model name to GUI #1600 (diff)
downloadgpt4free-5612ee4c8d9ffbd0ddc958c1a16f588d9994b223.tar
gpt4free-5612ee4c8d9ffbd0ddc958c1a16f588d9994b223.tar.gz
gpt4free-5612ee4c8d9ffbd0ddc958c1a16f588d9994b223.tar.bz2
gpt4free-5612ee4c8d9ffbd0ddc958c1a16f588d9994b223.tar.lz
gpt4free-5612ee4c8d9ffbd0ddc958c1a16f588d9994b223.tar.xz
gpt4free-5612ee4c8d9ffbd0ddc958c1a16f588d9994b223.tar.zst
gpt4free-5612ee4c8d9ffbd0ddc958c1a16f588d9994b223.zip
Diffstat (limited to 'docs/docker.md')
-rw-r--r--docs/docker.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/docker.md b/docs/docker.md
new file mode 100644
index 00000000..6baf386a
--- /dev/null
+++ b/docs/docker.md
@@ -0,0 +1,46 @@
+### G4F - Docker
+
+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.
+
+ - [Install Docker](https://docs.docker.com/get-docker/)
+ - [Install Docker Compose](https://docs.docker.com/compose/install/)
+
+2. Clone the GitHub repo:
+
+```bash
+git clone https://github.com/xtekky/gpt4free.git
+```
+
+3. Navigate to the project directory:
+
+```bash
+cd gpt4free
+```
+
+4. Build the Docker image:
+
+```bash
+docker pull selenium/node-chrome
+docker-compose build
+```
+
+5. Start the service using Docker Compose:
+
+```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.
+
+To stop the Docker containers, simply run:
+
+```bash
+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`.
+
+[Return to Home](/) \ No newline at end of file