nessi/NexaDash
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add project scaffolding and documentation

Browse Source 
Add .env.example with configuration for database, Redis, security, SMTP, workers, and plugins. Add .gitignore for Python, Node.js, Next.js, Docker volumes, and IDE files. Add MIT License. Update README.md with feature overview, quick start guide, architecture description, plugin system documentation, security details, backup/restore instructions, and developer setup. Add Alembic configuration files and placeholder directories for API, web, worker, and plugin components
This commit is contained in:
nessi
2026-06-21 09:31:47 +02:00
parent cfeeccbf53
commit d694c8b8e3
197 changed files with 8583 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+135 -56
View File
@@ -1,93 +1,172 @@
# NexaDash
NexaDash is a modern, self-hosted, plugin-based dashboard for Homelab, server and infrastructure services. It connects to Proxmox, AdGuard Home, Jellyfin, Home Assistant, authentik, Beszel and many more through a secure, extensible plugin system — all configurable from the web UI, no CLI required.
## Features
## Getting started
- **Plugin-based architecture**: Add services as plugins via the UI or ZIP upload.
- **Modern UI**: Next.js, Tailwind CSS, shadcn/ui, dark mode first, glassmorphism design.
- **Secure by default**: Argon2id, JWT sessions, RBAC, encrypted secrets, audit log, SSRF protection, security headers.
- **Dashboard editor**: Drag & drop, resize, multiple breakpoints, favorites, folders, import/export.
- **Multi-user**: Owner, Admin, Editor, Viewer roles with permission system.
- **Background workers**: Celery for plugin syncs and scheduled jobs.
- **Live updates**: WebSocket/SSE support and auto-refresh.
- **Mail settings**: SMTP configuration via UI for invitations and password resets.
- **Backup/restore**: Database dumps and restore documentation included.
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
## Quick Start
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
Requires Docker and Docker Compose.
## Add your files
```bash
# 1. Clone the repository
git clone https://github.com/nexadash/nexadash.git
cd nexadash
* [Create](https://docs.gitlab.com/user/project/repository/web_editor/#create-a-file) or [upload](https://docs.gitlab.com/user/project/repository/web_editor/#upload-a-file) files
* [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
# 2. Configure environment
cp .env.example .env
# Edit .env and set strong passwords
```
cd existing_repo
git remote add origin http://gitlab.nesterovic.cc/nessi/nexadash.git
git branch -M main
git push -uf origin main
# 3. Start the stack
docker compose up -d
# 4. Open the UI
open http://localhost:3000
```
## Integrate with your tools
The initial setup wizard appears on first launch. Create the owner account, then add services from the plugin registry.
* [Set up project integrations](http://gitlab.nesterovic.cc/nessi/nexadash/-/settings/integrations)
## Architecture
## Collaborate with your team
```text
nexadash/
apps/
web/ Next.js frontend
api/ FastAPI backend
worker/ Celery background worker
packages/
plugin-sdk/ TypeScript SDK for plugin developers
shared/ Shared types and constants
ui/ shadcn/ui component library
plugins/ Built-in plugin manifests
docs/ Documentation
docker/ Dockerfiles
compose.yaml
.env.example
```
* [Invite team members and collaborators](https://docs.gitlab.com/user/project/members/)
* [Create a new merge request](https://docs.gitlab.com/user/project/merge_requests/creating_merge_requests/)
* [Automatically close issues from merge requests](https://docs.gitlab.com/user/project/issues/managing_issues/#closing-issues-automatically)
* [Enable merge request approvals](https://docs.gitlab.com/user/project/merge_requests/approvals/)
* [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)
## Plugin System
## Test and Deploy
NexaDash plugins are declarative packages consisting of:
Use the built-in continuous integration in GitLab.
- `plugin.manifest.json` — metadata, schemas, widgets, permissions.
- Backend connector — either a built-in connector or a registered Python class.
- Optional frontend widget components.
* [Get started with GitLab CI/CD](https://docs.gitlab.com/ci/quick_start/)
* [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/user/application_security/sast/)
* [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/topics/autodevops/requirements/)
* [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/user/clusters/agent/)
* [Set up protected environments](https://docs.gitlab.com/ci/environments/protected_environments/)
Plugins are installed, activated, configured and updated entirely from the web UI. Built-in plugins include:
***
- Proxmox VE
- Proxmox Backup Server
- AdGuard Home
- Zoraxy
- Jellyfin
- Home Assistant
- authentik
- Beszel
- Generic HTTP
# Editing this README
See `docs/plugins/README.md` for the full developer guide.
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Security
## Suggestions for a good README
- Passwords hashed with Argon2id.
- JWT access + refresh tokens in HTTP-only cookies.
- Service credentials encrypted at rest with Fernet.
- RBAC with Owner/Admin/Editor/Viewer.
- Audit log for all critical actions.
- SSRF protection for outbound service URLs.
- Rate limiting and account lockout.
- Security headers on all API responses.
- No secrets exposed to the frontend.
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
See `docs/security/README.md` for details.
## Name
Choose a self-explaining name for your project.
## Backup and Restore
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
```bash
# Backup
docker compose exec postgres pg_dump -U nexadash nexadash > nexadash-backup.sql
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
# Restore
docker compose exec -T postgres psql -U nexadash nexadash < nexadash-backup.sql
```
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
Important volumes: `postgres_data`, `redis_data`, `plugin_data`.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Update
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
```bash
git pull
docker compose build
docker compose up -d
docker compose exec api alembic upgrade head
```
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Developer Setup
### Backend
```bash
# Python 3.12+
python -m venv .venv
. .venv/bin/activate
pip install poetry
poetry install
# Run migrations
alembic upgrade head
# Start API
python -m uvicorn apps.api.src.main:app --reload
# Start worker (separate terminal)
celery -A apps.worker.src.celery_app worker -l info
```
### Frontend
```bash
# Node 20+, pnpm 9+
pnpm install
pnpm dev
```
### Testing
```bash
# Backend
pytest
# Frontend
pnpm test
```
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
- Public plugin marketplace.
- Additional widget types (charts, maps, logs).
- Webhook-triggered plugin actions.
- OIDC/SAML authentication.
- Mobile app.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
Contributions are welcome. Please follow the existing code style, add tests for new features and update the documentation.
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
MIT License — see `LICENSE`.
## Support
For questions and issues, open a GitHub issue or discussion.