diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 1a4842d8f7..20e2ceadd7 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -1,12 +1,12 @@ # Table of contents * [Introduction](introduction.md) +* [Installing Solana](install-solana.md) * [Using Solana from the Command-line](cli/README.md) * [Command-line Usage](cli/usage.md) * [Remote Wallet](remote-wallet/README.md) * [Ledger Hardware Wallet](remote-wallet/ledger.md) * [Paper Wallet](paper-wallet/README.md) - * [Installation](paper-wallet/installation.md) * [Paper Wallet Usage](paper-wallet/usage.md) * [Offline Signing](offline-signing/README.md) * [Durable Transaction Nonces](offline-signing/durable-nonce.md) @@ -41,7 +41,6 @@ * [Running a Validator](running-validator/README.md) * [Validator Requirements](running-validator/validator-reqs.md) * [Choosing a Testnet](running-validator/validator-testnet.md) - * [Installing the Validator Software](running-validator/validator-software.md) * [Starting a Validator](running-validator/validator-start.md) * [Staking](running-validator/validator-stake.md) * [Monitoring a Validator](running-validator/validator-monitor.md) diff --git a/docs/src/running-validator/validator-software.md b/docs/src/install-solana.md similarity index 98% rename from docs/src/running-validator/validator-software.md rename to docs/src/install-solana.md index a1ed075ac2..694e023e9a 100644 --- a/docs/src/running-validator/validator-software.md +++ b/docs/src/install-solana.md @@ -1,4 +1,4 @@ -# Installing the Validator Software +# Installing Solana Install the Solana release [v1.0.0](https://github.com/solana-labs/solana/releases/tag/v1.0.0) on your diff --git a/docs/src/paper-wallet/installation.md b/docs/src/paper-wallet/installation.md deleted file mode 100644 index 543eb93c78..0000000000 --- a/docs/src/paper-wallet/installation.md +++ /dev/null @@ -1,51 +0,0 @@ -# Installation Guide -Follow this guide to setup Solana's key generation tool called `solana-keygen` - -{% hint style="warn" %} -After installation, ensure your version is `1.0.0` or higher by running `solana-keygen -V` -{% endhint %} - -## Download -First, download the latest release tarball from GitHub. - -1. Setup download url - - ```bash - solana_downloads=https://github.com/solana-labs/solana/releases/latest/download - ``` - -2. Specify the download file based on your machine - - **MacOS** - ```bash - solana_release=solana-release-x86_64-apple-darwin.tar.bz2 - ``` - - **Linux** - ```bash - solana_release=solana-release-x86_64-unknown-linux-gnu.tar.bz2 - ``` - -3. Download - - ```bash - curl -L -sSf -o solana-release.tar.bz2 $solana_downloads/$solana_release - ``` - -## Extract -Next, extract the tarball -```bash -tar xf solana-release.tar.bz2 -``` - -## Add to "PATH" -Now add the tool to your PATH environment variable with the following command -```bash -export PATH="$(pwd)/solana-release/bin:${PATH}" -``` - -## Check -Finally, check that `solana-keygen` can be run by running -```bash -solana-keygen -V -``` diff --git a/docs/src/paper-wallet/usage.md b/docs/src/paper-wallet/usage.md index de45bd689f..03728a301e 100644 --- a/docs/src/paper-wallet/usage.md +++ b/docs/src/paper-wallet/usage.md @@ -10,6 +10,18 @@ written to disk by unencrypted memory swaps. It is the user's responsibility to protect against this scenario. {% endhint %} +## Before You Begin + +- [Install the Solana command-line tools](../install-solana.md) + +### Check your installation + +Check that `solana-keygen` is installed correctly by running: + +```bash +solana-keygen --version +``` + ## Creating a Paper Wallet Using the `solana-keygen` tool, it is possible to generate new seed phrases as diff --git a/docs/src/remote-wallet/ledger.md b/docs/src/remote-wallet/ledger.md index 30e17daf6e..4feea1b2dd 100644 --- a/docs/src/remote-wallet/ledger.md +++ b/docs/src/remote-wallet/ledger.md @@ -6,6 +6,7 @@ secure transaction signing. ## Before You Begin +- [Install the Solana command-line tools](../install-solana.md) - [Initialize your Ledger Nano S](https://support.ledger.com/hc/en-us/articles/360000613793) - [Install the latest device firmware](https://support.ledgerwallet.com/hc/en-us/articles/360002731113-Update-Ledger-Nano-S-firmware) - [Install Ledger Live](https://support.ledger.com/hc/en-us/articles/360006395553/) software on your computer diff --git a/docs/src/running-validator/validator-reqs.md b/docs/src/running-validator/validator-reqs.md index 885cf43a58..f7abc89703 100644 --- a/docs/src/running-validator/validator-reqs.md +++ b/docs/src/running-validator/validator-reqs.md @@ -33,7 +33,7 @@ Here are our recommendations for low, medium, and high end machine specification ## Software * We build and run on Ubuntu 18.04. Some users have had trouble when running on Ubuntu 16.04 -* See [Validator Software](validator-software.md) for the current Solana software release. +* See [Installing Solana](../install-solana.md) for the current Solana software release. Be sure to ensure that the machine used is not behind a residential NAT to avoid NAT traversal issues. A cloud-hosted machine works best. **Ensure that IP ports 8000 through 1.0.2 are not blocked for Internet inbound and outbound traffic.** diff --git a/docs/src/running-validator/validator-testnet.md b/docs/src/running-validator/validator-testnet.md index f645d947ad..e98167c4a3 100644 --- a/docs/src/running-validator/validator-testnet.md +++ b/docs/src/running-validator/validator-testnet.md @@ -24,7 +24,7 @@ stability, all that can be said is that CI automation was successful. ### Get Testnet Version You can submit a JSON-RPC request to see the specific software version of the -cluster. Use this to specify [the software version to install](validator-software.md). +cluster. Use this to specify [the software version to install](../install-solana.md). ```bash curl -X POST -H 'Content-Type: application/json' -d '{"jsonrpc":"2.0","id":1, "method":"getVersion"}' devnet.solana.com:8899