Add Docker-specific README and update workflow

This commit is contained in:
dyzulk
2026-01-16 11:36:09 +07:00
parent e3414736ce
commit debd80d565
2 changed files with 81 additions and 1 deletions

View File

@@ -78,4 +78,4 @@ jobs:
password: ${{ secrets.DOCKER_PASSWORD }}
repository: ${{ env.IMAGE_NAME }}
short-description: ${{ github.event.repository.description }}
readme-filepath: ./README.md
readme-filepath: ./DOCKER_README.md

80
DOCKER_README.md Normal file
View File

@@ -0,0 +1,80 @@
<p align="center">
<img src="https://raw.githubusercontent.com/dyzulk/mivo/main/public/assets/img/logo.png" alt="MIVO Logo" width="200" />
</p>
# MIVO (Mikrotik Voucher) Docker Image
> **Modern. Lightweight. Efficient.**
MIVO is a complete rewrite of the legendary **Mikhmon v3**, re-engineered with a modern MVC architecture to run efficiently on low-end devices like STB (Set Top Boxes) and Android, while providing a premium user experience on desktop.
This Docker image is built on **Alpine Linux** and **Nginx**, optimized for high performance and low resource usage.
![Status](https://img.shields.io/badge/Status-Beta-orange) ![PHP](https://img.shields.io/badge/PHP-8.2+-777BB4) ![License](https://img.shields.io/badge/License-MIT-green)
## 🚀 Quick Start
Run MIVO in a single command:
```bash
docker run -d \
--name mivo \
-p 8080:80 \
-e APP_KEY=base64:YOUR_GENERATED_KEY \
-e APP_ENV=production \
-v mivo_data:/var/www/html/app/Database \
-v mivo_config:/var/www/html/.env \
dyzulk/mivo:latest
```
Open your browser and navigate to `http://localhost:8080`.
## 🛠️ Docker Compose
For a more permanent setup, use `docker-compose.yml`:
```yaml
services:
mivo:
image: dyzulk/mivo:latest
container_name: mivo
restart: unless-stopped
ports:
- "8080:80"
environment:
- APP_ENV=production
- TZ=Asia/Jakarta
volumes:
- ./mivo-data:/var/www/html/app/Database
```
## 📦 Tags
- `latest`: Stable release (recommended).
- `edge`: Bleeding edge build from the `main` branch.
- `v1.x.x`: Specific released versions.
## 🔧 Environment Variables
| Variable | Description | Default |
| :--- | :--- | :--- |
| `APP_ENV` | Application environment (`production` or `local`). | `production` |
| `APP_DEBUG` | Enable debug mode (`true` or `false`). | `false` |
| `APP_KEY` | 32-character random string (base64). Auto-generated on first install if not provided. | |
| `TZ` | Timezone for the container. | `UTC` |
## 📂 Volumes
Persist your data by mounting these paths:
- `/var/www/html/app/Database`: Stores the SQLite database and session files. **(Critical)**
- `/var/www/html/public/assets/img/logos`: Stores uploaded custom logos.
## 🤝 Support the Project
If you find MIVO useful, please consider supporting its development. Your contribution helps keep the project alive!
[![SociaBuzz Tribe](https://img.shields.io/badge/SociaBuzz-Tribe-green?style=for-the-badge&logo=sociabuzz&logoColor=white)](https://sociabuzz.com/dyzulkdev/tribe)
---
*Created with ❤️ by DyzulkDev*