ab-docker/ab-livereload
1
0
Fork 0
Code Issues Pull Requests Releases 7 Activity

Compare commits

base: ab-docker:13ec1a72e94ced98c24f8f32b9dca239b87777ac
Branches Tags
ab-docker:main
ab-docker:4.0.1
ab-docker:v4.0.0
ab-docker:v3.0.0
ab-docker:v2.7
ab-docker:v2.5.1
ab-docker:v2.5
ab-docker:v2.3
ab-docker:v1.2
..
compare: ab-docker:8cafe6e16464d36efcd7e01cd018ec27a12502cb
Branches Tags
ab-docker:4.0.1
ab-docker:main
ab-docker:v4.0.0
ab-docker:v3.0.0
ab-docker:v2.7
ab-docker:v2.5.1
ab-docker:v2.5
ab-docker:v2.3
ab-docker:v1.2

2 Commits
13ec1a72e9 ... 8cafe6e164

Author SHA1 Message Date
Asif Bacchus
8cafe6e164 fix readme formatting error 2021-07-28 04:24:42 -06:00
Asif Bacchus
99cc14532c docs(readme): update readme to reflect fixed exclusions 2021-07-28 04:20:50 -06:00
1 changed files with 3 additions and 1 deletions
Show Stats Expand all files Collapse all files

4
README.md
View File

@ -53,7 +53,7 @@ ## Environment variables
| TZ | Set the container's time zone. NO impact on runtime, included for convenience. | Etc/UTC | | 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_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_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.<br />JavaScript regex format is: `/your-regex/`<br />**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.<br />**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_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_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 | | LR_HTTPS | Use HTTPS and WSS. In other words, use a certificate for SSL/TLS operation. | true |
@ -103,6 +103,8 @@ ### Run in HTTP (unsecured) mode
- `-p 35729:35729`: map on all interfaces port 35729 on the host --> port 35729 in container - `-p 35729:35729`: map on all interfaces port 35729 on the host --> port 35729 in container
- `listen`: start the Livereload server - `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 ### Run in HTTPS mode with supplied certificate
```bash ```bash