mirror of
https://github.com/mivodev/mivo.git
synced 2026-01-26 05:25:42 +07:00
Add Docker-specific README and update workflow
This commit is contained in:
2
.github/workflows/docker-publish.yml
vendored
2
.github/workflows/docker-publish.yml
vendored
@@ -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
80
DOCKER_README.md
Normal 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.
|
||||
|
||||
  
|
||||
|
||||
## 🚀 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!
|
||||
|
||||
[](https://sociabuzz.com/dyzulkdev/tribe)
|
||||
|
||||
---
|
||||
*Created with ❤️ by DyzulkDev*
|
||||
Reference in New Issue
Block a user