diff options
| author | Gyan Doshi <ffmpeg@gyani.pro> | 2022-05-26 16:18:57 +0530 |
|---|---|---|
| committer | Gyan Doshi <ffmpeg@gyani.pro> | 2022-05-26 16:21:28 +0530 |
| commit | 0dcbe1c1aa8ace2a84a4a7963acd755c4bbd96fb (patch) | |
| tree | b0b200a6afe2bf7fc687a3b706a0d85ae7e3e344 /doc | |
| parent | 8a0f7f7bfe86a2cc57edd5255ecc144dc17e51a3 (diff) | |
doc/protocols: add details and reformat IPFS section
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/protocols.texi | 33 |
1 files changed, 17 insertions, 16 deletions
diff --git a/doc/protocols.texi b/doc/protocols.texi index 399e998068..39b719dc50 100644 --- a/doc/protocols.texi +++ b/doc/protocols.texi @@ -617,15 +617,26 @@ icecast://[@var{username}[:@var{password}]@@]@var{server}:@var{port}/@var{mountp @section ipfs InterPlanetary File System (IPFS) protocol support. One can access files stored -on the IPFS network through so called gateways. Those are http(s) endpoints. -This protocol wraps the IPFS native protocols (ipfs:// and ipns://) to be send +on the IPFS network through so-called gateways. These are http(s) endpoints. +This protocol wraps the IPFS native protocols (ipfs:// and ipns://) to be sent to such a gateway. Users can (and should) host their own node which means this -protocol will use your local gateway to access files on the IPFS network. +protocol will use one's local gateway to access files on the IPFS network. -If a user doesn't have a node of their own then the public gateway dweb.link is -used by default. +If a user doesn't have a node of their own then the public gateway @code{https://dweb.link} +is used by default. -You can use this protocol in 2 ways. Using IPFS: +This protocol accepts the following options: + +@table @option + +@item gateway +Defines the gateway to use. When not set, the protocol will first try +locating the local gateway by looking at @code{$IPFS_GATEWAY}, @code{$IPFS_PATH} +and @code{$HOME/.ipfs/}, in that order. If that fails @code{https://dweb.link} will be used. + +@end table + +One can use this protocol in 2 ways. Using IPFS: @example ffplay ipfs://QmbGtJg23skhvFmu9mJiePVByhfzu5rwo74MEkVDYAmF5T @end example @@ -635,16 +646,6 @@ Or the IPNS protocol (IPNS is mutable IPFS): ffplay ipns://QmbGtJg23skhvFmu9mJiePVByhfzu5rwo74MEkVDYAmF5T @end example -You can also change the gateway to be used: - -@table @option - -@item gateway -Defines the gateway to use. When nothing is provided the protocol will first try -your local gateway. If that fails dweb.link will be used. - -@end table - @section mmst MMS (Microsoft Media Server) protocol over TCP. |