Skip to content

Commit

Permalink
self review
Browse files Browse the repository at this point in the history
  • Loading branch information
Olshansk committed Nov 25, 2024
1 parent 65a825d commit 9fa7461
Show file tree
Hide file tree
Showing 6 changed files with 46 additions and 793 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -103,4 +103,6 @@ job.yaml
tmp/*

# Common testing configurations
relayminer_config.toml
relayminer_config.yaml
gateway_config.yaml
path_config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -88,30 +88,14 @@ sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin

### [Optional] Create a new user

:::note

Make sure to replace `olshansky` with your username.

:::
You can optionally create a new user and give it sudo permissions instead of using `root`.

```bash
# Create a new user and give sudo permissions
export USERNAME=olshansky
sudo adduser $USERNAME
sudo usermod -aG sudo $USERNAME
```

```
# Optionally avoid needing to provide a password
sudo /etc/sudoers
# Add the following line to the end of the file
olshansky ALL=(ALL) NOPASSWD:ALL
# Switch to the new user
su - olshansky
```

## Retrieve the source code

Then pull the github repo
Expand Down Expand Up @@ -349,3 +333,7 @@ docker logs -f --tail 100 appgate
```

### Re-stake the gateway

```
```
39 changes: 38 additions & 1 deletion docusaurus/docs/operate/quickstart/docker_compose_walkthrough.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import ReactPlayer from "react-player";
- [Key Terms in Morse and Shannon](#key-terms-in-morse-and-shannon)
- [Understanding Actors in the Shannon upgrade](#understanding-actors-in-the-shannon-upgrade)
- [Prerequisites](#prerequisites)
- [\[Optional\] Create a new user](#optional-create-a-new-user)
- [A. Deploying a Full Node](#a-deploying-a-full-node)
- [B. Creating a Supplier and Deploying a RelayMiner](#b-creating-a-supplier-and-deploying-a-relayminer)
- [C. Creating an Application and Deploying an AppGate Server](#c-creating-an-application-and-deploying-an-appgate-server)
Expand Down Expand Up @@ -115,7 +116,7 @@ flowchart TB
_Note: the system must be capable of exposing ports to the internet for
peer-to-peer communication._

### 0. Software & Tooling <!-- omit in toc -->
### Software & Tooling <!-- omit in toc -->

Ensure the following software is installed on your system:

Expand Down Expand Up @@ -152,6 +153,42 @@ Update `NODE_HOSTNAME` in `.env` to the IP address or hostname of your node. For
sed -i -e s/NODE_HOSTNAME=/NODE_HOSTNAME=69.42.690.420/g .env
```

### [Optional] Create a new user

:::note

Make sure to replace `olshansky` with your username.

:::

You can generally do everything as the `root` user, but it's recommended to
create a new user and give it sudo permissions.

This is necessary, in particular, if you want to use [homebrew](https://brew.sh/) [to install `poktrolld`](../user_guide/install.md).

```bash
# Create a new user and give sudo permissions
export USERNAME=olshansky
sudo adduser $USERNAME
sudo usermod -aG sudo $USERNAME
```

Then, switch to the new user:

```bash
su - olshansky
```

You can also avoid needing to pass in the password each time by running the following:

```bash
# Optionally avoid needing to provide a password
sudo /etc/sudoers

# Add the following line to the end of the file
olshansky ALL=(ALL) NOPASSWD:ALL
```

## A. Deploying a Full Node

### Launch the Node <!-- omit in toc -->
Expand Down
259 changes: 0 additions & 259 deletions ~/.poktroll/config/app.toml

This file was deleted.

17 changes: 0 additions & 17 deletions ~/.poktroll/config/client.toml

This file was deleted.

Loading

0 comments on commit 9fa7461

Please sign in to comment.