https://github.com/mcmilk/unifi-hotspot-manager
A HotSpot Manager for Ubiquiti UniFi Hardware
https://github.com/mcmilk/unifi-hotspot-manager
hotspot-manager ubiquiti ubnt unifi unifi-controller
Last synced: about 1 year ago
JSON representation
A HotSpot Manager for Ubiquiti UniFi Hardware
- Host: GitHub
- URL: https://github.com/mcmilk/unifi-hotspot-manager
- Owner: mcmilk
- License: mit
- Created: 2017-08-20T16:16:32.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-03-26T01:35:19.000Z (about 4 years ago)
- Last Synced: 2025-04-30T07:07:08.409Z (about 1 year ago)
- Topics: hotspot-manager, ubiquiti, ubnt, unifi, unifi-controller
- Language: PHP
- Homepage:
- Size: 6.93 MB
- Stars: 46
- Watchers: 12
- Forks: 16
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# UniFi HotSpot Manager
This is a HotSpot Manager like the default one of [UniFi Ubiquiti](https://unifi-sdn.ubnt.com/), but this one has some advantages and is easier to use.
[](https://github.com/mcmilk/UniFi-HotSpot-Manager/releases)
[](https://www.paypal.me/TinoReichardt)
## Features
- allow different Usergroups via Voucher prefixes with just one [Ubiquiti Controller] ;)
- own user access control, no need for users to get a real admin account on the [Ubiquiti Controller]
- variable printing, creating, filtering and deleting of vouchers
- deleting multiple vouchers with _one click_ just works, but the needed time is about 0.8 seconds per voucher :(
- blocking, unblocking and re-connecting of users (the default HotSpot system misses these functions, but the admin interface has, yes I know... but this is not for users)
- ... a lot more, this is just the first writing of that README
## Included libraries
- [UniFi PHP API](https://github.com/Art-of-WiFi/UniFi-API-client), by [Erik Slooff](https://github.com/malle-pietje)
- [Gettext PHP](https://github.com/oscarotero/Gettext) by [Oscar Otero](https://github.com/oscarotero/)
- [FPDF](http://www.fpdf.org/) for voucher creation
## Used libraries via [CDN]
All [CDN] libraries I am including are using the [MIT license], so I use it also ;)
- [jQuery] JavaScript Library - used everywhere
- [DataTables] - [jQuery] plug-in for all the tables
- [Bootstrap] - the HTML, CSS, and JavaScript framework
- [Bootstrap] [X-editable](https://vitalets.github.io/x-editable/) - used for editing within the [DataTables]
- [Bootstrap] [Form Validator](https://1000hz.github.io/bootstrap-validator/) - used for some forms
- [Bootstrap Dialog](https://github.com/nakupanda/bootstrap3-dialog) - used
- [MomentJS](https://momentjs.com/) - Parse, validate, manipulate and display dates and times in JavaScript
## Requirements
- an [Ubiquiti Controller]
- a webserver wit PHP >= 5.5
- some time for installing and testing
## Installation
- clone the repository `git clone https://github.com/mcmilk/UniFi-HotSpot-Manager`
- the `private` folder can be setup to some private directory (not meant to stay in webroot)
- the file `index.php` should be copied to your web folder
- edit the file then, and set up the private path
- then go to your `private` path an take a look into the file `config.sample.php`
- modify that file and rename it to `config.php`
- start your browser and you should get the login form
- take a look into the file `userdb.json`, search for `pass = [` and use this password together with the username `admin`
- for creating an own qr-code of the WiFi settings for your network on the vouchers, just use the script provided here: `contrib/qr-gen.sh`
## Todo
- show some more information on the "list_clients" action
- the same for the "list_guest_aps" site
## Screenshots
- creating vouchers and language selection
- user management
- translating the web user interface is supported also
- list current guests in your network, you can also block or unblock them
- same guest list, but a much smaller screen, responsive design ;)
## Sample voucher lists
- [printed, with german language settings](https://github.com/mcmilk/UniFi-HotSpot-Manager/blob/master/contrib/tickets-de.pdf)
- [printed with english language settings](https://github.com/mcmilk/UniFi-HotSpot-Manager/blob/master/contrib/tickets-en.pdf)
- the comments in the last line are the same, the headline can be set per user
## License and redistribution
This HotSpot Manager is licensed under the [MIT license], Copyright (c) 2017 Tino Reichardt.
[CDN]:https://en.wikipedia.org/wiki/Content_delivery_network/
[MIT license]:https://opensource.org/licenses/MIT
[DataTables]:https://datatables.net/
[jQuery]:https://github.com/jquery/jquery
[Bootstrap]:https://github.com/twbs/bootstrap
[Ubiquiti Controller]:https://www.ubnt.com/download/unifi/unifi-cloud-key/uc-ck