-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Remove dcrdocs specific formatting. Remove some redundant/outdated requirements.
- Loading branch information
1 parent
9aab89e
commit b8bc370
Showing
1 changed file
with
30 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,44 +1,38 @@ | ||
| # Operating a Voting Service Provider (VSP) | ||
| # Listing a VSP on decred.org | ||
|
|
||
| --- | ||
|
|
||
| ## Overview | ||
|
|
||
| VSPs are a key part of the Decred infrastructure which make participating in proof-of-stake much more accessible for the average user. It is desirable to increase the number of operating VSPs in order to promote decentralization, improve the stability of the Decred network, and give stakeholders more choice. | ||
|
|
||
| This is a high level guide of how to set up a VSP, and the steps required to list a VSP on [decred.org](https://decred.org/vsp) and in Decrediton wallet. The guide is deliberately written at a high level and with minimal details because a level of system admin experience is assumed for VSP operators. | ||
|
|
||
| --- | ||
| Public VSP servers are a key part of the Decred infrastructure as they make | ||
| Proof-of-Stake far more accessible for the average user. | ||
| It is therefore desirable to increase the number of public VSPs listed in | ||
| Decrediton and on [decred.org](https://decred.org/vsp) in order to promote | ||
| decentralization and improve the stability of the Decred network. | ||
|
|
||
| ## Operator Requirements | ||
|
|
||
| * Familiarity with system administration work on Linux, e.g. configuring and running nginx, ssh, IPSec, duplicity, monit | ||
| * Familiarity with compiling from source, setting up and maintaining `dcrd` and `dcrwallet` | ||
| * Ability to effectively communicate in English | ||
| * Willingness to stay in touch with the Decred community for important news and updates | ||
| * Availability to update VSP binaries when new releases are produced | ||
| * Operators should ideally be pairs of individuals or larger groups, e.g. corporate entities, so that the unavailability of a single person does not lead to extended outages in their absence | ||
|
|
||
| --- | ||
|
|
||
| ## VSP Requirements | ||
|
|
||
| There are several requirements for the VSP configuration: | ||
|
|
||
| * At least one machine to host the web front end, handling web connections from VSP users. | ||
| * At least three machines to host voting wallets. Necessary because at least one voting wallet needs to be connected to the network and ready to vote at any time. | ||
| * Each voting wallet should be connected to a dedicated local instance of `dcrd`. | ||
| * The physical or virtual machines used to host the configuration must be spread across 3 or more physical locations. | ||
| * More specifically, voting wallets must be in 3+ physically separate locations. | ||
| * The web frontend must have an IP that is distinct from those of the voting wallets, and is ideally located in another physical location. | ||
| * Source code for the VSP is available [on GitHub](https://github.com/decred/vspd) and binaries must be compiled from source. | ||
| * The VSP must be run on testnet for 1 week to confirm it is working properly. Uptime and number of votes made versus missed will be checked. | ||
| * The VSP must be run on mainnet in test mode (no public access) until a VSP operator demonstrates they have successfully voted 1 ticket of their own using the VSP. | ||
| * The operator must have an adequate monitoring solution in place, ideally alerting on server downtime and application error logging. | ||
|
|
||
| --- | ||
| * Willingness to stay in touch with the Decred community for important news and | ||
| updates. A private channel on [Matrix](https://chat.decred.org) exists for | ||
| this purpose. | ||
| * Availability to update VSP binaries when new releases are produced. | ||
| * Operators should ideally be pairs of individuals or larger groups, so that the | ||
| unavailability of a single person does not lead to extended outages in their | ||
| absence. | ||
| * Ability to effectively communicate in English. | ||
|
|
||
| ## Deployment Requirements | ||
|
|
||
| * At least one machine dedicated to hosting the web front end, handling web | ||
| connections from VSP users. | ||
| * At least three dedicated machines hosting voting wallets and a local instance | ||
| of dcrd. | ||
| * The machines used to host the voting wallets must be spread across 3 or more | ||
| physically separate locations. | ||
| * The VSP must be run on testnet for 1 week to confirm it is working properly. | ||
| Uptime and number of votes made versus missed will be checked. | ||
| * The VSP must be run on mainnet in test mode (no public access) until a VSP | ||
| operator demonstrates they have successfully voted 1 ticket of their own using | ||
| the VSP. | ||
| * The operator must have an adequate monitoring solution in place, ideally | ||
| alerting on server downtime and application error logging. | ||
|
|
||
| ## Further Information | ||
|
|
||
| More detailed instructions on how to setup a VSP can be found on GitHub in the [vspd repo](https://github.com/decred/vspd). | ||
| For further support you can contact the [Decred community](https://decred.org/community). |