Sign inSign up

szomorxvigyor/firmware-webmanager

By szomorxvigyor

โ€ขUpdated over 1 year ago

Web service for handle multi device firmware files and indexes.

Image
Integration & delivery
Internet of things
Databases & storage
0

1.6K

szomorxvigyor/firmware-webmanager repository overview

โ ๐Ÿ”ง A Simple Firmware Management Server

Node Version Express Bootstrap Storage Types Latest release License

โ A lightweight, containerized firmware management system with REST API and web UI โ€” designed for managing OTA updates across diverse hardware like IoT devices, microcontrollers, and embedded systems.

โ ๐Ÿ“ฆ Features

  • โœ… REST API + Admin Web UI
  • ๐Ÿ” JWT-protected firmware uploads
  • ๐Ÿ“ฑ Multi-device + semantic versioning
  • ๐Ÿ’พ Storage: FileSystem (default) or MongoDB GridFS
  • โš™๏ธ Dockerized with health checks & non-root user

โ ๐Ÿš€ Quick Start (FileSystem)

docker run -d \
  --name firmware-server \
  -p 3000:3000 \
  -e STORAGE_TYPE=filesystem \
  -v $PWD/data:/app/data \
  szomorxvigyor/firmware-webmanager

Then visit: http://localhost:3000โ  Default credentials: admin / admin123


โ ๐Ÿ› ๏ธ Using MongoDB

docker run -d \
  --name firmware-server \
  -p 3000:3000 \
  -e STORAGE_TYPE=mongodb \
  -e MONGODB_URI=mongodb://host.docker.internal:27017 \
  szomorxvigyor/firmware-webmanager

๐Ÿ“Œ Replace host.docker.internal with your MongoDB host IP if needed.


โ ๐Ÿ”— API Highlights

GET    /api/firmwares              # List firmwares
GET    /api/firmwares?device=ESP32 # Filter by device
POST   /api/login                  # Get JWT token
POST   /api/firmware/upload        # Upload firmware (auth)
GET    /api/firmware/{id}/download # Download binary

๐Ÿ“š Complete API Documentationโ 


โ ๐Ÿ“ Volumes (filesystem mode)

Container PathPurpose
/app/dataFirmware file storage

โ ๐Ÿ” Security Tips

  • Change the default password
  • Use HTTPS in production
  • Monitor disk usage
  • Enable firewalls

โ ๐Ÿงช Health Check

This container includes a built-in HTTP health check on /api/health.


โ ๐Ÿค Contribute

Want to improve or add features? Visit the GitHub Repoโ 


โ ๐Ÿ“ License

MIT ยฉ SzomorXVigyorโ 

Tag summary

Content type

Image

Digest

sha256:7eef5a516โ€ฆ

Size

57.6 MB

Last updated

over 1 year ago

docker pull szomorxvigyor/firmware-webmanager