diff --git a/docs/learn/the-network.md b/docs/learn/the-network.md index 0e005d26f..7af4dc948 100644 --- a/docs/learn/the-network.md +++ b/docs/learn/the-network.md @@ -243,7 +243,7 @@ The repository contains the source code for the implementation of the Fleek Netw ### Directory structure -There are three top-level directories, namely `lib` , `core` and `services`. +There are three top-level directories, namely `lib`, `core` and `services`. Lib - These are open-source libraries created to help tackle the project features and packaged with a friendly license in the Rust ecosystem (MIT, Apache). diff --git a/docs/node/analyzing-logs.md b/docs/node/analyzing-logs.md index 4d4cdaef1..8725ff345 100644 --- a/docs/node/analyzing-logs.md +++ b/docs/node/analyzing-logs.md @@ -27,7 +27,7 @@ Standard out and standard error are two data streams created when we launch the By convention, most of the log files create on Linux are found under the directory `/var/log/`, a standard area where system messages are logged and recorded. ::: -Because normal output and error messages have their own channel, they can be handled independently of one another. Thus, we keep this in separate files that aggregate the output messages emited by the Lightning process. +Because normal output and error messages have their own channel, they can be handled independently of one another. Thus, we keep this in separate files that aggregate the output messages emitted by the Lightning process. ## Watch logs diff --git a/docs/node/install.md b/docs/node/install.md index 64f9f8ece..b6b939791 100644 --- a/docs/node/install.md +++ b/docs/node/install.md @@ -34,7 +34,7 @@ If you'd like to participate in the [alpha Testnet](/docs/roadmap), you have to The assisted installer is a script written in [Bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell)) (Unix shell) that is available as a curl command line. -### Prerequesites +### Prerequisites - A basic knowledge of command line interface (CLI) - A [supported](/docs/node/requirements#server) Linux server @@ -283,7 +283,7 @@ Install the build-essentials packages, necessary for compiling general software sudo apt-get install build-essential ``` -Followed by the required tools to compile the application ([cmake](https://cmake.org/), [clang](https://clang.llvm.org/), [pkg-config](https://www.freedesktop.org/wiki/Software/pkg-config/) and [libssl-dev ](https://packages.debian.org/sid/libssl-dev)). +Followed by the required tools to compile the application ([cmake](https://cmake.org/), [clang](https://clang.llvm.org/), [pkg-config](https://www.freedesktop.org/wiki/Software/pkg-config/) and [libssl-dev](https://packages.debian.org/sid/libssl-dev)). ```sh sudo apt-get install cmake clang pkg-config libssl-dev gcc-multilib @@ -366,7 +366,7 @@ cargo +stable build --release The installation process is long, as it compiles the application binary for us from the source code. -🌈 Here's the output when successful! Note, that the output might differ slightly from time of writting. +🌈 Here's the output when successful! Note, that the output might differ slightly from time of writing. ```sh Finished release [optimized] target(s) in 11m 22s @@ -573,7 +573,7 @@ sudo docker run \ ``` :::tip -The command has a list of ports `-p` values that map ports in the container on the Docker host. While we try to keep the information accross our documentation in sync with latest changes or requirements e.g. port number changes, make sure that you check the section [ports](/docs/node/requirements#ports) to find the latest updates. +The command has a list of ports `-p` values that map ports in the container on the Docker host. While we try to keep the information across our documentation in sync with latest changes or requirements e.g. port number changes, make sure that you check the section [ports](/docs/node/requirements#ports) to find the latest updates. ::: ### Build from source @@ -595,7 +595,7 @@ sudo docker build -t lightning -f ./Dockerfile . ``` :::tip -Take note of the Docker image name `lightning`, as that's the name we'll use and pass to the `Docker run` to be succesfull. You can name it differently if that's your preference. +Take note of the Docker image name `lightning`, as that's the name we'll use and pass to the `Docker run` to be successful. You can name it differently if that's your preference. ::: Once the image is built, you can launch the Docker Container with a `--name` such as `lightning-node` from the `lightning` image we just created by running: @@ -614,7 +614,7 @@ sudo docker run \ ``` :::tip -The command has a list of ports `-p` values that map ports in the container on the Docker host. While we try to keep the information accross our documentation in sync with latest changes or requirements e.g. port number changes, make sure that you check the section [ports](/docs/node/requirements#ports) to find the latest updates. +The command has a list of ports `-p` values that map ports in the container on the Docker host. While we try to keep the information across our documentation in sync with latest changes or requirements e.g. port number changes, make sure that you check the section [ports](/docs/node/requirements#ports) to find the latest updates. ::: If a `~/.lightning` directory or `~/.lightning/keystore` doesn't exist, one is created for you on `docker run`. You'll need to have the directory populated with the `config.toml` and `keystore` if you want to use a particular identity. Learn more about managing the keystore [here](/guides/Node%20Operators/managing-the-keystore). diff --git a/guides/Node Operators/getting-started-guide.md b/guides/Node Operators/getting-started-guide.md index 5a008e75e..cbefde4ab 100644 --- a/guides/Node Operators/getting-started-guide.md +++ b/guides/Node Operators/getting-started-guide.md @@ -146,7 +146,7 @@ The build command uses the Rust compiler, which might take a while depending on Once the Rust compiler completes, the generated binary will be available in the source code project directory. If you stick with the default, that'll look like `~/fleek-network/lightning/target/debug/lightning-node`. -To avoid having to specify the pathname everytime, create a symbolic link to keep it short. Here we'll name the process as the global `lgtn`: +To avoid having to specify the pathname every time, create a symbolic link to keep it short. Here we'll name the process as the global `lgtn`: ```sh sudo ln -s "~/fleek-network/lightning/target/debug/lightning-node" /usr/local/bin/lgtn @@ -257,4 +257,4 @@ Discover more about the project by [watching/contributing on GitHub](https://git image="https://github.com/heldrida.png" title="Software Developer + DX" url="https://github.com/heldrida" -/> \ No newline at end of file +/> diff --git a/guides/Node Operators/managing-the-keystore.md b/guides/Node Operators/managing-the-keystore.md index a76090abf..2a90d25f0 100644 --- a/guides/Node Operators/managing-the-keystore.md +++ b/guides/Node Operators/managing-the-keystore.md @@ -28,7 +28,7 @@ At time of writing the rewards mechanism hasn't yet been introduced, read the [t We'll use the term identity to describe the key store declared in the configuration, in our case [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) files. The content of the PEM files and the file itself should be kept secret. -The key store is in the file system and the location is defined in the Fleek Network `~/.lightning/config.toml`, as a private key stored in an identity named PEM file (by default `consensus.pem` and `node.pem`). It's essential to understand this, as you may want to copy the identity to a new server setup, to persist the identity accross to the new server setup. +The key store is in the file system and the location is defined in the Fleek Network `~/.lightning/config.toml`, as a private key stored in an identity named PEM file (by default `consensus.pem` and `node.pem`). It's essential to understand this, as you may want to copy the identity to a new server setup, to persist the identity across to the new server setup. :::caution Security is achieved by issuing users private cryptographic keys. Only the holder of the private key has access to sensitive information, such as an identity, which relates to reputation, rewards, etc. The security of the private key is the responsibility of the user. Unfortunately, Fleek Network is unable to help you regain access to your private key if you've lost or failed to secure it. The private keys are your responsibility. @@ -270,7 +270,7 @@ To verify which keys are loaded by the Lightning CLI run the command: lgtn keys show ``` -You'd find the public keys in the output, which can be used for comparision and should be different everytime the configuration changes and reloaded. Here's an example of the output: +You'd find the public keys in the output, which can be used for comparison and should be different every time the configuration changes and reloaded. Here's an example of the output: ```sh Node Public Key: RwPpr35H5AAfWwSDFxwYuJv5TA8PWUd2pdBg+UKsORc= @@ -314,7 +314,7 @@ unzip keystore.zip.enc -d $HOME/.lightning/keystore ``` :::tip -We provide the unzip destiny target to the flag `-d`. The unzip process outputs the files onto the desired location `$HOME/.lightning/keystore`, thus overriding any contents. If you have any files in the destiny target directory it'll be overriden, effectively replacing with the output of the unzipped directory content, so make sure you backup any files as required. +We provide the unzip destiny target to the flag `-d`. The unzip process outputs the files onto the desired location `$HOME/.lightning/keystore`, thus overriding any contents. If you have any files in the destiny target directory it'll be overridden, effectively replacing with the output of the unzipped directory content, so make sure you backup any files as required. ::: ### Higher security @@ -329,7 +329,7 @@ tar -cf "keystore.tar" $HOME/.lightning/keystore The `keystore.tar` should be in the current work directory. -Use `gpg` with the [symmetric option](https://www.gnupg.org/gph/en/manual/x110.html), it creates the keys for that file and request a password to protect them. If you are familiar with assymetric `gpg`, it's similar but it's not signed with your public key or such. +Use `gpg` with the [symmetric option](https://www.gnupg.org/gph/en/manual/x110.html), it creates the keys for that file and request a password to protect them. If you are familiar with asymmetric `gpg`, it's similar but it's not signed with your public key or such. The encryption command is: @@ -409,7 +409,7 @@ For instance, we can imagine a scenario where our service is started with the co lgtn -c /home/lgtn/.lightning/config.toml run ``` -Where the `keystore` is placed under the parent directory `/home/lgtn/.lightning/`. Resulting in the configuration file have the following settings for the hypotetical username `lgtn`: +Where the `keystore` is placed under the parent directory `/home/lgtn/.lightning/`. Resulting in the configuration file have the following settings for the hypothetical username `lgtn`: ```sh [signer] @@ -427,7 +427,7 @@ We've walked through most basics of where the configuration file is located, the Additionally, a brief guide on the [identity](#identity), more specifically an introduction to the [type of keys](#type-of-keys) and [key privacy](#key-privacy), which we find important to understand for anyone seriously interested in running a node by hinting into some system administration and security principles. -Separatily, at risk of oversimpliying provided an brief introduction into the backup of the keystore directory. +Separately, at risk of oversimplifying provided a brief introduction into the backup of the keystore directory. In the future, we'll introduce more advanced topics that will help you improve the knowledge you get from this, but we are glad that you followed this guide and got some comprehension to help you manage the key store. @@ -440,4 +440,4 @@ Discover more about the project by [watching/contributing on Github](https://git image="https://github.com/heldrida.png" title="Software Developer + DX" url="https://github.com/heldrida" -/> \ No newline at end of file +/> diff --git a/guides/Node Operators/running-a-node-in-docker.md b/guides/Node Operators/running-a-node-in-docker.md index 7160d4b71..29b605375 100644 --- a/guides/Node Operators/running-a-node-in-docker.md +++ b/guides/Node Operators/running-a-node-in-docker.md @@ -68,7 +68,7 @@ The Docker image is tied to a CPU architecture, make sure that you have verified ::: :::tip -The command has a list of ports `-p` values that map ports in the container on the Docker host. While we try to keep the information accross our documentation in sync with latest changes or requirements e.g. port number changes, make sure that you check the section [ports](/docs/node/requirements#ports) to find the latest updates. +The command has a list of ports `-p` values that map ports in the container on the Docker host. While we try to keep the information across our documentation in sync with latest changes or requirements e.g. port number changes, make sure that you check the section [ports](/docs/node/requirements#ports) to find the latest updates. ::: ## Setup @@ -271,11 +271,11 @@ The output should be similar to: ``` :::tip -The Docker image is only required to be built once and/or, when changes are pulled from the remote repository, or specific versions you might be interested in. Otherwise, you're not required to build it everytime to run the node. If you'd like to learn how to update the Lightning CLI, find our references [here](/references/Lightning%20CLI/update-cli-from-source-code). +The Docker image is only required to be built once and/or, when changes are pulled from the remote repository, or specific versions you might be interested in. Otherwise, you're not required to build it every time to run the node. If you'd like to learn how to update the Lightning CLI, find our references [here](/references/Lightning%20CLI/update-cli-from-source-code). ::: :::caution -If you don't update your source code and binary build often, you won't have the latest changes, which should happen frequently to take advandate of all the ongoing development. This is quite important to understand, as it causes confusion to some users. The Lightning application at time of writing does not update automatically. +If you don't update your source code and binary build often, you won't have the latest changes, which should happen frequently to take advantage of all the ongoing development. This is quite important to understand, as it causes confusion to some users. The Lightning application at time of writing does not update automatically. ::: ## Docker Container @@ -284,7 +284,7 @@ A container is what's originated from the image we discussed in the section [bui Following up, we'll learn how to run the Docker container that includes our Lightning CLI program, built from our Dockerfile. -Once the [Docker image](#build-the-docker-image) is ready, run the container based on the image `lightning`. Effectively running the Fleek Network Lighthing node process: +Once the [Docker image](#build-the-docker-image) is ready, run the container based on the image `lightning`. Effectively running the Fleek Network Lightning node process: ```sh sudo docker run \ @@ -338,7 +338,7 @@ keystore You only have to run the `keys generate` once from your host. -Finaly, you can start the Fleek Network node by running the command: +Finally, you can start the Fleek Network node by running the command: ```sh sudo docker start lightning-cli @@ -413,7 +413,7 @@ To view the logs of a Docker container in real time, use the following command: sudo docker logs -f lightning-cli ``` -If you have wraped the [docker container as a systemd service](#run-the-docker-container-as-systemd-service), you can use the same commands found when installed natively, such as: +If you have wrapped the [docker container as a systemd service](#run-the-docker-container-as-systemd-service), you can use the same commands found when installed natively, such as: For standard output: @@ -435,7 +435,7 @@ Containers are a way to have a self-contained environment that includes all nece Fleek Network's Lightning is developed with [Rust](https://www.rust-lang.org/), a general-purpose programming language, that requires several dependencies and libraries to compile the project. Some of these libraries are not installed by default and require some troubleshooting for the end user. [Docker](https://www.docker.com/) provides us with containers, self-containing all the required libraries for the purpose of running Lightning, our application. -We guided you through the initial installation steps, and how to build a [Docker](https://www.docker.com/) image, which then's used to Docker run a container. Plus, provided lower-level commands, to help you understand other present or advanced use-cases, and also at higher level, offerring simple utility methods. +We guided you through the initial installation steps, and how to build a [Docker](https://www.docker.com/) image, which then's used to Docker run a container. Plus, provided lower-level commands, to help you understand other present or advanced use-cases, and also at higher level, offering simple utility methods. While we do our best to provide the clearest instructions, there's always space for improvement, therefore feel free to make any contributions by messaging us on our [Discord](https://discord.gg/fleekxyz) or by opening a [PR](https://github.com/fleek-network) in any of our repositories. @@ -446,4 +446,4 @@ Discover more about the project by [watching/contributing on Github](https://git image="https://github.com/heldrida.png" title="Software Developer + DX" url="https://github.com/heldrida" -/> \ No newline at end of file +/> diff --git a/guides/Node Operators/transfering-setup-ownership.md b/guides/Node Operators/transfering-setup-ownership.md index ff6692225..393677237 100644 --- a/guides/Node Operators/transfering-setup-ownership.md +++ b/guides/Node Operators/transfering-setup-ownership.md @@ -36,7 +36,7 @@ To use the automated script execute the following command in your server termina curl -sS https://get.fleek.network/transfer_system_user_setup_ownership | bash ``` -We try to make the auomated scripts as useful as possible, but it's impossible to fit every single use-case. So, if you find any isses or have feedback to help us improve [message us through our Discord](https://discord.gg/fleekxyz). +We try to make the automated scripts as useful as possible, but it's impossible to fit every single use-case. So, if you find any issues or have feedback to help us improve [message us through our Discord](https://discord.gg/fleekxyz). ::: ## Introduction @@ -161,7 +161,7 @@ drwxrwxr-x 3 root root 4096 Sep 11 12:28 fleek-network ## Change ownership of files -Once the directories and files are moved, they should have have the wrong ownership, which should be set to **root:root**. We'll now have to change the ownership of the directories and files recursively. +Once the directories and files are moved, they should have the wrong ownership, which should be set to **root:root**. We'll now have to change the ownership of the directories and files recursively. Change the ownership of `/home/lgtn/.lightning` to the user **lgtn** as follows: @@ -316,13 +316,13 @@ sudo systemctl daemon-reload Open the `/home/lgtn/.lightning/config.toml` file in your favorite text editor. -Replace every instance of `~` (tilde) with the user's home path. We do this to ensure that every time we control the service via systemctl, the configuration file that tells which keystore to use is declared upfront regardless of running it as user or delegating to root with **sudo**. Learn more about [file permissions and ownership](/references/Lightning%20CLI/file-permissions-and-ownership) by reading the reference document. +Replace every instance of `~` (tilde) with the user's home path. We do this to ensure that every time we control the service via systemctl, the configuration file that tells which keystore to use is declared upfront regardless of running it as a user or delegating to root with **sudo**. Learn more about [file permissions and ownership](/references/Lightning%20CLI/file-permissions-and-ownership) by reading the reference document. ## Start the service -At this stage, you should have migrated the essential files to the user home. +At this stage, you should have migrated the essential files to the user home. Ideally, you would now manage the service as the `user` (as described in the [user service reference](/references/Systemd/user-service/)). To keep our guide wider to all users, we'll prefix the commands with **sudo**, which elevates the permissions to **root**. But since we have provided the configuration file the `-c` in our [systemd service](#systemd-service), we'll have the user-preferred configuration options ruling. @@ -354,4 +354,4 @@ Discover more about the project by [watching/contributing on GitHub](https://git image="https://github.com/heldrida.png" title="Software Developer + DX" url="https://github.com/heldrida" -/> \ No newline at end of file +/> diff --git a/guides/Node Operators/update-lightning.md b/guides/Node Operators/update-lightning.md index 0a5e1230e..eda891a31 100644 --- a/guides/Node Operators/update-lightning.md +++ b/guides/Node Operators/update-lightning.md @@ -82,7 +82,7 @@ Make sure that you are checked in to the correct branch. For example, if that'd git checkout ``` -Here's an example of how the comman would look like for the main default branch with corresponding name `main`. +Here's an example of how the command would look like for the main default branch with corresponding name `main`. ```sh git checkout main @@ -90,7 +90,7 @@ git checkout main -Here's an example of how the comman would look like for the branch name `testnet-alpha-0`. +Here's an example of how the command would look like for the branch name `testnet-alpha-0`. ```sh git checkout testnet-alpha-0 @@ -213,7 +213,7 @@ If you have stick with the default recommendation, that'll be at `~/fleek-networ ## Checkup the symlink setup -During the original install and setup process, a symbolic link (symlink) was created linking the generated binary file located in `~/fleek-network/lightning/target/release/lightning-node` to `/usr/local/bin/lgtn`. By placing the symlink in the the default installation location of the user, the executable application is available globally as `lgtn`. +During the original install and setup process, a symbolic link (symlink) was created linking the generated binary file located in `~/fleek-network/lightning/target/release/lightning-node` to `/usr/local/bin/lgtn`. By placing the symlink in the default installation location of the user, the executable application is available globally as `lgtn`. You can see the full absolute path of the symlink and verify if setup correctly by running: @@ -280,7 +280,7 @@ Environment=TMPDIR=/var/tmp WantedBy=multi-user.target ``` -Everytime the file is modified, the Systemd process should be reloaded. You can do this by executing: +Every time the file is modified, the Systemd process should be reloaded. You can do this by executing: ```sh sudo systemctl daemon-reload @@ -304,7 +304,7 @@ To learn more about how to use Systemctl to manage the Lightning service, read t First, complete all the steps and checkups mentioned throught the guide and once the Node process is running perform a health check. -To run a quick health checkup, send a GET request to `/health` endpoing of the RPC on [port](/docs/node/requirements#ports) 4069. +To run a quick health checkup, send a GET request to `/health` endpoint of the RPC on [port](/docs/node/requirements#ports) 4069. ```sh curl -w "\p" localhost:4069/health @@ -335,4 +335,4 @@ Discover more about the project by [watching/contributing on GitHub](https://git image="https://github.com/heldrida.png" title="Software Developer + DX" url="https://github.com/heldrida" -/> \ No newline at end of file +/> diff --git a/references/Lightning CLI/permission-denied-os-error-13.md b/references/Lightning CLI/permission-denied-os-error-13.md index dfbc94290..034ecf7f2 100644 --- a/references/Lightning CLI/permission-denied-os-error-13.md +++ b/references/Lightning CLI/permission-denied-os-error-13.md @@ -13,7 +13,7 @@ import Author from '@site/src/components/Author'; When running the Lightning CLI, the user who's in control can delegate to **root** via **sudo**. Depending on how the Fleek Networking Lightning CLI was installed, this might cause some confusion, which is better explained by reading the reference [Keys not found](/references/Lightning%20CLI/keys-not-found), which illustrates a situation where a user gets an error message about the wrong location of a system path (keystore). Some of the reasons why the `Permission denied (os error 13)` might occur are related to: -- The Fleek Network Lightning CLI process trying to write to a `.lightning` stored in a non permited location +- The Fleek Network Lightning CLI process trying to write to a `.lightning` stored in a non permitted location - The Fleek Network Lightning CLI process trying to write to `/tmp` The most common issue can be fixed by reading the section [Override the TMPDIR](#override-the-tmpdir). @@ -79,4 +79,4 @@ The `/etc/systemd/system/lightning.service` service unit file presented here is image="https://github.com/heldrida.png" title="Software Developer + DX" url="https://github.com/heldrida" -/> \ No newline at end of file +/>