From 5612ee4c8d9ffbd0ddc958c1a16f588d9994b223 Mon Sep 17 00:00:00 2001 From: Heiner Lohaus Date: Mon, 19 Feb 2024 19:34:28 +0100 Subject: Update readme / docs --- docs/docker.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 docs/docker.md (limited to 'docs/docker.md') 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 -- cgit v1.2.3