Files
reflector-dashboard/README.md
T

29 lines
1.4 KiB
Markdown

# SvxPortal web
Web front-end for a [SvxReflector](https://github.com/sm0svx/svxlink): live node
list and map, monitor, last-heard, talkgroup list, user accounts with e-mail
verification, and admin pages for accounts, node certificates, node control and
talkgroup requests.
Static HTML/JS (Bootstrap from jsdelivr) plus a small PHP backend that keeps
its data in Redis. No build step.
- **Reflector:** this portal is used with [GeuReflector](https://github.com/sa2blv/GeuReflector)
(SA2BLV's SvxReflector fork with reflector-to-reflector trunking; upstream is
[audric/GeuReflector](https://github.com/audric/GeuReflector)). Its status
endpoint (`HTTP_SRV_PORT`) is what the live-data API is built from.
- **Install:** see [INSTALL.md](INSTALL.md) — nginx, PHP-FPM, Redis, first admin.
- **Config templates:** [`install/`](install/)
- **User help:** `help.html` (served at `/help.html`)
This repository contains the web application only. The live-data API it
consumes (`/svxportal/api/...`) and the sudo helper scripts used by the
reflector admin pages are site-specific and not included; INSTALL.md
sections 9 and 10 describe what they must provide.
## License
GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later). See
[LICENSE](LICENSE). If you run a modified version of this portal as a network
service, you must offer its source code to your users under the same license.