From 12f102abf6cbd174b4dc9323672f59c6357b561c Mon Sep 17 00:00:00 2001 From: Marius Date: Wed, 24 Apr 2019 22:48:56 +0200 Subject: [PATCH] docs: add note about hook extensions on Windows See https://github.com/tus/tusd/issues/267 --- docs/hooks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/hooks.md b/docs/hooks.md index ad351f6..04acc92 100644 --- a/docs/hooks.md +++ b/docs/hooks.md @@ -58,7 +58,7 @@ $ tusd --hooks-dir ./path/to/hooks/ ... ``` -If an event occurs, the tusd binary will look for a file, named exactly as the event, which will then be executed, as long as the object exists. In the example above, the binary `./path/to/hooks/pre-create` will be invoked, before an upload is created, which can be used to e.g. validate certain metadata. Please note, that the hook file *must not* have an extension, such as `.sh` or `.py`, or else tusd will not recognize and ignore it. A detailed list of all events can be found at the end of this document. +If an event occurs, the tusd binary will look for a file, named exactly as the event, which will then be executed, as long as the object exists. In the example above, the binary `./path/to/hooks/pre-create` will be invoked, before an upload is created, which can be used to e.g. validate certain metadata. Please note, that in UNIX environments the hook file *must not* have an extension, such as `.sh` or `.py`, or else tusd will not recognize and ignore it. On Windows, however, the hook file *must* have an extension, such as `.bat` or `.exe`. A detailed list of all events can be found at the end of this document. ### The Hook's Environment