https://github.com/mishankov/web-tail

📖 Web based log monitoring tool
https://github.com/mishankov/web-tail

docker log logging monitoring real-time ssh svelte

Last synced: 5 days ago
JSON representation

📖 Web based log monitoring tool

• Host: GitHub
• URL: https://github.com/mishankov/web-tail
• Owner: mishankov
• License: mit
• Created: 2022-01-24T14:23:19.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-03T07:47:44.000Z (7 months ago)
• Last Synced: 2024-04-14T12:35:37.642Z (7 months ago)
• Topics: docker, log, logging, monitoring, real-time, ssh, svelte
• Language: TypeScript
• Homepage:
• Size: 536 KB
• Stars: 12
• Watchers: 2
• Forks: 4
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Web tail

[![CodeFactor](https://www.codefactor.io/repository/github/mishankov/web-tail/badge)](https://www.codefactor.io/repository/github/mishankov/web-tail)

Web application to view lines from file on local system or on remote server built with [Svelte](https://github.com/sveltejs/svelte)

![](images/image-1.png)

## Installation

Download and unpack `web-tail-x.x.x-[platform].zip` from [latest release](https://github.com/mishankov/web-tail/releases/latest)

## Configuration

In unpacked folder edit `web-tail.config.toml` file

- `port` - Port that Web tail will run on. Defaults value is `4444`

- `openBrowserOnStart` - automatically open tab with Web tail in your default browser on start. Default value is `false`

- `servers` - reusable servers configuration

  - `name` - name of server to use in `sources` configs

  - `host` - host of remote server. Mandatory field for source types `ssh:*`

  - `port` - port of remote server. Mandatory field for source types `ssh:*`

  - `username` - username for ssh connection to remote server. Mandatory for source types `ssh:*`

  - `password` - password to authenticate on remote server. Either this or `privateKeyPath` is mandatory for source types `ssh:*`

  - `privateKeyPath` - path to file with private key to authenticate on remote server. Either this or `password` is mandatory for source types `ssh:*`

- `sources` - list of sources to tail lines from

  - `name` - name of source. Mandatory field

  - `type` - type of source. Possible values: `local:file`, `local:docker`, `ssh:file`, `ssh:docker`. Mandatory field

  - `path` - path to file. Mandatory field for source types `*:file`

  - `serverName` - name of a server from `servers` list

  - `containerId` - Docker container ID. Mandatory field for source types `*:docker`

  - `host` - host of remote server. Mandatory field for source types `ssh:*`

  - `port` - port of remote server. Mandatory field for source types `ssh:*`

  - `username` - username for ssh connection to remote server. Mandatory for source types `ssh:*`

  - `password` - password to authenticate on remote server. Either this or `privateKeyPath` is mandatory for source types `ssh:*`

  - `privateKeyPath` - path to file with private key to authenticate on remote server. Either this or `password` is mandatory for source types `ssh:*`

## Run

Launch executable for your platform: macOS, Windows or Linux

Or you can download source code and run commands

```console

npm install

npm run build

npm run start

```

## Usage

![](images/image-2.png)

Options from left to right:

- Dropdown to select one of sources from `web-tail.config.toml`

- Search field. Matching results will be selected. Search is case insensitive by default

- `Filter` toggle. If enabled only lines with matching results are shown

- `.*` toggle. If enabled treats text in search field as regular expression

- `Aa` toggle. If enabled makes search case sensitive

- `Reverse` toggle. If enabled latest lines shown on top

- Max lines field. How much lines will be shown