diff --git a/README.md b/README.md index 2028d04..c94cc63 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,42 @@ # logstation # -**Note:** This branch is a rewrite of logstation in Go and React. Lots of work to do here but stay tuned! - Tails a set of log files and serves them up on a web server with syntax colors via regex. Binaries available in [releases](https://github.com/jdrews/logstation/releases). See [usage](https://github.com/jdrews/logstation#usage) below. Focus on: -- Support for both Windows and Linux +- Run on anything and everything - Support as many browsers as possible - Ease deployment and usage with a single executable with minimal configuration required -![image](https://user-images.githubusercontent.com/172766/42130891-cc14e292-7cc0-11e8-8db6-5f136254172b.png) +![image](https://user-images.githubusercontent.com/172766/228132770-567a2551-8d0d-43f0-b3a8-4517c141de7d.png) + Developed with Go and React ### Usage ### * Call `logstation` or `logstation.exe` -* It will create an logstation.conf in your current directory and exit -* Update logstation.conf +* It will create an logstation.conf in your current directory if one doesn't exist and exit +* Update logstation.conf as desired * Call `logstation` or `logstation.exe` again to start it -* Navigate to `http://127.0.0.1:8884` to start tailing +* Navigate to `http://127.0.0.1:8884` to start tailing (or your IP) -Can also use `-c your-logstation.conf` argument +Can also use `-c your-logstation.conf` argument to specify a config file Take a look at [an example logstation.conf here](logstation.default.conf). ### Building ### -Refer to the [Makefile](Makefile) for build details. -In general, run `make all` to build a `logstation` executable. +logstation uses [goreleaser](https://github.com/goreleaser/goreleaser) for all releases + +To build all targets locally you can run +`goreleaser build --snapshot --clean` + +If want to build for a specific target you can set environment variables for your target +In powershell this would look like: +`$env:GOOS="linux"; $env:GOARCH="amd64"; goreleaser build --snapshot --clean --single-target` + +Reference the [releases](https://github.com/jdrews/logstation/releases) and [.goreleaser.yaml](.goreleaser.yaml) for all officially supported targets. + +### Versions ### +Prior to 2.x, this app was built using Scala/Play/JS. At 2.x this app was rewritten in Go and React. If you're looking for the older versions reference the releases prior to 2.x.