diff --git a/README.md b/README.md index 6030f77..33e5160 100644 --- a/README.md +++ b/README.md @@ -30,8 +30,6 @@

- -
Table of Contents
    @@ -57,8 +55,6 @@
- - ## About The Project [![Product Name Screen Shot][product-screenshot]](https://ref.m17.link) @@ -67,8 +63,6 @@ A dashboard written for mrefd 0.5.0+ in Go!

(back to top)

- - ### Built With * [![Go][Go.dev]][Go-url] @@ -78,16 +72,18 @@ A dashboard written for mrefd 0.5.0+ in Go!

(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](https://go.dev/doc/install) +

(back to top)

+ ### Installation 1. Clone the repo @@ -140,7 +136,9 @@ 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` +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. @@ -149,6 +147,8 @@ 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. @@ -192,19 +192,19 @@ The makefile has various convience functions: * ```make package``` builds and packages everything up into a tarball for your system +

(back to top)

+ ## Roadmap - [x] Beta Release - [x] Refresh page on log file changes, instead of a meta refresh in browser - thanks AC8ZD - [x] Create two-column layout for Modules In Use, instead of a single column -- [ ] Add country flags for callsigns +- [x] Add country flags for callsigns See the [open issues](https://github.com/kc1awv/gomrefdash/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**. @@ -220,16 +220,12 @@ Don't forget to give the project a star! Thanks again!

(back to top)

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

(back to top)

- - ## Contact * M17 Project Discord - [![Discord][Discord]][Discord-url] @@ -238,8 +234,6 @@ Project Link: [https://github.com/kc1awv/gomrefdash](https://github.com/kc1awv/g

(back to top)

- - ## Acknowledgments * [Tom N7TAE](https://github.com/n7tae) _Creator of mrefd and inspiration for development_ @@ -249,7 +243,6 @@ Project Link: [https://github.com/kc1awv/gomrefdash](https://github.com/kc1awv/g

(back to top)

- [contributors-shield]: https://img.shields.io/github/contributors/kc1awv/gomrefdash.svg?style=for-the-badge [contributors-url]: https://github.com/kc1awv/gomrefdash/graphs/contributors [forks-shield]: https://img.shields.io/github/forks/kc1awv/gomrefdash.svg?style=for-the-badge