Skip to content

sbabic/hawkbitgui

Repository files navigation

HawkbitGUI - modern GUI for the Hawkbit Server

This is a GUI for Eclipse Hawkbit hawkBit, an open-source backend platform for managing and deploying software and firmware updates to various connected devices. This project wants to solve the issue of missing GUI as reported in #1376. It is goal to resolve the strong dependencies, and HawkbitGUI does not need at all to be linked with Hawkbit's code. It uses the REST API provided by Hawkbit, and it can be installed on any server.

Focus of this project is: HawkbitGUI claims to solve some issues in Hawkbit:

  • remove dependencies from the Hawkbit Server. It is a separate project, built outside Hawkbit's Java environment, and it just uses the REST API provided by Hawkbit.
  • GUI and server do not need to run on the same server. GUI can be configured with which server must be connected design easier to change, even if it currently resembles the previous GUI.
  • better UX

License

This Software is licensed under GPLv3.

Getting Started

System requirements

  • Node.js >= 20.9.0 (required by Next.js 16.2.1)
  • npm >= 10.1.0 (or the npm version bundled with Node.js 20.9+)

1) Install dependencies

npm install

2) Configure environment variables

Create a .env file (you can copy from .env.example) and set:

NEXTAUTH_SECRET=replace-with-a-long-random-secret
NEXTAUTH_URL=http://localhost:3000
NEXT_PUBLIC_HAWKBIT_API_URL=http://localhost:8080

Notes:

  • NEXTAUTH_SECRET should be a strong random string.
  • NEXTAUTH_URL must match the URL where users access HawkbitGUI.
  • NEXT_PUBLIC_HAWKBIT_API_URL must point to your Hawkbit server base URL.

3) Development mode

Start the development server:

npm run dev

Open http://localhost:3000 with your browser to see the result.

4) Production mode

Create an optimized build and run it:

npm run build
npm run start

The app runs on port 3000 by default.

Configuration

You have to set in .env the URL for the Hawkbit Server by setting the NEXT_PUBLIC_HAWKBIT_API_URL variable.

About

A GUI for the Hawkbit Server

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages