docs: Pinning.RemoteServices.Policies
(cherry picked from commit c338ed83c7a8e7b9e4e679837a6771f8611abb15)
Marcin Rataj committed
Feb 15, 2021 at 19:47 UTC
a40cbb03e1ae07d932b3dc93a5d274fb91458590
1 file changed
+41
-1
docs/config.md
+41
-1
@@ -181,6 +181,8 @@ does (e.g, `"1d2h4m40.01s"`).
181
- [`Pinning.RemoteServices.API`](#pinningremoteservices-api)
182
- [`Pinning.RemoteServices.API.Endpoint`](#pinningremoteservices-apiendpoint)
183
- [`Pinning.RemoteServices.API.Key`](#pinningremoteservices-apikey)
184
+ - [`Pinning.RemoteServices.Policies`](#pinningremoteservices-policies)
185
+ - [`Pinning.RemoteServices.Policies.MFS`](#pinningremoteservices-policiesmfs)
186
- [`Pubsub`](#pubsub)
187
- [`Pubsub.Router`](#pubsubrouter)
188
- [`Pubsub.DisableSigning`](#pubsubdisablesigning)
@@ -847,7 +849,7 @@ Example:
849
"API" : {
850
"Endpoint" : "https://pinningservice.tld:1234/my/api/path",
851
"Key" : "someOpaqueKey"
850
- }
852
+ }
853
}
854
}
855
}
@@ -868,6 +870,44 @@ The key through which access to the pinning service is granted
870
871
Type: `string`
872
873
+#### `Pinning.RemoteServices: Policies`
874
+
875
+Contains additional opt-in policies for the remote pinning service
876
+
877
+##### `Pinning.RemoteServices: Policies.MFS`
878
+
879
+When this policy is enabled it will be following changes to MFS
880
+and updating the pin for MFS root on the configured remote service.
881
+
882
+Pin request to the remote service is sent only when MFS root changed
883
+and time passed since the previous pin is bigger than `RepinInterval`.
884
+
885
+###### `Pinning.RemoteServices: Policies.MFS.Enabled`
886
+
887
+Controls if this policy is active.
888
+
889
+Default: `false`
890
+
891
+Type: `bool`
892
+
893
+###### `Pinning.RemoteServices: Policies.MFS.PinName`
894
+
895
+Optional name to use for remote pin that represents MFS root CID.
896
+When left empty, default name will be generated.
897
+
898
+Default: `"policy/12.../mfs"`
899
+
900
+Type: `string`
901
+
902
+###### `Pinning.RemoteServices: Policies.MFS.RepinInterval`
903
+
904
+Defines how often (at most) the pin request should be sent to remote service.
905
+When left empty, default interval will be used. Values lower than `1m` will be ignored.
906
+
907
+Default: `"5m"`
908
+
909
+Type: `duration`
910
+
911
## `Pubsub`
912
913
Pubsub configures the `ipfs pubsub` subsystem. To use, it must be enabled by