PHPackages fastybird/miniserver - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. fastybird/miniserver ActiveApplication[API Development](/categories/api) fastybird/miniserver ==================== Repository for FastyBird packages development 101Vue Since Aug 7Pushed 1y ago1 watchersCompare [ Source](https://github.com/FastyBird/miniserver)[ Packagist](https://packagist.org/packages/fastybird/miniserver)[ RSS](/packages/fastybird-miniserver/feed)WikiDiscussions main Synced 1mo ago READMEChangelogDependenciesVersions (1)Used By (0) [![FastyBird MiniServer](docs/assets/fastybird_miniserver_readme.png)](docs/assets/fastybird_miniserver_readme.png) FastyBird MiniServer Edition ============================ [](#fastybird-miniserver-edition) This is FastyBird MiniServer Edition repository for starting new projects. What is FastyBird IoT MiniServer? --------------------------------- [](#what-is-fastybird-iot-miniserver) MiniServer is standalone application based on [FastyBird](https://www.fastybird.com) [IoT](https://en.wikipedia.org/wiki/Internet_of_things) software. The highest quality of code and strong testing culture, make it best solution for build smart controller application. [FastyBird](https://www.fastybird.com) [IoT](https://en.wikipedia.org/wiki/Internet_of_things) MiniServer is an Apache2 licensed distributed application, developed on top of the [Nette framework](https://nette.org) and [Symfony framework](https://symfony.com). ### Features: [](#features) - Devices & connectors management - User & access control management - [{JSON:API}](https://jsonapi.org/) strong api for application management - Responsive user interface - Third party devices integration like [Shelly](https://www.shelly.cloud/en-cz), [Tuya](https://www.tuya.com) and other - Full HomeKit with HAP protocol integration Requirements ------------ [](#requirements) [FastyBird](https://www.fastybird.com) MiniServer is tested against [PHP](https://www.php.net) 8.1, [Redis](https://redis.io) 6.2 in-memory data store, [MySQL](https://www.mysql.com) relational database management system, [ReactPHP http](https://github.com/reactphp/http) 0.8 event-driven, streaming plaintext HTTP server and [Nette framework](https://nette.org/en/) 3.0 PHP framework for real programmers. Getting started --------------- [](#getting-started) > **NOTE:** If you don't want to install it manually, try [docker image](#install-with-docker) ### Traditional installation [](#traditional-installation) The best way to install **fastybird/miniserver** is using [Composer](https://getcomposer.org/). If you don't have Composer yet, [download it](https://getcomposer.org/download/) following the instructions. Then use command: ``` composer create-project --no-dev fastybird/miniserver path/to/install ``` ``` cd path/to/install ``` Everything required will be then installed in the provided folder `path/to/install` #### Running app [](#running-app) You have two options how to run this app ##### Running an app via ReactPHP http server [](#running-an-app-via-reactphp-http-server) All what you need is just run one console command: ``` vendor/bin/fb-console fb:web-server:start ``` This command will start build in web server which is listening for incoming http api request messages from clients. ##### Running an app via Apache or Nginx [](#running-an-app-via-apache-or-nginx) You have to configure you web server running on [Apache](http://www.apache.org) or [Nginx](https://www.nginx.com) to server content from `public` folder. In this folder is main entry point for accessing application api. ### Install with docker [](#install-with-docker) [![Docker Image Version (latest by date)](https://camo.githubusercontent.com/c04209130178b47a59fbdb1a6d3f56a8bf8f83e7833754924b4f16f7fb048ebb/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f762f6661737479626972642f6d696e697365727665723f7374796c653d666c61742d737175617265)](https://camo.githubusercontent.com/c04209130178b47a59fbdb1a6d3f56a8bf8f83e7833754924b4f16f7fb048ebb/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f762f6661737479626972642f6d696e697365727665723f7374796c653d666c61742d737175617265)[![Docker Image Size (latest by date)](https://camo.githubusercontent.com/cdb2b0e00f453841cf4a4d630688f9b857f90c778235f62c27106fc870307942/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f696d6167652d73697a652f6661737479626972642f6d696e697365727665723f7374796c653d666c61742d737175617265)](https://camo.githubusercontent.com/cdb2b0e00f453841cf4a4d630688f9b857f90c778235f62c27106fc870307942/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f696d6167652d73697a652f6661737479626972642f6d696e697365727665723f7374796c653d666c61742d737175617265)[![Docker Cloud Build Status](https://camo.githubusercontent.com/687d38ff64ea1f18f86b6afdee25c5eb7e02f0334561fdba62aa28e33619b196/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f636c6f75642f6275696c642f6661737479626972642f6d696e697365727665723f7374796c653d666c61742d737175617265)](https://camo.githubusercontent.com/687d38ff64ea1f18f86b6afdee25c5eb7e02f0334561fdba62aa28e33619b196/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f636c6f75642f6275696c642f6661737479626972642f6d696e697365727665723f7374796c653d666c61742d737175617265) Docker image: [fastybird/miniserver](https://hub.docker.com/r/fastybird/miniserver/) #### Use docker hub image [](#use-docker-hub-image) ``` docker run -d -it --name devices fastybird/miniserver:latest ``` #### Generate local image [](#generate-local-image) ``` docker build --tag=miniserver . ``` ``` docker run -d -it --name miniserver miniserver ``` Initialization -------------- [](#initialization) This application is using database, and need some initial data to be inserted into it. This could be done via shell command: ``` vendor/bin/fb-console fb:initialize ``` This console command is interactive and will ask for all required information. After this steps, application could be started with [server command](#http-server) Feedback -------- [](#feedback) Use the [issue tracker](https://github.com/FastyBird/miniserver/issues) for bugs or [mail](mailto:code@fastybird.com) or [Tweet](https://twitter.com/fastybird) us for any idea that can improve the project. Thank you for testing, reporting and contributing. Changelog --------- [](#changelog) For release info check [release page](https://github.com/FastyBird/miniserver/releases) Maintainers ----------- [](#maintainers) [ ![](https://avatars3.githubusercontent.com/u/1866672?s=460&v=4) ](https://github.com/akadlec) [Adam Kadlec](https://github.com/akadlec) --- Homepage and repository . ### Health Score 14 — LowBetter than 2% of packages Maintenance28 Infrequent updates — may be unmaintained Popularity3 Limited adoption so far Community8 Small or concentrated contributor base Maturity17 Early-stage or recently created project Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/d2c952d3ec44db15105f8c8d4ccdb6cd0fe1a17445a5aa36470a044b1c17d2f2?d=identicon)[akadlec](/maintainers/akadlec) --- Top Contributors [![akadlec](https://avatars.githubusercontent.com/u/1866672?v=4)](https://github.com/akadlec "akadlec (204 commits)") --- Tags apifastybirdiotmanagementminiserverui ### Embed Badge ![Health badge](/badges/fastybird-miniserver/health.svg) ``` [![Health](https://phpackages.com/badges/fastybird-miniserver/health.svg)](https://phpackages.com/packages/fastybird-miniserver) ``` ### Alternatives [stripe/stripe-php Stripe PHP Library 4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk A PHP wrapper for Twilio's API 1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api GitHub API v3 client 2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk PHP SDK for Facebook Business 90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php PHP wrapper for the Meilisearch API 73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax Google API Core for PHP 263103.1M454](/packages/google-gax) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)