aboutsummaryrefslogtreecommitdiff
path: root/doc/manual/packages/s3-substituter.xml
diff options
context:
space:
mode:
authorGraham Christensen <graham.christensen@target.com>2018-07-31 16:45:49 -0400
committerGraham Christensen <graham.christensen@target.com>2018-08-02 08:19:50 -0400
commit49a53c1d3f77ff33e14a95d004a6ce0720293997 (patch)
tree927f513b4fecc79b790ca266aa012393bac9dd6f /doc/manual/packages/s3-substituter.xml
parent3193f5ff3eb54b40b3330b26bc1eb89c4c4a3015 (diff)
s3 binary cache: support specifying an endpoint
Works for uploading and not downloading.
Diffstat (limited to 'doc/manual/packages/s3-substituter.xml')
-rw-r--r--doc/manual/packages/s3-substituter.xml17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/manual/packages/s3-substituter.xml b/doc/manual/packages/s3-substituter.xml
index 9fe137d72..bcd91cfdb 100644
--- a/doc/manual/packages/s3-substituter.xml
+++ b/doc/manual/packages/s3-substituter.xml
@@ -118,12 +118,29 @@ fetch prebuilt binaries from <uri>cache.nixos.org</uri>.</para>
</para>
</listitem>
</varlistentry>
+
+ <varlistentry><term><literal>endpoint</literal></term>
+ <listitem>
+ <para>
+ The URL to your S3-compatible service, for when not using
+ Amazon S3. Do not specify this value if you're using Amazon
+ S3.
+ </para>
+ <note><para>This endpoint must support HTTPS and will use
+ path-based addressing instead of virtual host based
+ addressing.</para></note>
+ </listitem>
+ </varlistentry>
</variablelist>
<example><title>Uploading with non-default credential profile for Amazon S3</title>
<para><command>nix copy --to ssh://machine nixpkgs.hello s3://example-bucket?profile=cache-upload</command></para>
</example>
+ <example><title>Uploading to an S3-Compatible Binary Cache</title>
+ <para><command>nix copy --to ssh://machine nixpkgs.hello s3://example-bucket?profile=cache-upload&amp;endpoint=minio.example.com</command></para>
+ </example>
+
<para>The user writing to the bucket will need to perform the
following actions against the bucket:</para>