changed README.md
This commit is contained in:
parent
499a733e9e
commit
ffed277352
2 changed files with 29 additions and 73 deletions
8
.gitignore
vendored
8
.gitignore
vendored
|
|
@ -0,0 +1,8 @@
|
|||
# Node modules
|
||||
node_modules/
|
||||
|
||||
# Nuxt build output
|
||||
.nuxt/
|
||||
|
||||
# Package lock
|
||||
package-lock.json
|
||||
94
README.md
94
README.md
|
|
@ -1,123 +1,71 @@
|
|||
# Nuvira Control Panel
|
||||
# Fruity Docs
|
||||
|
||||
> A lightweight control panel for managing **QEMU/KVM virtual machines** and **system services**, built with Nuxt 3 + DaisyUI.
|
||||
> A documentation framework based on Nuxt 3 and DaisyUI, with a MongoDB backend. The project is currently in an early development stage.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Overview
|
||||
|
||||
**Nuvira** is a sleek, self-hosted web interface for monitoring your system and managing virtualization through **libvirt/QEMU**. It offers real-time hardware insights and control over virtual machines and services — ideal for homelabs and lightweight server setups.
|
||||
|
||||
**Fruity Docs** is a modern, self-hostable documentation framework. It's designed to be easy to use and customize, making it ideal for project documentation, wikis, and knowledge bases. As the project is in its early stages, features are subject to change.
|
||||
|
||||
## Features
|
||||
|
||||
- 🖥️ Live system monitoring (CPU, memory, OS, etc.)
|
||||
- 💾 Manage QEMU/KVM virtual machines (Start / Shutdown)
|
||||
- 🔧 View and track systemd services
|
||||
- 💡 Simple configuration via a single `panel.config.ts` file
|
||||
- 🎨 Fully styled using Tailwind + DaisyUI
|
||||
- 📝 **Markdown-Based:** Write documentation in Markdown.
|
||||
- 🎨 **Customizable:** Easily themeable with DaisyUI and Tailwind CSS.
|
||||
- 🚀 **Nuxt 3:** Built on the latest version of Nuxt for a great developer experience.
|
||||
- 💾 **MongoDB Backend:** For data persistence.
|
||||
- 💡 **Early Development:** A great time to contribute and shape the project!
|
||||
|
||||
## Technologies Used
|
||||
|
||||
- **[Nuxt 3](https://nuxt.com/)** – Modern Vue 3 framework
|
||||
- **[DaisyUI](https://daisyui.com/)** – Clean UI components on Tailwind
|
||||
- **[systeminformation](https://www.npmjs.com/package/systeminformation)** – Fetch live system stats
|
||||
- **[Tailwind CSS](https://tailwindcss.com/)** - A utility-first CSS framework.
|
||||
- **[MongoDB](https://www.mongodb.com/)** - NoSQL Database
|
||||
- **[PM2](https://pm2.keymetrics.io/)** – Process manager (recommended for deployment)
|
||||
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- [Node.js](https://nodejs.org/) (v16+)
|
||||
- [Node.js](https://nodejs.org/) (v18+)
|
||||
- [NPM](https://www.npmjs.com/)
|
||||
- [QEMU/KVM](https://www.linux-kvm.org/page/Main_Page) (optional but supported)
|
||||
- [MongoDB](https://www.mongodb.com/try/download/community)
|
||||
- [PM2](https://pm2.keymetrics.io/) for production
|
||||
|
||||
### Steps
|
||||
|
||||
1. Clone the repository:
|
||||
```sh
|
||||
git clone https://github.com/WeeXnes/nuvira.git
|
||||
cd nuvira
|
||||
git clone https://git.weexnes.dev/WeeXnes/fruity-docs.git
|
||||
cd fruity-docs
|
||||
```
|
||||
2. Install dependencies:
|
||||
```sh
|
||||
npm install
|
||||
```
|
||||
3. Set the admin password:
|
||||
```sh
|
||||
npm run password_gen <password>
|
||||
```
|
||||
4. Build the Panel
|
||||
3. Build the application:
|
||||
```sh
|
||||
npm run build
|
||||
```
|
||||
5. Start the Server
|
||||
4. Start the server:
|
||||
```sh
|
||||
pm2 start
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
Modify the `panel.config.ts` file (if needed) to configure VM management and system services settings.
|
||||
|
||||
```ts
|
||||
import { reactive } from "vue";
|
||||
|
||||
export const settings = reactive({
|
||||
ignoreCache: true,
|
||||
// Leave empty to scan all interfaces
|
||||
// or change item to "disabled" to disable interface scanning
|
||||
interfaces_to_scan:[
|
||||
"eth0"
|
||||
],
|
||||
// enable or disable QEMU controls
|
||||
enable_qemu_controls: true,
|
||||
// list the qemu vm names you want to monitor/scan for
|
||||
qemu_vms: [
|
||||
{
|
||||
name: "Gameserver",
|
||||
// OS Info has to be declared here due to technical
|
||||
// limitations of not being able to gather vm OS info
|
||||
os: "Ubuntu 24.04"
|
||||
},
|
||||
{
|
||||
name: "Ubuntu_VM1",
|
||||
os: "Ubuntu 24.04"
|
||||
},
|
||||
],
|
||||
//enable or disable systemctl service monitoring
|
||||
enable_services: true,
|
||||
//list systemctl services to monitor/scan for
|
||||
systemctl_services:[
|
||||
"libvirt",
|
||||
"frp"
|
||||
],
|
||||
// set the password hash by running "npm run password_gen <password>" before building
|
||||
password_hash: ""
|
||||
});
|
||||
```
|
||||
Modify the `fruity.config.ts` file to configure your documentation site.
|
||||
|
||||
*Configuration options are currently under development.*
|
||||
|
||||
## Usage
|
||||
|
||||
- The dashboard provides an overview of system information.
|
||||
- You can start or shut down virtual machines.
|
||||
- Service monitoring
|
||||
|
||||
## Optional (Recommended)
|
||||
|
||||
### Running the Website with SSL
|
||||
|
||||
- Guide coming soon
|
||||
|
||||
Once installed and running, you can start creating and viewing your documentation.
|
||||
|
||||
## Author
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue