-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #20 from AIBlockOfficial/banner_update
Add graphics banners to documentation pages
- Loading branch information
Showing
22 changed files
with
184 additions
and
20 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 |
---|---|---|
@@ -0,0 +1,72 @@ | ||
--- | ||
title: Installing a Lite Node | ||
description: How to install a lite node | ||
sidebar_label: Installing a Lite Node | ||
sidebar_position: 0 | ||
hide_title: false | ||
tags: | ||
- node | ||
- lite node | ||
- installation | ||
--- | ||
|
||
Lite nodes are the same as mining nodes within the AIBlock system, except that they perform no mining activities. They can also be installed in one of two ways: | ||
|
||
1. Docker container | ||
2. Built from source | ||
|
||
The Docker container is still currently being built, so for now you'll need to build from source in order to start a lite node. | ||
|
||
## Build from Source | ||
|
||
To build a lite node from source, you can implement the following steps: | ||
|
||
### Setup | ||
|
||
The AIBlock Network runs on Rust, so installing this is the first step before dealing with any code. You can install `rustup`, Rust's toolchain installer, by running the following: | ||
|
||
``` | ||
curl https://sh.rustup.rs -sSf | sh | ||
``` | ||
|
||
When asked how to proceed, simply selecting the option `1) Proceed with installation` is generally the best. You can then run the following to update the `PATH` variable and check whether everything installed correctly: | ||
|
||
``` | ||
source $HOME/.cargo/env | ||
rustc --version | ||
``` | ||
|
||
If the terminal responds with the `rustc` version you're currently running then everything went well, and you're ready to go. | ||
|
||
### Linux | ||
|
||
Linux (Ubuntu 20.04.01 LTS) may require extra package installations depending on what you've developed before. The following package installs assume a completely new machine instance, and should cover everything you need to get going: | ||
|
||
``` | ||
sudo apt install build-essential | ||
sudo apt-get install m4 | ||
sudo apt-get install llvm | ||
sudo apt-get install libclang-dev | ||
``` | ||
|
||
The above should enable you to install `librocksdb-sys` successfully, but older versions of this crate had bugs so it would be wise to ensure you've installed `rocksdb = "0.21.0"` or higher in order to avoid compilation issues. | ||
|
||
### Lite Node Build | ||
|
||
With the prerequisites set up, you can now clone the repo to your local machine: | ||
|
||
``` | ||
git clone [email protected]:AIBlockOfficial/Network.git | ||
``` | ||
|
||
You can then build everything by running | ||
|
||
```rust | ||
cargo build --release | ||
``` | ||
|
||
This will compile everything into a release state, from which you can then run the following to connect to the Playground testnet to mine: | ||
|
||
``` | ||
RUST_LOG=warp target/release/node user --config=src/bin/node_settings_playground.toml --api_use_tls=0` | ||
``` |
4 changes: 2 additions & 2 deletions
4
docs/mining/installing-a-node.mdx → docs/mining/installing-a-mining-node.mdx
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
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
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
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 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 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
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
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
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
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
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
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
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
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
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 |
---|---|---|
@@ -0,0 +1,63 @@ | ||
{ | ||
"id": "442a513c-b5ef-4372-aa6e-4f12311eb386", | ||
"name": "MAINNET", | ||
"values": [ | ||
{ | ||
"key": "mempool_api_endpoint", | ||
"value": "mempool.aiblock.ch", | ||
"type": "default", | ||
"enabled": true | ||
}, | ||
{ | ||
"key": "mempool_api_port", | ||
"value": "443", | ||
"type": "default", | ||
"enabled": true | ||
}, | ||
{ | ||
"key": "storage_api_endpoint", | ||
"value": "storage.aiblock.ch", | ||
"type": "default", | ||
"enabled": true | ||
}, | ||
{ | ||
"key": "storage_api_port", | ||
"value": "443", | ||
"type": "default", | ||
"enabled": true | ||
}, | ||
{ | ||
"key": "miner_api_endpoint", | ||
"value": "aiblock.ch", | ||
"type": "default", | ||
"enabled": true | ||
}, | ||
{ | ||
"key": "miner_api_port", | ||
"value": "3000", | ||
"type": "default", | ||
"enabled": true | ||
}, | ||
{ | ||
"key": "protocol", | ||
"value": "https", | ||
"type": "default", | ||
"enabled": true | ||
}, | ||
{ | ||
"key": "listing_id", | ||
"value": "", | ||
"type": "default", | ||
"enabled": true | ||
}, | ||
{ | ||
"key": "REQ_UUID", | ||
"value": "", | ||
"type": "any", | ||
"enabled": true | ||
} | ||
], | ||
"_postman_variable_scope": "environment", | ||
"_postman_exported_at": "2024-04-08T09:46:20.221Z", | ||
"_postman_exported_using": "Postman/10.24.17" | ||
} |
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.