Go to file
Manuel de la Peña 1d8fb184c3 [#42] Follow doSecure approach for SSH connections 2015-02-23 20:03:25 +01:00
bin Moved to index.js 2013-08-22 17:46:35 +02:00
lib [#42] Follow doSecure approach for SSH connections 2015-02-23 20:03:25 +01:00
preset Tests and README update 2014-10-06 22:55:51 +02:00
test [#41] Source formatting (Travis-ci complained about line length) 2015-02-20 14:55:03 +01:00
.gitignore jscs check 2014-10-05 14:33:25 +02:00
.jscsrc Some parameters moved from jshint to jscs 2014-10-07 23:40:55 +02:00
.jshintignore lint fixes 2013-11-01 23:36:45 +02:00
.jshintrc Some parameters moved from jshint to jscs 2014-10-07 23:40:55 +02:00
.travis.yml jscs check 2014-10-05 14:33:25 +02:00
LICENSE License in separate file 2013-11-24 12:26:44 +01:00
README.md README update with info about ssh. Version bump. 2015-02-10 00:30:16 +01:00
index.js [#42] Follow doSecure approach for SSH connections 2015-02-23 20:03:25 +01:00
package.json README update with info about ssh. Version bump. 2015-02-10 00:30:16 +01:00

README.md

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 [path]         highlight words or lines if defined string found in logs, default preset ./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 [path] 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