Skip to content

Commit 29e0989

Browse files
committed
Docs: add examples of custom binary locations
1 parent 853a203 commit 29e0989

File tree

1 file changed

+21
-4
lines changed

1 file changed

+21
-4
lines changed

docs/install.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,16 @@ To install the prebuilt sharp binaries from a directory on the local filesystem,
144144
set the `sharp_local_prebuilds` npm config option
145145
or the `npm_config_sharp_local_prebuilds` environment variable.
146146

147+
URL example:
148+
if `sharp_binary_host` is set to `https://hostname/path`
149+
and the sharp version is `1.2.3` then the resultant URL will be
150+
`https://hostname/path/sharp-v1.2.3-napi-v5-platform-arch.tar.gz`.
151+
152+
Filename example:
153+
if `sharp_local_prebuilds` is set to `/path`
154+
and the sharp version is `1.2.3` then the resultant filename will be
155+
`/path/sharp-v1.2.3-napi-v5-platform-arch.tar.gz`.
156+
147157
### Prebuilt libvips binaries
148158

149159
To install the prebuilt libvips binaries from a custom URL,
@@ -154,10 +164,17 @@ To install the prebuilt libvips binaries from a directory on the local filesyste
154164
set the `sharp_libvips_local_prebuilds` npm config option
155165
or the `npm_config_sharp_libvips_local_prebuilds` environment variable.
156166

157-
The version subpath and file name are appended to these.
158-
For example, if `sharp_libvips_binary_host` is set to `https://hostname/path`
159-
and the libvips version is `1.2.3` then the resultant URL will be
160-
`https://hostname/path/v1.2.3/libvips-1.2.3-platform-arch.tar.br`.
167+
The version subpath and filename are appended to these.
168+
169+
URL example:
170+
if `sharp_libvips_binary_host` is set to `https://hostname/path`
171+
and the libvips version is `4.5.6` then the resultant URL will be
172+
`https://hostname/path/v4.5.6/libvips-4.5.6-platform-arch.tar.br`.
173+
174+
Filename example:
175+
if `sharp_libvips_local_prebuilds` is set to `/path`
176+
and the libvips version is `4.5.6` then the resultant filename will be
177+
`/path/v4.5.6/libvips-4.5.6-platform-arch.tar.br`.
161178

162179
See the Chinese mirror below for a further example.
163180

0 commit comments

Comments
 (0)