Skip to content

Develop: update readme #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
momoein merged 2 commits into from
Jul 19, 2025
Merged

Develop: update readme #7

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3185559
docs: update readme
momoein Jul 19, 2025
e19aad2
docs: update readme
momoein Jul 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down