sipcapture/homer-appPublic

NotificationsYou must be signed in to change notification settings
Fork86
Star215

HOMER 7.x Front-End and API Server

License

AGPL-3.0 license

215 stars 86 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 1,460 Commits
.github		.github
auth		auth
config		config
controller/v1		controller/v1
data/service		data/service
docker		docker
etc		etc
log		log
migration		migration
model		model
network/response		network/response
router/v1		router/v1
scripts		scripts
sqlparser		sqlparser
system		system
utils		utils
.gitignore		.gitignore
.goreleaser.yml		.goreleaser.yml
CONFIGURE.md		CONFIGURE.md
Dockerfile		Dockerfile
LICENSE		LICENSE
Makefile		Makefile
README.md		README.md
go.mod		go.mod
go.sum		go.sum
homer-app.service		homer-app.service
homer-app.yaml		homer-app.yaml
main.go		main.go
swagger.json		swagger.json
version.go		version.go

Repository files navigation

HOMER WebApp

This repository hostshomer-app, the the GO webapplication for the HEP/HOMER 7.7+ stack.

Instructions

If you want to installHomer please refer to the projectreadme

If you're just interested in usinghomer-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 modulesmake all

Docker

To get dependencies and compile the latest homer-app using a docker builder, use the following command:

make binarymake 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

./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

Swagger APIs can be generated from inside thehomer-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 assipcapture/webappTo build a full bundle locally, including the latest frontend code:

make docker

For working examples and ready to run recipes seehomer7-docker

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 ordonations