aboutsummaryrefslogtreecommitdiff
path: root/doc/manual
diff options
context:
space:
mode:
authorDaiderd Jordan <daiderd@gmail.com>2018-12-07 23:48:35 +0100
committerDaiderd Jordan <daiderd@gmail.com>2018-12-08 00:15:00 +0100
commit77cc632186d6a0bb63c1e16238f628857bc6e7bd (patch)
treed461bc85040bbf540e8023bc1f5c58d18c733fd6 /doc/manual
parent898823b67d4d9ceeaebf166957141706eb03ad72 (diff)
s3: document scheme query parameter
Diffstat (limited to 'doc/manual')
-rw-r--r--doc/manual/packages/s3-substituter.xml14
1 files changed, 13 insertions, 1 deletions
diff --git a/doc/manual/packages/s3-substituter.xml b/doc/manual/packages/s3-substituter.xml
index ea654392c..2ec9687a0 100644
--- a/doc/manual/packages/s3-substituter.xml
+++ b/doc/manual/packages/s3-substituter.xml
@@ -51,6 +51,18 @@ the S3 URL:</para>
addressing.</para></note>
</listitem>
</varlistentry>
+
+ <varlistentry><term><literal>scheme</literal></term>
+ <listitem>
+ <para>
+ The scheme used for S3 requests, <literal>https</literal>
+ (default) or <literal>http</literal>. This option allows you to
+ disable HTTPS for binary caches which don't support it.
+ </para>
+ <note><para>HTTPS should be used if the cache might contain
+ sensitive information.</para></note>
+ </listitem>
+ </varlistentry>
</variablelist>
<para>In this example we will use the bucket named
@@ -165,7 +177,7 @@ the S3 URL:</para>
</example>
<example><title>Uploading to an S3-Compatible Binary Cache</title>
- <para><command>nix copy --to 's3://example-nix-cache?profile=cache-upload&amp;endpoint=minio.example.com' nixpkgs.hello</command></para>
+ <para><command>nix copy --to 's3://example-nix-cache?profile=cache-upload&amp;scheme=https&amp;endpoint=minio.example.com' nixpkgs.hello</command></para>
</example>
</section>
</section>