Browse Source

Update documentation for http(s) upload support.

Update the documentation to state that upload to http or https URIs is
now supported.
master
Damien Goutte-Gattat 2 months ago
parent
commit
f08f4c5c73
  1. 4
      README.md
  2. 15
      info/gfsecret.texi
  3. 12
      man/gfsec-split.1.in
  4. 12
      man/gfsec-use.1.in

4
README.md

@ -27,8 +27,8 @@ can be `file` (to access a share on the local filesystem), `label` (to
access a share on an external volume identified by its label), `uuid`
(to access a share on an external volume identified by its UUID), `mtp`
(to access a share on a MTP-compliant device identified by its serial
number), or `http` or `https` (to access a share on a remote web server
– only supported by _gfsec-use_, not by _gfsec-split_).
number), or `http` or `https` (to access a share on a remote web
server).
The _authority_ part identifies the storage device. It's the volume's
label when using the `label://` scheme, its UUID when using the

15
info/gfsecret.texi

@ -177,10 +177,13 @@ subsequent positional arguments on the command line (@ref{Specifying
Share URIs on the Command Line}), or be given through an interactive
menu (@ref{Interactive Selection of Shares}).
Note that @command{gfsec-split} does not support share URIs that use the
@samp{http} or @samp{https} scheme. If you want to put a share on a
remote web server, create the share on your system using the @samp{file}
scheme, move it to the web server, then update the generated
Note that @command{gfsec-split} only has a somewhat limited support for
the @samp{http} and @samp{https} scheme. In particular, authentication
to the remote web server, which is likely to be required for uploading
the share, can only be provided through a @file{.netrc} file. You may
find it a better option to create the share on your local filesystem
using the @samp{file} scheme, move it to the web server by any suitable
mean (e.g., using @command{scp}), and then update the generated
configuration file to replace the @samp{file://} URI by the appropriate
@samp{http} or @samp{https} URI.
@ -309,6 +312,10 @@ the same invocation of @command{gfsec-split}. The shares that you
describe on the command line will be added to the one you select in the
menu.
Note also that the interactive menu does not allow to specify shares to
be sent to a remove web server. If you wish to do that, you have to
specify a @samp{http} or @samp{https} URI on the command line.
@node Using a Split Secret
@chapter Using a Split Secret

12
man/gfsec-split.1.in

@ -1,4 +1,4 @@
.TH GFSEC-SPLIT 1 2017-07-25 "gfsecret @PACKAGE_VERSION@" "Gfsecret Manual"
.TH GFSEC-SPLIT 1 2021-07-17 "gfsecret @PACKAGE_VERSION@" "Gfsecret Manual"
.SH NAME
gfsec-split \- Split a file into shares and dispatch them
@ -108,6 +108,14 @@ by the specified label.
mtp://\fIserial\fR/
Indicates a file on the MTP device identified by the
specified serial number.
.TP
http://\fIhost\fR/
Indicates a file on a web server identified by its
hostname.
.TP
https://\fIhost\fR/
Same as the previous one, but the web server is to be
accessed through a secure connection.
.SH EXAMPLE INVOCATION
.PP
@ -149,7 +157,7 @@ Damien Goutte-Gattat
.SH COPYRIGHT
.ad l
.PP
Copyright \(co 2017 Damien Goutte-Gattat
Copyright \(co 2017,2021 Damien Goutte-Gattat
.PP
This program is released under the GNU General Public License.
See the COPYING file in the source distribution or

12
man/gfsec-use.1.in

@ -1,4 +1,4 @@
.TH GFSEC-USE 1 2017-07-23 "gfsecret @PACKAGE_VERSION@" "Gfsecret Manual"
.TH GFSEC-USE 1 2021-07-17 "gfsecret @PACKAGE_VERSION@" "Gfsecret Manual"
.SH NAME
gfsec-use \- Make use of a shared secret
@ -108,6 +108,14 @@ by the specified label.
mtp://\fIserial\fR/
Indicates a file on the MTP device identified by the
specified serial number.
.TP
http://\fIhost\fR/
Indicates a file on a web server identified by its
hostname.
.TP
https://\fIhost\fR/
Same as the previous one, but the web server is to be
accessed through a secure connection.
.PP
Whatever the scheme, the file part of the URI must end
@ -162,7 +170,7 @@ Damien Goutte-Gattat
.SH COPYRIGHT
.ad l
.PP
Copyright \(co 2017 Damien Goutte-Gattat
Copyright \(co 2017,2021 Damien Goutte-Gattat
.PP
This program is released under the GNU General Public License.
See the COPYING file in the source distribution or

Loading…
Cancel
Save