[docs] mention ssh demos in readme

3 months ago · a4bf5bacfd
parent acccc9f7a6
commit a4bf5bacfd
5 changed files with 95 additions and 20 deletions
--- a/README.md
+++ b/README.md
@ -32,10 +32,11 @@ Then, in the **lnav** TUI, you can:

 ## Screenshot

-The following screenshot shows a syslog file. Log lines are 
-displayed with highlights. Errors are red and warnings are yellow.
+The following screenshot shows a mix of syslog and web access log
+files.  Failed requests are shown in red.  Identifiers, like IP
+address and PIDs are semantically highlighted.

-[![Screenshot](docs/assets/images/lnav-syslog-thumb.png)](docs/assets/images/lnav-syslog.png)
+[![Screenshot](docs/assets/images/lnav-front-page.png)](docs/assets/images/lnav-front-page.png)

 ## Why not **just** use `tail`/`grep`/`less`?

@ -47,6 +48,20 @@ lines, but won't return a full multi-line log message.  Less can only
 display a single file at a time.  Also, none of these basic tools 
 handle compressed files.

+## Try online before installing
+
+You can SSH into a demo node to play with lnav before installing.
+
+The "playground" account starts lnav with a couple of log files as
+an example:
+
+[`$ ssh playground@demo.lnav.org`](ssh://playground@demo.lnav.org)
+
+The "tutorial 1" account is an interactive tutorial that can teach 
+you the basics of operation:
+
+[`$ ssh tutorial1@demo.lnav.org`](ssh://tutorial1@demo.lnav.org)
+
 ## Installation

 [Download a statically-linked binary for Linux/MacOS from the release page](https://github.com/tstack/lnav/releases/latest#release-artifacts)
--- a/test/expected/test_text_file.sh_5b51b55dff7332c5bee2c9b797c401c5614d574a.out
+++ b/test/expected/test_text_file.sh_5b51b55dff7332c5bee2c9b797c401c5614d574a.out
@ -53,13 +53,14 @@ Then, in the [1mlnav[0m TUI, you can:

 [1mScreenshot[0m

-The following screenshot shows a syslog file. Log lines are displayed
-with highlights. Errors are red and warnings are yellow.
+The following screenshot shows a mix of syslog and web access log
+files.  Failed requests are shown in red.  Identifiers, like IP
+address and PIDs are semantically highlighted.

-]8;;docs/assets/images/lnav-syslog.png\[4m🖼  Screenshot[1][0m]8;;\[4m[2][0m
+]8;;docs/assets/images/lnav-front-page.png\[4m🖼  Screenshot[1][0m]8;;\[4m[2][0m

- ▌[1] - file://{top_srcdir}/docs/assets/images/lnav-syslog-thumb.png 
- ▌[2] - file://{top_srcdir}/docs/assets/images/lnav-syslog.png       
+ ▌[1] - file://{top_srcdir}/docs/assets/images/lnav-front-page.png 
+ ▌[2] - file://{top_srcdir}/docs/assets/images/lnav-front-page.png 

 [1mWhy not [0m[1mjust[0m[1m use [0m[1m[37m[40m tail [0m[1m/[0m[1m[37m[40m grep [0m[1m/[0m[1m[37m[40m less [0m[1m?[0m

@ -71,6 +72,24 @@ won't return a full multi-line log message.  Less can only display a
 single file at a time.  Also, none of these basic tools handle
 compressed files.

+[1mTry online before installing[0m
+
+You can SSH into a demo node to play with lnav before installing.
+
+The [35m"playground"[0m account starts lnav with a couple of log files as an
+example:
+
+]8;;ssh://playground@demo.lnav.org\[4m[37m[40m $ ssh playground@demo.lnav.org [0m]8;;\[4m[1][0m
+
+ ▌[1] - ssh://playground@demo.lnav.org 
+
+The [35m"tutorial 1"[0m account is an interactive tutorial that can teach you
+the basics of operation:
+
+]8;;ssh://tutorial1@demo.lnav.org\[4m[37m[40m $ ssh tutorial1@demo.lnav.org [0m]8;;\[4m[1][0m
+
+ ▌[1] - ssh://tutorial1@demo.lnav.org 
+
 [1mInstallation[0m

 ]8;;https://github.com/tstack/lnav/releases/latest#release-artifacts\[4mDownload a statically-linked binary for Linux/MacOS from the release[0m]8;;\
--- a/test/expected/test_text_file.sh_6a24078983cf1b7a80b6fb65d5186cd125498136.out
+++ b/test/expected/test_text_file.sh_6a24078983cf1b7a80b6fb65d5186cd125498136.out
@ -1,12 +1,13 @@
 [1mScreenshot[0m

-The following screenshot shows a syslog file. Log lines are displayed
-with highlights. Errors are red and warnings are yellow.
+The following screenshot shows a mix of syslog and web access log
+files.  Failed requests are shown in red.  Identifiers, like IP
+address and PIDs are semantically highlighted.

-]8;;docs/assets/images/lnav-syslog.png\[4m🖼  Screenshot[1][0m]8;;\[4m[2][0m
+]8;;docs/assets/images/lnav-front-page.png\[4m🖼  Screenshot[1][0m]8;;\[4m[2][0m

- ▌[1] - file://{top_srcdir}/docs/assets/images/lnav-syslog-thumb.png 
- ▌[2] - file://{top_srcdir}/docs/assets/images/lnav-syslog.png       
+ ▌[1] - file://{top_srcdir}/docs/assets/images/lnav-front-page.png 
+ ▌[2] - file://{top_srcdir}/docs/assets/images/lnav-front-page.png 

 [1mWhy not [0m[1mjust[0m[1m use [0m[1m[37m[40m tail [0m[1m/[0m[1m[37m[40m grep [0m[1m/[0m[1m[37m[40m less [0m[1m?[0m

@ -18,6 +19,24 @@ won't return a full multi-line log message.  Less can only display a
 single file at a time.  Also, none of these basic tools handle
 compressed files.

+[1mTry online before installing[0m
+
+You can SSH into a demo node to play with lnav before installing.
+
+The [35m"playground"[0m account starts lnav with a couple of log files as an
+example:
+
+]8;;ssh://playground@demo.lnav.org\[4m[37m[40m $ ssh playground@demo.lnav.org [0m]8;;\[4m[1][0m
+
+ ▌[1] - ssh://playground@demo.lnav.org 
+
+The [35m"tutorial 1"[0m account is an interactive tutorial that can teach you
+the basics of operation:
+
+]8;;ssh://tutorial1@demo.lnav.org\[4m[37m[40m $ ssh tutorial1@demo.lnav.org [0m]8;;\[4m[1][0m
+
+ ▌[1] - ssh://tutorial1@demo.lnav.org 
+
 [1mInstallation[0m

 ]8;;https://github.com/tstack/lnav/releases/latest#release-artifacts\[4mDownload a statically-linked binary for Linux/MacOS from the release[0m]8;;\
--- a/test/expected/test_text_file.sh_c2a346ca1da2da4346f1d310212e166767993ce9.out
+++ b/test/expected/test_text_file.sh_c2a346ca1da2da4346f1d310212e166767993ce9.out
@ -2,7 +2,7 @@
    {
        "top_meta": {
            "file": "{top_srcdir}/README.md",
-            "anchor": "#usage-with-systemd-journald-",
+            "anchor": "#usage",
            "breadcrumbs": [
                {
                    "display_value": "README.md",
@ -44,6 +44,9 @@
                        {
                            "display_value": "Support"
                        },
+                        {
+                            "display_value": "Try online before installing"
+                        },
                        {
                            "display_value": "Usage"
                        },
@ -53,7 +56,7 @@
                    ]
                },
                {
-                    "display_value": "Usage with  systemd-journald ",
+                    "display_value": "⋯",
                    "search_placeholder": "",
                    "possibilities": [
                        {
--- a/test/expected/test_text_file.sh_e088ea61a5382458cc48a2607e2639e52b0be1da.out
+++ b/test/expected/test_text_file.sh_e088ea61a5382458cc48a2607e2639e52b0be1da.out
@ -1,12 +1,13 @@
 [1mScreenshot[0m

-The following screenshot shows a syslog file. Log lines are displayed
-with highlights. Errors are red and warnings are yellow.
+The following screenshot shows a mix of syslog and web access log
+files.  Failed requests are shown in red.  Identifiers, like IP
+address and PIDs are semantically highlighted.

-]8;;docs/assets/images/lnav-syslog.png\[4m🖼  Screenshot[1][0m]8;;\[4m[2][0m
+]8;;docs/assets/images/lnav-front-page.png\[4m🖼  Screenshot[1][0m]8;;\[4m[2][0m

- ▌[1] - file://{top_srcdir}/docs/assets/images/lnav-syslog-thumb.png 
- ▌[2] - file://{top_srcdir}/docs/assets/images/lnav-syslog.png       
+ ▌[1] - file://{top_srcdir}/docs/assets/images/lnav-front-page.png 
+ ▌[2] - file://{top_srcdir}/docs/assets/images/lnav-front-page.png 

 [1mWhy not [0m[1mjust[0m[1m use [0m[1m[37m[40m tail [0m[1m/[0m[1m[37m[40m grep [0m[1m/[0m[1m[37m[40m less [0m[1m?[0m

@ -18,6 +19,24 @@ won't return a full multi-line log message.  Less can only display a
 single file at a time.  Also, none of these basic tools handle
 compressed files.

+[1mTry online before installing[0m
+
+You can SSH into a demo node to play with lnav before installing.
+
+The [35m"playground"[0m account starts lnav with a couple of log files as an
+example:
+
+]8;;ssh://playground@demo.lnav.org\[4m[37m[40m $ ssh playground@demo.lnav.org [0m]8;;\[4m[1][0m
+
+ ▌[1] - ssh://playground@demo.lnav.org 
+
+The [35m"tutorial 1"[0m account is an interactive tutorial that can teach you
+the basics of operation:
+
+]8;;ssh://tutorial1@demo.lnav.org\[4m[37m[40m $ ssh tutorial1@demo.lnav.org [0m]8;;\[4m[1][0m
+
+ ▌[1] - ssh://tutorial1@demo.lnav.org 
+
 [1mInstallation[0m

 ]8;;https://github.com/tstack/lnav/releases/latest#release-artifacts\[4mDownload a statically-linked binary for Linux/MacOS from the release[0m]8;;\