Skip to content

Commit

Permalink
update README.md to reflect rewrite in go and react
Browse files Browse the repository at this point in the history
  • Loading branch information
jdrews committed Jul 30, 2022
1 parent 70302dd commit efd61e9
Showing 1 changed file with 5 additions and 49 deletions.
54 changes: 5 additions & 49 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,66 +9,22 @@ Binaries avaiable in [releases](https://github.com/jdrews/logstation/releases).
Focus on:
- Support for both Windows and Linux
- Support as many browsers as possible
- Support for Java 1.6+
- Ease deployment and usage by generating fat jars with minimal configuration required
- 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)

Developed with Scala, Akka, Lift, Comet (Ajax Push), and JavaScript.
Developed with Go and React

### Usage ###
* Call `java -jar logstation.jar`
* Call `logstation` or `logstation.exe`
* It will create an logstation.conf in your current directory and exit
* Update logstation.conf
* Call `java -jar logstation.jar` again to start it
* Call `logstation` or `logstation.exe` again to start it
* Navigate to `http://127.0.0.1:8884` to start tailing

Can also use `-c your-logstation.conf` argument

#### logstation.conf example ####

```
logstation {
# Windows example of setting up logs
logs=["C:\\git\\logstation\\test\\logfile.log","C:\\git\\logstation\\test\\logfile2.log"]
# Unix example of setting up logs
# logs=["/home/jdrews/git/logstation/logfile.log","/home/jdrews/git/logstation/logfile2.log"]
# Setup your syntax below
# <some-name>=[<RGB_HEX>,<regex-for-line-matching>]
# matching gives priority to the top most
syntax {
# red
error=["#FF1F1F",".*ERROR.*"]
# yellow
warn=["#F2FF00",".*WARN.*"]
# green
info=["#00FF2F",".*INFO.*"]
# blue
debug=["#4F9BFF",".*DEBUG.*"]
# cyan
trace=["#4FFFF6",".*TRACE.*"]
}
# Web Server Port
# The port used to connect to the LogStation
webServerPort=8884
# Number of lines to display per log file
# any logs over this will truncate the oldest lines from the page
maxLogLinesPerLog=500
# Number of messages to buffer on server
# These will be sent to any new connections so they have some history of logs
# bufferLength is multiplied by number of logs, and buffered on best effort for each log
bufferLength=10
# Unique name for logstation instance
# This name will be prepended to the browser tab
# Can be useful when connecting to multiple logstations
logStationName="dc10srv42"
}
```
Take a look at [an example logstation.conf here](logstation.default.conf).

### Building ###

Expand Down

0 comments on commit efd61e9

Please sign in to comment.