diff --git a/README.md b/README.md index 4c4b5076..75bc91d2 100644 --- a/README.md +++ b/README.md @@ -128,6 +128,28 @@ $ zphisher ## +### Run using Docker Compose + +- Clone the Project +- Start the Container + ``` + docker compose up -d + ``` + - The -d flag runs the container in detached mode (in the background). +- Attach to the Zphisher Container + - To interact with the Zphisher container: + ``` + docker attach zphisher + ``` + - Don't Press Ctrl + C to stop as it will stop the application. (You can close the terminal) +- Stop the Container + - If you want to stop the container: + ``` + docker-compose down + ``` + +## +

Dependencies

diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 00000000..cc4ae298 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,12 @@ +version: '3.9' + +services: + zphisher: + image: htrtech/zphisher:latest + container_name: zphisher + network_mode: host + stdin_open: true + tty: true + volumes: + - ./auth:/zphisher/auth + restart: unless-stopped