-
Notifications
You must be signed in to change notification settings - Fork 19
update walletd guides #176
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or 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
This file was deleted.
Oops, something went wrong.
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| --- | ||
| layout: | ||
| title: | ||
| visible: true | ||
| description: | ||
| visible: true | ||
| tableOfContents: | ||
| visible: true | ||
| outline: | ||
| visible: true | ||
| pagination: | ||
| visible: true | ||
| --- | ||
|
|
||
| # Linux | ||
|
|
||
| `walletd` can be run as a background service to manage one or more Sia wallets and track their balances on the Sia network. This guide will walk you through the process of installing and configuring `walletd` on a Linux machine. We recommend using a Debian-based distribution, such as Ubuntu or Debian, but `walletd` should work on any modern Linux distribution. The setup guides in these docs are primarily focused on installing using `apt`, but `walletd` can also be installed as a binary manually or run in a Docker container. | ||
|
|
||
| - [Debian](debian.md) | ||
| - [Ubuntu](ubuntu.md) | ||
| - [Other Distros](other.md) |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| --- | ||
| description: Setup a new wallet on Debian | ||
| layout: | ||
| title: | ||
| visible: true | ||
| description: | ||
| visible: true | ||
| tableOfContents: | ||
| visible: true | ||
| outline: | ||
| visible: true | ||
| pagination: | ||
| visible: true | ||
| --- | ||
|
|
||
| # Debian | ||
|
|
||
| This guide will walk you through setting up `walletd` on Linux. At the end of this guide, you should have the following: | ||
|
|
||
| * Installed the `walletd` software | ||
| * Created a `walletd` wallet | ||
|
|
||
| --- | ||
|
|
||
| ## Pre-requisites | ||
|
|
||
| To ensure you will not run into any issues with running `walletd` it is recommended your system meets the following requirements: | ||
|
|
||
| * **Operating System Compatibility:** `walletd` is supported on the following Debian versions: | ||
| - Trixie (Debian 13) | ||
| - Bookworm (Debian 12) | ||
| - Bullseye (Debian 11) | ||
|
|
||
| * **System Updates:** Ensure that Debian is up to date with the latest system updates, these updates can contain important security fixes and improvements. | ||
|
|
||
| * **Hardware Requirements:** A stable setup that meets the following specifications is recommended. | ||
| - A quad-core CPU | ||
| - 8GB of RAM | ||
| - 256 GB SSD for `walletd` | ||
|
|
||
| * **Network Access:** `walletd` interacts with the Sia network, so you need a stable internet connection and open network access to connect to the Sia blockchain. | ||
|
|
||
| ## Install `walletd` Using the `apt` repository | ||
|
|
||
| Before you install `walletd` for the first time on a new machine, you need to set up the Sia `apt` repository. Afterward, you can install and update `walletd` using `apt`. | ||
|
|
||
| {% hint style="warning" %} | ||
| Your system will need to have `curl` installed as well. You can check if it is installed by running `curl --version`. If it is not installed, you can install it by running `sudo apt update && sudo apt install curl` | ||
| {% endhint %} | ||
|
|
||
| **1. Set up the Sia `apt` repository by copying and pasting the following commands into your terminal:** | ||
|
|
||
| ```sh | ||
| sudo curl -fsSL https://linux.sia.tech/debian/gpg | sudo gpg --dearmor -o /usr/share/keyrings/siafoundation.gpg | ||
| sudo chmod 644 /usr/share/keyrings/siafoundation.gpg | ||
| echo "deb [signed-by=/usr/share/keyrings/siafoundation.gpg] https://linux.sia.tech/debian $(. /etc/os-release && echo "$VERSION_CODENAME") main" | sudo tee /etc/apt/sources.list.d/siafoundation.list | ||
| sudo apt update | ||
| ``` | ||
|
|
||
| {% hint style="info" %} | ||
| If you use a derivative distro, such as Kali Linux, you may need to substitute the part of this command that prints the version codename with the corresponding Debian release: | ||
|
|
||
| ```sh | ||
| $(. /etc/os-release && echo "$VERSION_CODENAME") | ||
| ``` | ||
|
|
||
| Replace this part with the codename of the corresponding Debian release, such as bookworm. | ||
| {% endhint %} | ||
|
|
||
| **2. Install `walletd`** | ||
| ```sh | ||
| sudo apt install walletd | ||
| ``` | ||
|
|
||
| **3. Verify `walletd` was installed successfully** | ||
|
|
||
| Run the following command to see the version of `walletd` that was installed: | ||
|
|
||
| ```sh | ||
| walletd version | ||
| ``` | ||
|
|
||
| ## Configure `walletd` | ||
|
|
||
| After installing `walletd`, you will need to set a password to unlock the web interface. There is an interactive configuration process that you can start by running the following command. | ||
|
|
||
| ```sh | ||
| sudo walletd config | ||
| ``` | ||
|
|
||
| This will start an interactive configuration process. You will be asked to verify the data directory, set a password to unlock the web interface, and optionally configure advanced settings such as the index mode. | ||
|
|
||
| {% hint style="info" %} | ||
| `walletd` can manage multiple wallets, so the configuration wizard does not prompt for a seed. You create or import wallets from the web interface after `walletd` is running. | ||
| {% endhint %} | ||
|
|
||
| {% hint style="info" %} | ||
| You will not see anything when you type in your unlock password. Press enter after typing it. | ||
| {% endhint %} | ||
|
|
||
| ## Start `walletd` | ||
|
|
||
| Now that you have installed and configured `walletd`, you can start it by running the following command: | ||
|
|
||
| ```sh | ||
| sudo systemctl enable --now walletd | ||
| ``` | ||
|
|
||
| ## Verify `walletd` has started successfully | ||
|
|
||
| Run the following command to verify the `walletd` service has started successfully: | ||
|
|
||
| ```sh | ||
| sudo systemctl status walletd | ||
| ``` | ||
|
|
||
| ## Updating `walletd` | ||
|
|
||
| New versions of `walletd` are released regularly and contain bug fixes and performance improvements. | ||
|
|
||
| **To update:** | ||
|
|
||
| 1. Stop the `walletd` service. | ||
| ```sh | ||
| sudo systemctl stop walletd | ||
| ``` | ||
|
|
||
| 2. Upgrade `walletd` using the `apt` package manager. | ||
| ```sh | ||
| sudo apt update | ||
| sudo apt upgrade walletd | ||
| ``` | ||
|
|
||
| 3. Start `walletd` service. | ||
| ```sh | ||
| sudo systemctl start walletd | ||
| ``` | ||
|
|
||
| ## Next Steps | ||
|
|
||
| Now that you have `walletd` installed and running, you can start using it to manage your wallets on the Sia network. You can access the web interface by navigating to [http://127.0.0.1:9980](http://127.0.0.1:9980) in your web browser. If you installed `walletd` on a remote machine or a server, you will need to create an SSH tunnel to access the web interface. | ||
|
|
||
|  | ||
|
|
||
| - [Your Sia Wallet](../../wallet-overview.md) | ||
| - [Transferring Siacoins](../../transferring-siacoins.md) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.