gomrefdash

README

gomrefdash

mrefd Dashboard, in Go!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

A dashboard written for mrefd 0.5.0+ in Go!

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

Clone, build, and run!

(back to top)

Prerequisites

Install Go 1.19+ according to your platform, directions can be found here

(back to top)

Installation

1. Clone the repo

   git clone https://github.com/kc1awv/gomrefdash.git
   

2. Build the application

   make
   

3. Copy gomrefdash.sample.toml and edit to your environment

   cp gomrefdash.sample.toml gomrefdash.toml
   

4. Run gomrefdash

   ./gomrefdash
   

(back to top)

Configuring and operating gomrefdash

gomrefdash.toml:

hostport - the port on which the gomrefdash web server will run

ipv4 - listening IPv4 address of mrefd

ipv6 - listening IPv6 address of mrefd

refresh - refresh rate of the data on the web pages in seconds

lastheard - number of stations to show in the last heard list

mreffile - path to the mrefd XML log file location

mrefpidfile - path to the PID file for mrefd

email - reflector sysop's email address

debug - boolean option to run Gin in debug mode

subpath - if your dashboard needs to run in a subpath behind a reverse proxy, e.g. "/reflector" would be http://yourhostname/reflector, leave blank for no sub path

It is important to note that gomrefdash itself has a web (HTTP) server built-in. That is what the hostport defines in the TOML configuration file. If you are only running gomrefdash, and no other web server, then hostport can be defined as a 'standard' HTTP port, such as port 80 - so long as the user running the gomrefdash service has permission to run on a port that is below 1024.

The preferred way to run gomrefdash is behind a reverse proxy. This alleviates issues of permissions and system security (we hope you're not running gomrefdash as root!) as well as being able to easily enable SSL on a publicly facing web page.

Recommended web servers to use for reverse proxying are nginx, Apache, and Caddy. Please refer to their documentation on how to set up a reverse proxy.

(back to top)

Advanced (Experimental)

These are some things that aren't officially supported, but you can try it out.

Docker

You may wish to to use https://github.com/mfiscus/mrefd-docker which contains both mrefd and the dashboard.

Below are legacy instructions to use the docker solution in this repository.

Some Assumptions

1. mrefd is already running on the system running docker.

2. You are familiar with docker and it's installed on your system - https://www.docker.com

3. You have docker-compose installed - https://docs.docker.com/compose/install/

Quickstart

1. Copy docker-compose.sample.yml to docker-compose.yml

2. Edit the docker-compose.yml for your environment

3. Run docker-compose up

4. Open http://localhost:3000

You will need to put a proxy in front of your application, or modify the docker-compose file to add nginx or caddy. That is left as an exercise for the admin as the choices are various. Many of us prefer caddy as it has automatic ssl via letsencrypt.

To upgrade, git pull && docker-compose down && docker-compose build && docker-compose up -d

Check with docker-compose logs -f (hit ctrl-c to stop log streaming)

Makefile

The makefile has various convience functions:

• make (no parameters), builds the binary for your system

• make run runs the application (without building a binary)

• make docker builds a docker image with the application

• make clean cleans old builds

• make package builds and packages everything up into a tarball for your system

(back to top)

Roadmap

• Beta Release
• Refresh page on log file changes, instead of a meta refresh in browser - thanks KF8S
• Create two-column layout for Modules In Use, instead of a single column
• Add country flags for callsigns

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GPL 3.0 License. See LICENSE.txt for more information.

(back to top)

Contact

• M17 Project Discord -

Project Link: https://github.com/kc1awv/gomrefdash

(back to top)

Acknowledgments

• Tom N7TAE Creator of mrefd and inspiration for development
• Dave KF8S Beta testing and great feedback, page refresh code, many improvements
• edgetriggered Teaching me finer points of Golang, help and guidance

(back to top)