Skip to content

Commit

Permalink
Merge branch 'master' of github.com:textileio/docs
Browse files Browse the repository at this point in the history
* 'master' of github.com:textileio/docs:
  add some additional storage config props
  some formatting
  better wording
  per miner
  different spelling
  add a description
  • Loading branch information
andrewxhill committed Oct 17, 2020
2 parents f00c77f + 06c0e46 commit 79b86a8
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 14 deletions.
30 changes: 20 additions & 10 deletions docs/powergate/storageconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,26 +80,26 @@ Here is an example of the _default StorageConfig_.
// Filecoin describes the desired Filecoin configuration for a
// Cid in the Filecoin network.
"Filecoin": {
// RepFactor indicates the desired amount of active deals
// with different miners to store the data. While making deals
// the other attributes of FilConfig are considered for miner
// RepFactor indicates the desired amount of active deals
// with different miners to store the data. While making deals
// the other attributes of FilConfig are considered for miner
// selection.
"RepFactor": 1,
// DealDuration indicates the duration to be used when making
// DealDuration indicates the duration to be used when making
// new deals.
"DealDuration": 1000,
// ExcludedMiners is a set of miner addresses won't be ever be
// ExcludedMiners is a set of miner addresses won't be ever be
// selected when making new deals, even if they comply to other
// filters.
"ExcludedMiners": null,
// TrustedMiners is a set of miner addresses which will be
// TrustedMiners is a set of miner addresses which will be
// forcibly used when making new deals. An empty/nil list
// disables this feature.
"TrustedMiners": null,
// CountryCodes indicates that new deals should select miners
// CountryCodes indicates that new deals should select miners
// on specific countries.
"CountryCodes": null,
// Renew indicates deal-renewal configuration.
// Renew indicates deal-renewal configuration.
"Renew": {
// Enabled indicates that deal-renewal is enabled for this
// Cid.
Expand All @@ -108,9 +108,19 @@ Here is an example of the _default StorageConfig_.
// trigger deal renewal. e.g: 100 epoch before expiring.
"Threshold": 0
},
// Addr is the wallet address used to store the data in filecoin
// Addr is the wallet address used to store the data in filecoin
"Addr": "<unique>",
"MaxPrice": 0
// MaxPrice is the maximum price that will be spent per RepFactor
// to store the data in units of attoFIL per GiB per epoch
"MaxPrice": 0,
// FastRetrieval indicates that created deals should enable the
// fast retrieval feature.
"FastRetrieval": true,
// DealStartOffset indicates how many epochs in the future impose a
// deadline to new deals being active on-chain. This value might influence
// if miners accept deals, since they should seal fast enough to satisfy
// this constraint.
"DealStartOffset": 8640 // Equivalent to 72 hours
}
},
// If true, Powergate will detect if the data is no longer
Expand Down
7 changes: 3 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,9 @@ nav:
- Installation & Setup: hub/accounts.md
- APIs & API Keys: hub/apis.md
- Bucket Storage:
- Overview: buckets/index.md
- Permissions: buckets/permissions.md
- Filecoin Archiving: buckets/archiving.md
- Overview: buckets/index.md
- Permissions: buckets/permissions.md
- Filecoin Archiving: buckets/archiving.md
- ThreadDB Overview: threads/index.md
- User Mailboxes: users/index.md
- Powergate (Filecoin):
Expand Down Expand Up @@ -197,4 +197,3 @@ extra:
max_bucket_size: 4GiB
max_account_size: 4GiB
max_buckets_per_thread: 10000

0 comments on commit 79b86a8

Please sign in to comment.