diff --git a/docs/source/configuration.rst b/docs/source/configuration.rst index e30e03e3741dccae10a75c7055577b6db5c01893..c8ee9353000cc029b357b2e45a794c19489209b9 100644 --- a/docs/source/configuration.rst +++ b/docs/source/configuration.rst @@ -66,6 +66,42 @@ When tokens are received from an issuer during redemption, these are the only public keys which will satisfy the redeemer and cause the tokens to be made available to the client to be spent. Tokens received with any other public key will be sequestered and will *not* be spent until some further action is taken. +lease.crawl-interval.mean +~~~~~~~~~~~~~~~~~~~~~~~~~ + +This item controls the frequency at which the lease maintenance crawler runs. +The lease maintenance crawler visits all shares and renews their leases if necessary. +The crawler will run at random intervals. +The client will try to make the average (mean) interval between runs equal to this setting. +The value is an ISO8601 duration string. +For example to run on average every 26 days:: + + [storageclient.plugins.privatestorageio-zkapauthz-v1] + lease.crawl-interval.mean = P26D + +lease.crawl-interval.range +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This item also controls the frequency of lease maintenance crawler runs. +The random intervals between runs have a uniform distribution with this item's value as its range. +The value is an ISO8601 duration string. +For example to make all intervals fall within a 7 day period:: + + [storageclient.plugins.privatestorageio-zkapauthz-v1] + lease.crawl-interval.mean = P3DT12H + +lease.min-time-remaining +~~~~~~~~~~~~~~~~~~~~~~~~ + +This item controls the lease renewal behavior of the lease maintenance crawler. +It specifies an amount of time left on a lease. +If the crawler encounters a lease with less time left than this then it will renew the lease. +The value is an ISO8601 duration string. +For example to renew leases on all shares which will expire in less than one week:: + + [storageclient.plugins.privatestorageio-zkapauthz-v1] + lease.min-time-remaining = P7D + Server ------