Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Pinning.RemoteServices.Policies.MFS #7913

Merged
merged 4 commits into from
Feb 18, 2021
Merged

docs: Pinning.RemoteServices.Policies.MFS #7913

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cfb3728
docs: Pinning.RemoteServices.Policies
lidel Feb 15, 2021
34a2e4a
style: improved MFS PinName example
lidel Feb 15, 2021
72e3e5c
style: docs/config.md
lidel Feb 15, 2021
3a3366a
docs: RepinInterval
lidel Feb 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 41 additions & 1 deletion docs/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,8 @@ does (e.g, `"1d2h4m40.01s"`).
- [`Pinning.RemoteServices.API`](#pinningremoteservices-api)
- [`Pinning.RemoteServices.API.Endpoint`](#pinningremoteservices-apiendpoint)
- [`Pinning.RemoteServices.API.Key`](#pinningremoteservices-apikey)
- [`Pinning.RemoteServices.Policies`](#pinningremoteservices-policies)
- [`Pinning.RemoteServices.Policies.MFS`](#pinningremoteservices-policiesmfs)
- [`Pubsub`](#pubsub)
- [`Pubsub.Router`](#pubsubrouter)
- [`Pubsub.DisableSigning`](#pubsubdisablesigning)
Expand Down Expand Up @@ -847,7 +849,7 @@ Example:
"API" : {
"Endpoint" : "https://pinningservice.tld:1234/my/api/path",
"Key" : "someOpaqueKey"
}
}
}
}
}
Expand All @@ -868,6 +870,44 @@ The key through which access to the pinning service is granted

Type: `string`

#### `Pinning.RemoteServices: Policies`

Contains additional opt-in policies for the remote pinning service
lidel marked this conversation as resolved.
Show resolved Hide resolved

##### `Pinning.RemoteServices: Policies.MFS`

When this policy is enabled it will be following changes to MFS
lidel marked this conversation as resolved.
Show resolved Hide resolved
and updating the pin for MFS root on the configured remote service.
lidel marked this conversation as resolved.
Show resolved Hide resolved

Pin request to the remote service is sent only when MFS root changed
lidel marked this conversation as resolved.
Show resolved Hide resolved
and time passed since the previous pin is bigger than `RepinInterval`.
lidel marked this conversation as resolved.
Show resolved Hide resolved

###### `Pinning.RemoteServices: Policies.MFS.Enabled`

Controls if this policy is active.

Default: `false`

Type: `bool`

###### `Pinning.RemoteServices: Policies.MFS.PinName`

Optional name to use for remote pin that represents MFS root CID.
lidel marked this conversation as resolved.
Show resolved Hide resolved
When left empty, default name will be generated.
lidel marked this conversation as resolved.
Show resolved Hide resolved

Default: `"policy/12.../mfs"`
lidel marked this conversation as resolved.
Show resolved Hide resolved

Type: `string`

###### `Pinning.RemoteServices: Policies.MFS.RepinInterval`

Defines how often (at most) the pin request should be sent to remote service.
lidel marked this conversation as resolved.
Show resolved Hide resolved
When left empty, default interval will be used. Values lower than `1m` will be ignored.
lidel marked this conversation as resolved.
Show resolved Hide resolved

Default: `"5m"`

Type: `duration`

## `Pubsub`

Pubsub configures the `ipfs pubsub` subsystem. To use, it must be enabled by
Expand Down