lockfale/frontail

Forked from mthenw/frontail

streaming logs to the browser

Language: JavaScript


frontail – streaming logs to the browser

frontail is a Node.js application for streaming logs to the browser. It's a tail -F with UI.

Build Status Version

Quick start

Features

  • log rotation
  • auto-scrolling
  • marking logs
  • number of unread logs in favicon
  • themes (default, dark)
  • highlighting
  • search (Tab to focus, Esc to clear)
  • tailing multiple files and stdin
  • basic authentication

Installation

npm i frontail -g

or use Docker image

docker run -d -P -v /var/log:/log mthenw/frontail /log/syslog

Usage

frontail [options] [file ...]

Options:

  -h, --help                    output usage information
  -V, --version                 output the version number
  -h, --host <host>             listening host, default 0.0.0.0
  -p, --port <port>             listening port, default 9001
  -n, --number <number>         starting lines number, default 10
  -l, --lines <lines>           number on lines stored in browser, default 2000
  -t, --theme <theme>           name of the theme (default, dark)
  -d, --daemonize               run as daemon
  -U, --user <username>         Basic Authentication username, option works only along with -P option
  -P, --password <password>     Basic Authentication password, option works only along with -U option
  -k, --key <key.pem>           Private Key for HTTPS, option works only along with -c option
  -c, --certificate <cert.pem>  Certificate for HTTPS, option works only along with -k option
  --pid-path <path>             if run as daemon file that will store the process id, default /var/run/frontail.pid
  --log-path <path>             if run as daemon file that will be used as a log, default /dev/null
  --ui-hide-topbar              hide topbar (log file name and search box)
  --ui-no-indent                don't indent log lines
  --ui-highlight                highlight words or lines if defined string found in logs, default preset
  --ui-highlight-preset <path>  custom preset for highlighting (see ./preset/default.json)

Web interface runs on http://127.0.0.1:[port].

Tailing multiple files

[file ...] accepts multiple paths, *, ? and other shell special characters(Wildcards, Quotes, Back Quotes and Apostrophes in shell commands).

stdin

Use - for streaming stdin:

./server | frontail -

Highlighting

--ui-highlight option turns on highlighting in UI. By default preset from ./preset/defatult.json is used:

{
    "words": {
        "err": "color: red;"
    },
    "lines": {
        "err": "font-weight: bold;"
    }
}

which means that every "err" string will be in red and every line containing "err" will be bolded.

New presets are very welcome. If you don't like default or you would like to share yours, please create PR with json file.

Screenshot

screenshot1

Project Statistics

Sourcerank 1
Repository Size 238 KB
Stars 0
Forks 0
Watchers 7
Open issues disabled
Dependencies 15
Tags 40
Created
Last updated
Last pushed

Recent Tags See all

4.0.2 February 27, 2017
v4.0.1 October 05, 2016
v4.0.0 October 05, 2016
v3.1.2 September 04, 2016
v3.1.1 September 04, 2016
v3.1.0 September 04, 2016
v3.0.0 May 05, 2016
v2.3.0 March 30, 2016
v2.2.1 January 29, 2016
v2.2.0 January 25, 2016
2.1.2 January 11, 2016
v2.1.1 July 06, 2015
v2.1.0 March 27, 2015
v2.0.0 March 03, 2015
v1.4.1 February 23, 2015

Something wrong with this page? Make a suggestion

Last synced: 2017-04-07 00:11:52 UTC

Login to resync this repository