fastybird / miniserver

dev-main 2026-09-19 20:14 UTC

Requires

• php: >=8.4.0
• ext-bcmath: *
• ext-curl: *
• ext-date: *
• ext-gd: *
• ext-gmp: *
• ext-iconv: *
• ext-intl: *
• ext-json: *
• ext-mbstring: *
• ext-openssl: *
• ext-pcntl: *
• ext-pdo_mysql: *
• ext-session: *
• ext-simplexml: *
• ext-sockets: *
• ext-sodium: *
• ext-sqlite3: *
• ext-xml: *
• ext-zip: *
• contributte/console: ^0.9
• contributte/event-dispatcher: ^0.9
• contributte/monolog: ^0.6
• contributte/translation: ^2.0
• contributte/vite: ^0.3
• cweagans/composer-patches: ^1.7
• doctrine/orm: ^3.3
• fastybird/accounts-module: @dev
• fastybird/apikey-plugin: @dev
• fastybird/application: @dev
• fastybird/couchdb-plugin: @dev
• fastybird/date-time-automator: @dev
• fastybird/devices-module: @dev
• fastybird/devices-module-automator: @dev
• fastybird/devices-module-ui-module-bridge: @dev
• fastybird/exchange: @dev
• fastybird/fb-mqtt-connector: @dev
• fastybird/homekit-connector: @dev
• fastybird/metadata-library: @dev
• fastybird/modbus-connector: @dev
• fastybird/ns-panel-connector: @dev
• fastybird/rabbitmq-plugin: @dev
• fastybird/redisdb-cache-plugin: @dev
• fastybird/redisdb-plugin: @dev
• fastybird/redisdb-plugin-devices-module-bridge: @dev
• fastybird/redisdb-plugin-triggers-module-bridge: @dev
• fastybird/shelly-connector: @dev
• fastybird/shelly-connector-homekit-connector-bridge: @dev
• fastybird/sonoff-connector: @dev
• fastybird/tools: @dev
• fastybird/triggers-module: @dev
• fastybird/tuya-connector: @dev
• fastybird/ui-module: @dev
• fastybird/viera-connector: @dev
• fastybird/viera-connector-homekit-connector-bridge: @dev
• fastybird/virtual-connector: @dev
• fastybird/virtual-thermostat-addon: @dev
• fastybird/virtual-thermostat-addon-homekit-connector-bridge: @dev
• fastybird/web-server-plugin: @dev
• fastybird/ws-server-plugin: @dev
• fastybird/zigbee2mqtt-connector: @dev
• nette/application: ^3.1
• nette/bootstrap: ^3.2
• nettrine/fixtures: ^0.9
• nettrine/migrations: ^0.10
• vlucas/phpdotenv: ^5.4

Requires (Dev)

• brianium/paratest: ^7.8
• dg/bypass-finals: ^1.4
• fastybird/websockets-library: @dev
• infection/infection: ^0.31.9
• latte/latte: ^3.0
• orisai/coding-standard: ^3.2
• pds/skeleton: ^1.0
• php-parallel-lint/php-parallel-lint: ^1.3
• phpstan/extension-installer: ^1.1
• phpstan/phpstan: ^2.1
• phpstan/phpstan-deprecation-rules: ^2.0
• phpstan/phpstan-doctrine: ^2.0
• phpstan/phpstan-nette: ^2.0
• phpstan/phpstan-phpunit: ^2.0
• phpstan/phpstan-strict-rules: ^2.0
• phpunit/phpunit: ^11.5
• rector/rector: ^2.6
• staabm/annotate-pull-request-from-checkstyle: ^1.8
• symplify/vendor-patches: ^11.2
• tracy/tracy: ^2.9

Apache-2.0

• FastyBird s.r.o.
• Adam Kadlec

Published on Packagist.org on 2026-09-19 20:14 UTC

README

FastyBird MiniServer

A self-hosted IoT server: devices, connectors, automations and a JSON:API + Vue admin interface, in one PHP application.

What is FastyBird MiniServer?

MiniServer is a standalone application built on the FastyBird IoT extension set, developed on top of the Nette and Symfony frameworks. It integrates third-party device ecosystems (Shelly, Tuya, Sonoff, Viera, NsPanel, Zigbee2Mqtt, Modbus, generic MQTT, virtual devices) and Apple HomeKit, behind a JSON:API backend and a Vue 3 admin UI served from the same entry point.

Requirements

PHP 8.4, Node 24, pnpm 10, MariaDB. Redis, CouchDB and RabbitMQ are optional -- see docs/configuration.md.

Getting started

With Docker (recommended)

docker compose -f docker/prod/docker-compose.yml up -d

This builds docker/prod/Dockerfile, starts the application and a MariaDB database, and runs pending migrations on first start. See docs/deployment.md for the full process layout (nginx, php-fpm, the WebSocket server and the devices-module exchange worker under supervisord), for the required SECURITY_SIGNATURE, and for the pre-built image at ghcr.io/fastybird/miniserver.

Traditional installation

composer install --no-dev --prefer-dist --classmap-authoritative
pnpm install --frozen-lockfile && pnpm build

Then create the schema and any module-specific data:

php bin/fb-console.php migrations:migrate --no-interaction --allow-no-migration
php bin/fb-console.php fb:devices-module:install
php bin/fb-console.php fb:accounts-module:install

Point a web server at public/, or run the built-in ReactPHP server for local use:

php bin/fb-console.php fb:web-server:start

Documentation

• docs/architecture.md -- extension inventory, request routing, config load order
• docs/configuration.md -- enabling the extensions that ship in the tree but are not wired by default
• docs/deployment.md -- Docker images, supervisor processes, production defaults

Feedback

Use the issue tracker for bugs, or mail us for ideas that can improve the project.

Changelog

For release info check the release page.

Maintainers

Adam Kadlec

Homepage https://www.fastybird.com and repository https://github.com/FastyBird/miniserver.