update readme

master
Conduitry 4 years ago
parent acb01d4957
commit 4f98f7089a
  1. 12
      README.md

@ -4,19 +4,23 @@ Another shim to allow Linux containers running on Docker for Windows to watch fo
## Usage
`node.exe shim.js container_name`
`node.exe shim.js`
where `container_name` is the name or id of the container whose bind mounts you want to watch.
Watches the bind mounts of all running containers, and monitors the starting and stopping of containers, and starts and stops watching as appropriate.
`node.exe shim.js container_name container_name...`
If you specify one or more container names or ids, all bind mounts on these containers will be watched. The starting and stopping of containers will not be monitored.
## Limitations
Many. This is a very new tool.
No error handling. Probably reacts poorly to mounted files (as opposed to directories). No debouncing. No sanity checking of watch events. Some of this might be on the horizon.
No error handling. Probably reacts poorly to mounted files (as opposed to directories). No sanity checking of watch events. Some of this might be on the horizon.
## Under the hood
This directly queries the Docker Engine API. It finds all of the bind mounts for the given container, and determines the real Windows path and the Linux container's path to each one. It uses `fs.watch` to watch the directory from within Windows. For each change, it sends `chmod + /path/of/mounted.file` to the container, again using the Docker Engine API.
This tool directly queries the Docker Engine API to look up containers, find running containers, monitor starting/stopping containers, and send commands to containers. It finds all of the bind mounts for the appropriate container(s), and determines the real Windows path and the Linux container's path to each one. It uses `fs.watch` to watch the directory from within Windows. For each change, it sends `chmod + /mounted/path/of/modified.file` to the container.
## License