From 99cc14532c21ce7e50a629ce2e5a3e583a101832 Mon Sep 17 00:00:00 2001 From: Asif Bacchus Date: Wed, 28 Jul 2021 04:20:50 -0600 Subject: [PATCH] docs(readme): update readme to reflect fixed exclusions --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ffd50a9..ed05147 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,10 @@ ## Environment variables | TZ | Set the container's time zone. NO impact on runtime, included for convenience. | Etc/UTC | | LR_PORT | Port over which Livereload will communicate. All clients presently expect port 35729, so I suggest leaving this alone. | 35729 | | LR_EXTS | Defines monitored extensions. | html,xml,css,js,jsx,ts,tsx,php,py | -| LR_EXCLUDE | Array of JavaScript regular-expressions (Regex) that define paths or files to ignore. These are *appended* to the node-livereload upstream defaults which ignore everything in the `.git/`, `.svn/` and `.hg/` directories.
JavaScript regex format is: `/your-regex/`
**N.B.** At present, exclusions do not seem to be working properly. I’ve filed an issue upstream and will update the container when it’s resolved. | /\\.vscode//,/\\.idea//,/\\.tmp/,/\\.swp/ | +| LR_EXCLUDE | Comma-delimited regular-expressions (Regex) that define paths or files to ignore. These are * +appended* to the node-livereload upstream defaults which ignore everything in the `.git/`, `.svn/` and `.hg/` directories.
** +N.B.** You do * +not* have to use JavaScript format. The script will automatically convert things to JS-RegEx. You do, however, need to escape any special characters. | .vscode/,.idea/,.tmp$,.swp$/ | | LR_DELAY | Time (ms) between polling for changed files. | 500 | | LR_DEBUG | Print informational messages to the console. Allows you to see Livereload working. | true | | LR_HTTPS | Use HTTPS and WSS. In other words, use a certificate for SSL/TLS operation. | true | @@ -103,6 +106,8 @@ ### Run in HTTP (unsecured) mode - `-p 35729:35729`: map on all interfaces port 35729 on the host --> port 35729 in container - `listen`: start the Livereload server +> Depending on your environment, you may *not* want to expose your Livereload server on all interfaces! You may want to map your port to something like `127.0.0.1:35729:35729` and then establishing an SSH-tunnel from your client. This is completely dependent on your environment and beyond the scope of this readme, sorry. + ### Run in HTTPS mode with supplied certificate ```bash