https://github.com/sipcapture/homer-app
HOMER 7.x Front-End and API Server
https://github.com/sipcapture/homer-app
asterisk elasticsearch freeswitch heplify homer influxdb kamailio logs loki metrics monitoring opensips prometheus rtc rtcp rtcpxr rtp sip sipcapture voip
Last synced: about 1 month ago
JSON representation
HOMER 7.x Front-End and API Server
- Host: GitHub
- URL: https://github.com/sipcapture/homer-app
- Owner: sipcapture
- License: agpl-3.0
- Created: 2018-06-16T20:31:06.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2025-04-10T14:08:29.000Z (about 1 month ago)
- Last Synced: 2025-04-12T03:48:28.575Z (about 1 month ago)
- Topics: asterisk, elasticsearch, freeswitch, heplify, homer, influxdb, kamailio, logs, loki, metrics, monitoring, opensips, prometheus, rtc, rtcp, rtcpxr, rtp, sip, sipcapture, voip
- Language: Go
- Homepage: http://sipcapture.io
- Size: 347 MB
- Stars: 214
- Watchers: 37
- Forks: 88
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# HOMER WebApp
This repository hosts `homer-app`, the the GO webapplication for the HEP/HOMER 7.7+ stack.
### Instructions
If you want to install [Homer](https://github.com/sipcapture/homer) please refer to the project [readme](https://github.com/sipcapture/homer)
If you're just interested in using `homer-app`, download, configure and run the latest release or package.
#### Requirements
* golang 1.13+
* postgres 11+
* git 2.7+
* optional
* prometheus
* influxdb
* loki
#### Installation
##### Local
To get dependencies and compile the latest homer-app on your system, use the following commands:
```
make modules
make all
```
##### Docker
To get dependencies and compile the latest homer-app using a docker builder, use the following command:
```
make binary
make frontend
```
### Configuration
Before using the application, configure all database parameters using the example configuration file:
```
/usr/local/homer/etc/webapp_config.json
```
NOTE: The default location for settings and provisioning files is `/usr/local/homer`
#### Usage
##### Command Help
```
./homer-app -h
```
##### Custom Config in `/etc`
```
./homer-app -webapp-config-path=/etc
```
##### Initialization
The application is able to initialize its database and tables it requires with the following commands:
###### Create User
```
./homer-app -create-homer-user -database-root-user=postgres -database-host=localhost -database-root-password=postgres
```
###### Show User
```
./homer-app -show-db-users -database-root-user=postgres -database-host=localhost -database-root-password=postgres
```
###### Create Homer DBs
```
./homer-app -create-config-db -database-root-user=postgres -database-host=localhost -database-root-password=postgres -database-homer-user=homer_user
./homer-app -create-data-db -database-root-user=postgres -database-host=localhost -database-root-password=postgres -database-homer-user=homer_user
```
###### Create User permissions
```
./homer-app -create-homer-role -database-root-user=postgres -database-host=localhost -database-root-password=postgres -database-homer-data=homer_data -database-homer-config=homer_config
```
###### Please setup the correct credentials for homer_config and homer_data DB in your webapp_config.json !!!
if your webapp_config.json isn't in the default directory: "/usr/local/homer/etc", use the flag "-webapp-config-path" to correct it. Same have to be applied to all steps there you read settings from "webapp_config.json"
###### Create Table / Migration - connection data will be read from `webapp_config.json`
```
./homer-app -create-table-db-config
```
or
```
./homer-app -create-table-db-config -webapp-config-path=/etc/webapp_config.json
```
###### Populate DB
```
./homer-app -populate-table-db-config
```
###### Upgrade / Migration - connection data will be read from `webapp_config.json`
```
./homer-app -upgrade-table-db-config
```
###### Re- Populate Config DB
```
./homer-app -populate-table-db-config -force-populate
```
###### Re- Populate Config DB for specific table/tables
```
./homer-app -populate-table-db-config -force-populate -populate-table=mapping_schema -populate-table=user_settings
```
###### Reset UI password for any user:
```
./homer-app -update-ui-user=admin -update-ui-password=mypassword
```
------------
### Swagger APIs
#### Requirements
* [go-swagger 2.0](https://github.com/go-swagger/go-swagger)
Swagger APIs can be generated from inside the `homer-app`
To generate swagger.json file run below command insider homer-app
```
swagger generate spec -m -o ./swagger.json
```
To Serve swagger.json file run below command
```
swagger serve -F=swagger swagger.json
```
### DEB, RPM Packages
To build a full package, including the latest frontend code:
```
make package
```
The application will deploy to `/usr/local/bin` with config in `/etc`
### Docker Image
This application is available on dockerhub as `sipcapture/webapp`
To build a full bundle locally, including the latest frontend code:
```
make docker
```
For working examples and ready to run recipes see [homer7-docker](https://github.com/sipcapture/homer7-docker/tree/7.7/heplify-server)
---
This project is part of HOMER
----
#### License & Copyright
This project is released under the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
#### Made by Humans
This Open-Source project is made possible by actual Humans without corporate sponsors, angels or patreons.
If you use this software in production, please consider supporting its development with contributions or [donations](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=donation%40sipcapture%2eorg&lc=US&item_name=SIPCAPTURE&no_note=0¤cy_code=EUR&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHostedGuest)
[](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=donation%40sipcapture%2eorg&lc=US&item_name=SIPCAPTURE&no_note=0¤cy_code=EUR&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHostedGuest)
###### (C) 2008-2020 QXIP BV