diff --git a/README.md b/README.md index 9ee61c7..8ad34a8 100644 --- a/README.md +++ b/README.md @@ -26,18 +26,37 @@ SMTP_USERNAME=example@gmail.com SMTP_PASSWORD=aaaabbbbccccdddd ``` -2. Build the Docker image: +2. Pull the Docker image: ```bash +docker pull ghcr.io/cactusbros/smaila:latest # or specific version like v0.2.2 +``` + +Or manually Build the image: + +```bash +git clone https://github.com/CactusBros/smaila.git +cd smaila docker build -t smaila . ``` 3. Run the container: +```bash +docker run -p 8080:8080 --env-file .env ghcr.io/cactusbros/smaila:latest # or specific version like v0.2.2 +``` + +Or using the manually built image: + ```bash docker run -p 8080:8080 --env-file .env smaila ``` +> 💡 **Note**: If your `.env` file is not in the current directory, provide the full path to it using the `--env-file` flag, like: +> ```bash +> docker run -p 8080:8080 --env-file /path/to/.env smaila +> ``` + ## 📘 API Documentation After running the container, access the interactive API docs at: