Skip to content

Commit

Permalink
docs: getting started and bootstrap guide progress
Browse files Browse the repository at this point in the history
  • Loading branch information
Tasos Bitsios committed Jan 8, 2025
1 parent bdefe8b commit 9ba5575
Show file tree
Hide file tree
Showing 10 changed files with 115 additions and 8 deletions.
Binary file added docs/public/assets/nodekit-bootstrap.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/public/assets/nodekit-fast-catchup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/public/assets/nodekit-install.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/public/assets/nodekit-state-fast-catchup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/public/assets/nodekit-state-running.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/public/assets/nodekit-state-syncing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 10 additions & 1 deletion docs/src/content/docs/guides/10-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@ description: Installing nodekit

Welcome to Nodekit, your command-line one-stop-shop for Algorand node running.

Nodekit can help you with:

- Installing and configuring an Algorand node
- Syncing your node with the latest state of the network
- Managing consensus participation keys
- Monitoring your node and the network

To get started with Nodekit, copy-paste this command in your terminal:

```bash
Expand All @@ -13,7 +20,9 @@ curl -fsSL https://nodekit.run/install.sh | bash

This will detect your operating system and download the appropriate nodekit executable to your local directory.

It will then immediately start the bootstrap process to get your Algorand node up and running.
It will then immediately start the bootstrap process to get your Algorand node up and running:

![Screenshot of a typical Nodekit installation process](/assets/nodekit-install.png)

**Did you encounted any errors?** Check out the [Troubleshooting: Getting Started](/troubleshooting/10-getting-started) section.

Expand Down
48 changes: 42 additions & 6 deletions docs/src/content/docs/guides/20-bootstrap.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@ title: Installing and bootstrapping the Algorand node
description: Installing and bootstrapping the Algorand node
---

## How to start
## How to start the process

The bootstrap process is automatically started after following the [nodekit installation instructions](/guides/10-getting-started), but it can also be trigerred manually by running this command:
The bootstrap process is automatically started after following the [nodekit installation instructions](/guides/10-getting-started), but it can also be triggered manually by running this command:

```bash
./nodekit bootstrap
```

## What it does
## Prompts: Installation and Fast-catchup

Nodekit will check to see if there is a node already installed.
Nodekit bootstrap will check to see if there is a node already installed.

If there is none, it will ask if you want to start a node installation:

Expand All @@ -25,10 +25,46 @@ You can respond by pressing the `y` or `n` keys of your keyboard, for `yes` and

---

It will then ask if you want to perform a "fast-catchup" with the network after installation is complete:
It will then ask if you want to perform a "fast-catchup" with the network:

> Regular sync with the network usually takes multiple days to weeks. You can optionally perform fast-catchup to sync in 30-60 minutes instead.
>
> Would you like to preform a fast-catchup after installation? (Y/n)
Fast-catchup saves a lot of time, so we recommend responding `Yes`.
Fast-catchup saves a lot of time, so we recommend responding Yes.

---

Assuming you have responded "yes" to the node install prompt, you will now be prompted for your user password:

```
WARN (You may be prompted for your password)
INFO Installing Algod on Linux
INFO Installing with apt-get
[sudo] password for user:
```

Your operating system requires this to allow Nodekit to install the Algorand node software. Enter your user password and press ENTER to proceed.

## Installation

After you enter your password, you can now sit back and wait until your Algorand node is installed and syncs with the network.

The installation phase should only take a few minutes. Your terminal will look like this during the installation phase:

![Screenshot of first phase of "nodekit bootstrap" process](/assets/nodekit-bootstrap.png)

## Fast catchup

After installation is complete, Nodekit will automatically start the Nodekit user interface.

This will display the progress of catching up to the latest state of the Algorand network:

![Screenshot of second phase of "nodekit bootstrap" process - fast catchup](/assets/nodekit-fast-catchup.png)

This process usually takes between 30-60 minutes, depending on your hardware and network connection.

When the process is done, the Fast Catchup status information will disappear and the yellow `FAST-CATCHUP` status at the top will change to a green `RUNNING` state.

**Did you encounted any errors?** Check out the [Troubleshooting: Installing and bootstrapping the Algorand node](/troubleshooting/20-bootstrap) section.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Getting Started
title: "Troubleshooting: Getting Started"
description: Troubleshooting nodekit installation
---

Expand Down
62 changes: 62 additions & 0 deletions docs/src/content/docs/troubleshooting/20-bootstrap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
title: "Troubleshooting: Installing and bootstrapping the Algorand node"
description: Troubleshooting nodekit bootstrap
---

This section outlines **common errors encountered** during the "bootstrap" node installation process.

**If you are looking for the instructions instead, they are located [here](/guides/20-bootstrap).**

### Asking for password

The installer will ask for your user password during this process. This is required by your operating system in order to install new software.

Enter your operating system user password when you see this prompt:

```
[sudo] password for user:
```

### Fast catchup is taking too long to complete

If the fast catchup process is taking too long to complete, check the following:

#### Status is in FAST-CATCHUP

The colored status at the top of Nodekit should be in a yellow `FAST-CATCHUP` state:

![](/assets/nodekit-state-fast-catchup.png)

After fast-catchup completes successfully, it is normal for a node to be in a `SYNCING` state for a few minutes:

![](/assets/nodekit-state-syncing.png)

During this the `Latest Round` number should be increasing rapidly.

If there is no progress for a while, or the Latest Round value is smaller than `46000000` (46 million) then you should start fast-catchup again:

#### Fast Catchup was interrupted or did not complete

To start the fast catchup process again, exit the Nodekit user interface by pressing `Q` and enter the following command:

```bash
./nodekit catchup
```

You can enter nodekit again by running:

```bash
./nodekit
```

When the syncing process completes, the status will display `RUNNING`:

![](/assets/nodekit-state-running.png)

### Your hardware meets the minimum specs

TODO SSD

### Your network connection meets the minimum specs

TODO

0 comments on commit 9ba5575

Please sign in to comment.