mdebray/tvl-depot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

s3: document scheme query parameter

Browse source
This commit is contained in:
Daiderd Jordan 2018-12-07 23:48:35 +01:00
parent 898823b67d
commit 77cc632186
No known key found for this signature in database
GPG key ID: D02435D05B810C96
1 changed files with 13 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
doc/manual/packages/s3-substituter.xml
View file

@ -51,6 +51,18 @@ the S3 URL:</para>
addressing.</para></note> addressing.</para></note>
</listitem> </listitem>
</varlistentry> </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> </variablelist>
<para>In this example we will use the bucket named <para>In this example we will use the bucket named
@ -165,7 +177,7 @@ the S3 URL:</para>
</example> </example>
<example><title>Uploading to an S3-Compatible Binary Cache</title> <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> </example>
</section> </section>
</section> </section>