BlockchainCommons / GordianServer-macOS

Tor-protected full-node GordianServer for macOS
Other
63 stars 8 forks source link

Updates for Help Screens #36

Open shannona opened 4 years ago

shannona commented 4 years ago

Here are some suggested revisions for the Bitcoin-Standup-MACOS help screens:

INITIAL MESSAGE:

Ready to Stand Up?

StandUp will install and configure a fully indexed Bitcoin Core XX node and Tor XX.

Once your Standup has fully installed, you will want to "Start" the syncing of a Bitcoin network and "Add" a Tor public key from your client, such as FullyNoded.

Standup requires ~30gb of space for a testnet installation and ~300gb for mainnet. It will create a /Users/XX/StandUp directory and will install your bitcoin.conf in /Users/XX/Library/Application Support/Bitcoin. Any missing RPC credentials will automatically be created and added to the bitcoin.conf file.

You can make changes to how the blockchain is stored (such as pruning it or changing your data directory), look at logs, or shutdown Standup in settings, available by clicking the gear icon.

--

BITCOIN CORE HELP:

Bitcoin Core Help

Standup allows you to run multiple Bitcoin networks simultaneously, which can be useful for development and testing purposes. "Start" a network to sync its blockchain, then "QuickConnect" to generate a QR code for connecting to its Tor hidden services; that code can then be read by a mobile client, such as FullyNoded.

Mainnet is the main network, where you can spend real Bitcoins. Testnet is a test network, where you can connect to other nodes on the testnet3 network for testing purposes. Regtest is meant for developers who want to run a local network so that they can easily mine, add multiple nodes, and do other testing.

"Install" will setup Standup completely or "Update" will update Bitcoin Core to a newer version, if available. "Verify" to check the sha256 hash of the Bitcoin Core binary against what we expect it to be, as per LaanWJ Vlaadmir's PGP signature.

--

TOR HELP:

Tor Help

The Tor pane gives you direct access to the three hidden service directories; just tap the forward button for the network of your choice. This is useful if you want to use your node's onion addresses for other apps. It is also useful if you want to refresh your hidden service, which can be accomplished by deleting the hidden service directory altogether.

Use the "Add" and "Remove" buttons to either add or remove Tor v3 authenticaction keys. You may store up to 330 auth keys for each hidden service. Standup by default adds each auth key to all three hidden services; if you tap "Remove" it will remove auth from all three hidden services, so use it with caution.

The "Start Tor"/"Stop" button allows you to start and stop Tor. If Tor is stopped, your node will not be reachable remotely.

--

GO PRIVATE ON:

Enable Privacy?

This ensures that your node will only accept connections from the Tor network. To be precise: it sets your proxy to the localhost and Tor's control port, binds the localhost address, and sets listen to true in your bitcoin.conf.

Because this can make initial block downloaded very slow, it is recommended that you do not "Go Private" until your node is fully synced.

--

GO PRIVATE OFF:

Disable Privacy?

This will allow your node to connect to other nodes over the clearnet, not just over Tor. It is recommended that you only use this setting when your node is doing the initial block download.

--

OTHER CHANGES:

Make Change?

You are attempting to update X to Y.

This is a global setting and will apply to all networks.

Are you sure you want to proceed?

--

OTHER CHANGES: MADE:

Success

bitcoin.conf updated.

In order for this change to take effect you will need to restart Bitcoin Core. Click "Stop" for each of your networks, then "Start". Or, if you prefer, quit Standup, then when you restart, click "Start" for each of your networks.

--

ADD TOR KEY:

Add Tor Key

Add your Tor V3 auth public key from your Bitcoin client such as FullyNoded or another app here.

This key will be added to each RPC hidden service's "authorized_clients" directory, allowing all services to be authenticated with the same key. Only the authenticated devices or apps will have access to the RPC hidden services.

You may add up to 330 auth keys.

--

STAND DOWN:

Danger!

This will remove the StandUp directory, including all its contents!

This will remove the Tor config, Tor hidden services, and uninstall Tor.

Though your full node will continue running, it will not longer be protected.

Are you sure you want to do this?

--

KILL BITCOIN CORE:

Danger!

This will remove the Bitcoin directory! All Bitcoin Core data including your wallets will be deleted!

If you have not backed up your private keys, you will lose funds!

Are you sure you want to do this?

Fonta1n3 commented 4 years ago

Thanks @shannona I had not seen this until now. Will update for next release.