Adam Shiervani
b9a1298fdb
The release API used to emit "Version X predates SKU support..." for every SKU-incompat 404. Upcoming changes route this through getDefaultRelease and emit "No default <type> release available for SKU..." instead. Both 404s mean the same thing to the device, so accept either wording in the diff tolerator.
JetKVM is a high-performance, open-source KVM over IP (Keyboard, Video, Mouse) solution designed for efficient remote management of computers, servers, and workstations. Whether you're dealing with boot failures, installing a new operating system, adjusting BIOS settings, or simply taking control of a machine from afar, JetKVM provides the tools to get it done effectively.
Contributing
We welcome contributions from the community! Whether it's improving the firmware, adding new features, or enhancing documentation, your input is valuable. We also have some rules and taboos here, so please read this page and our Code of Conduct carefully.
I need help
The best place to search for answers is our Documentation. If you can't find the answer there, check our Discord Server.
I want to report an issue
If you've found an issue and want to report it, please check our Issues page. Make sure the description contains information about the firmware version you're using, your platform, and a clear explanation of the steps to reproduce the issue.
Development
This project is built with Node.js, Prisma, and Express.
# Start the database
docker compose -f compose.development.yaml up -d
# Copy and configure environment variables
cp .env.example .env
# Install dependencies
npm install
# Run database migrations
npm run prisma-dev-migrate
# Seed development data (optional)
npm run seed
# Start the development server with hot reload
npm run dev
# Run tests
npm test
Self-Hosting
For self-hosting, use the default compose file which runs the complete stack:
# Copy and configure environment variables
cp .env.example .env
# Start everything (database, migrations, and app)
docker compose up -d
The app will be available on port 3000. Configure a reverse proxy (nginx, Caddy, etc.) for TLS termination.
Updating
git pull
docker compose up -d --build
Database migrations run automatically on startup.