https://github.com/openipc/dashboard
Dashboard is a cross-platform (Lin/Mac/Win) desktop application for convenient management and monitoring of cameras based on OpenIPC firmware.
https://github.com/openipc/dashboard
dashboard ipcam openipc
Last synced: 22 days ago
JSON representation
Dashboard is a cross-platform (Lin/Mac/Win) desktop application for convenient management and monitoring of cameras based on OpenIPC firmware.
- Host: GitHub
- URL: https://github.com/openipc/dashboard
- Owner: OpenIPC
- License: gpl-3.0
- Created: 2025-07-01T09:21:12.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-09-04T11:03:17.000Z (5 months ago)
- Last Synced: 2025-09-24T12:35:44.051Z (5 months ago)
- Topics: dashboard, ipcam, openipc
- Language: JavaScript
- Homepage: https://openipc.org
- Size: 157 MB
- Stars: 4
- Watchers: 0
- Forks: 2
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
---
# Dashboard
**Dashboard** is a cross-platform desktop application for easy camera management and monitoring based on the OpenIPC firmware.
The application was created using Electron and provides a single interface for viewing video streams, administering settings, working with the file system, and direct access to the camera's command line.
---
## 🚀 Main Features
* **Multi-view:** View up to 64 video streams simultaneously in a customizable grid.
* **Dual Stream Support:** Instantly switch between the main (HD) and secondary (SD) streams.
* **Full-screen Mode:** Detailed full-screen viewing of a single camera with a double-click.
* **Built-in SSH Client:** A full-fledged terminal for direct access to the camera's command line without third-party programs.
* **File Manager (SCP):** A convenient two-panel manager for uploading firmware, downloading recordings, and managing files on the camera.
* **Settings Editor:** A graphical interface for changing all parameters of the Majestic firmware (`majestic.yaml`), grouped by tabs.
* **Monitoring:** Displays the status (online/offline) and SoC temperature of the camera in real time.
* **Cross-platform:** Works on Windows, macOS, and Linux.
---
## 📦 Installation
Ready-to-use installation files for the latest version can be found on the **[Releases page](https://github.com/openipc/dashboard/releases)**.
#### Windows
1. Download the `OpenIPC-Dashboard-Setup-x.x.x.exe` file.
2. Run the installer and follow the instructions.
#### macOS
1. Download the `OpenIPC-Dashboard-x.x.x.dmg` file.
2. Open the `.dmg` file and drag the `OpenIPC Dashboard.app` into your Applications folder.
#### Linux
1. Download the `OpenIPC-Dashboard-x.x.x.AppImage` file.
2. Make the file executable:
```bash
chmod +x OpenIPC-Dashboard-x.x.x.AppImage
```
3. Launch the app:
```bash
./OpenIPC-Dashboard-x.x.x.AppImage --no-sandbox
```
---
## 🎨 White-Labeling & Branding
The application supports full customization (white-labeling), allowing you to adapt it for your company or clients.
### How It Works
On startup, the application looks for a `branding.json` file in the same directory as its executable file (`.exe`, `.AppImage`). If the file is found, the application will apply the custom settings. Otherwise, it will run with the default "DASHBOARD for OpenIPC" branding.
### Step-by-Step Guide
1. **Locate the Application Folder:** Find the directory where the application's executable is located.
2. **Create `branding.json`:** In that same directory, create a new text file named exactly `branding.json`.
3. **Configure the File:** Open `branding.json` in a text editor and add your desired settings. See the parameters and examples below.
4. **(Optional) Add Your Logo:** If you specified a `logoPath`, place the logo image file in the same directory.
5. **Launch the Application:** Run the executable to see your changes.
### Configuration Parameters
| Parameter | Type | Description |
| -------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `appName` | `String` | Replaces the default application name. |
| `logoPath` | `String` | Relative path to your logo file (e.g., `custom_logo.png`). Recommended: 80x80px PNG with transparency. |
| `features` | `Object` | An object to enable or disable specific UI features. |
| `showDonations` | `Boolean` | If `false`, hides the "Support the Project" section in the "About" tab. Default is `true`. |
| `showIssueReporting` | `Boolean` | If `false`, hides the "Report an Issue" button in the settings window. Default is `true`. |
| `showAboutTab` | `Boolean` | If `false`, completely hides the "About" tab in the settings window. Default is `true`. |
### Example `branding.json`
```json
{
"appName": "VMS Pro",
"logoPath": "vms_pro_logo.png",
"features": {
"showDonations": false,
"showIssueReporting": false,
"showAboutTab": true
}
}
```
> **Note:** Only include the parameters you wish to override. Any omitted parameters will use their default values. The application must be restarted for changes to take effect.
---
## 🛠️ For Developers
### Technology Stack
* [Electron](https://www.electronjs.org/)
* [Node.js](https://nodejs.org/)
* HTML, CSS, JavaScript (Vanilla JS)
* [JSMpeg](https://jsmpeg.com/) for video decoding
* [ssh2](https://github.com/mscdex/ssh2) for SSH and SCP
### Launching in Development Mode
1. Clone the repository:
```bash
git clone https://github.com/openipc/dashboard.git
cd dashboard
```
2. Install the dependencies:
```bash
npm install
```
3. Launch the app:
```bash
npm start
```
### Building the App
To build the installation files for your current platform, run the command:
```bash
npm run dist
```
The finished files will appear in the `dist` folder.