https://github.com/slimani-dev/muraqib
A sleek Nuxt-powered dashboard for monitoring and managing home lab services. 🚀
https://github.com/slimani-dev/muraqib
Last synced: 12 months ago
JSON representation
A sleek Nuxt-powered dashboard for monitoring and managing home lab services. 🚀
- Host: GitHub
- URL: https://github.com/slimani-dev/muraqib
- Owner: slimani-dev
- License: mit
- Created: 2025-03-22T02:09:50.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-22T05:01:28.000Z (about 1 year ago)
- Last Synced: 2025-06-11T15:13:07.322Z (12 months ago)
- Language: TypeScript
- Size: 543 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Muraqib
Muraqib is a **Nuxt 3** application designed for monitoring and managing various services such as **Portainer, Proxmox, Sonarr, Radarr,** and more.
## Screenshot
## Features
- [ ] 🔄 **Dashboard** with real-time monitoring
- [ ] 🔄 **Portainer Integration** to manage Docker endpoints
- [ ] ❌ **Proxmox Support** for virtualization management
- [ ] ❌ **Sonarr/Radarr API Support** for media automation
- [ ] ❌ **OIDC Authentication** via Authelia or OAuth2 Proxy
- [ ] ❌ **SQLite-based Content Storage** for logs and persistent data
## Installation
### Prerequisites
Ensure you have the following installed:
- **Node.js v18+**
- **Yarn** (recommended) or NPM
- **Docker** (for services like Portainer & Proxmox)
### Setup
1. Clone the repository:
```sh
git clone https://github.com/yourusername/muraqib.git
cd muraqib
```
2. Install dependencies:
```sh
yarn install
```
3. Copy environment variables:
```sh
cp .env.example .env
```
4. Run the development server:
```sh
yarn dev
```
## Configuration
Edit `.env` to configure API endpoints:
```env
PORTAINER_BASE_URL="https://portainer.example.com"
PORTAINER_X_API_KEY="XXXXXXXXXXXXXXXXXXXXXXXXX"
```
## Deployment
To deploy with **Nitro** and **Docker**, use:
```sh
yarn build
yarn start
```
## License
This project is licensed under the MIT License.