millenoki/frontail

Forked from mthenw/frontail

realtime log stream in the browser

License: MIT

Language: JavaScript


frontail(1) – realtime log stream in the browser

frontail is node.js application for serving tail -F output to browser.

Build Status Version

Features

  • search (Tab to focus, Esc to clear)
  • basic authentication
  • working over ssh
  • log rotation
  • auto-scrolling
  • marking logs
  • themes (default, dark)
  • number of unread logs in favicon
  • highlighting

Installation

npm install frontail -g

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 ./preset/default.json
  --ui-highlight-preset <path>  custom preset for highlighting (see ./preset/default.json)
  --remote-host <remote_host>   setting the remote host for a tail over ssh (e.g: 192.168.0.2)
  --remote-user <remote_user>   setting the remote user for a tail over ssh, default root
  --remote-port <remote_port>   setting the remote port for a tail over ssh, default 22

Web interface is on http://localhost:[port].

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 with "err" will be bolded. Custom preset can be provided by

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

Screenshot

screenshot1

Project Statistics

Sourcerank 3
Repository Size 782 KB
Stars 0
Forks 0
Watchers 1
Open issues disabled
Dependencies 15
Contributors 7
Tags 27
Created
Last updated
Last pushed

Top Contributors See all

Maciej Winnicki Lexx Manuel de la Peña Patrik Johnson Andrew Davis Piotr Gabryjeluk skarnecki

Recent Tags See all

v2.0.0 March 03, 2015
v1.4.1 February 23, 2015
v1.4.0 February 09, 2015
v1.3.0 October 07, 2014
v1.2.1 July 13, 2014
v1.2.0 May 28, 2014
v1.1.0 March 29, 2014
v1.0.0 February 28, 2014
v0.7.0 January 10, 2014
v0.6.0 November 06, 2013
v0.5.0 November 01, 2013
v0.4.2 August 22, 2013
v0.4.1 June 20, 2013
v0.4.0 June 20, 2013
v0.3.1 March 28, 2013

Something wrong with this page? Make a suggestion

Last synced: 2016-10-14 13:57:07 UTC

Login to resync this repository