Skip to content

Commit

Permalink
remove mentions of shimmer and hornet
Browse files Browse the repository at this point in the history
general style edits
  • Loading branch information
lucas-tortora committed May 8, 2024
1 parent 9834b8d commit deae748
Show file tree
Hide file tree
Showing 7 changed files with 305 additions and 97 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,27 +14,20 @@ tags:

# Getting Started


Running a node is an efficient way to use IOTA or Shimmer. By doing so, you have direct access to the Tangle instead of having to
connect to and trust someone else's node. Additionally, you help the network to become more distributed and resilient.

The node software is the backbone of the network. For an overview of tasks a node is responsible for, please
see our [Node 101](/develop/nodes/explanations/nodes_101/) section.

To make sure that your device meets the minimum security requirements for running a node, please
see our [Security 101](/develop/nodes/explanations/security_101/) section.
Running a node is an efficient way to use IOTA. By doing so, you have direct access to the Tangle instead of connecting
to and trusting someone else's node. Additionally, you help the network to become more distributed and resilient.

## Recommended Requirements

To handle a potential high rate of blocks per second, nodes need enough computational power to run reliably, and
should have the minimum specs:
To handle a potentially high rate of blocks per second, nodes need enough computational power to run reliably and
should have the following minimum specs:

- 4 cores or 4 vCPU.
- 8 GB RAM.
- SSD storage.
- A public IP address.

The amount of storage you need will depend on whether and how often you plan on _pruning_ old data from your local
The amount of storage you will need will depend on whether and how often you plan on _pruning_ old data from your local
database.

The IOTA-Core exposes different functionality on different ports:
Expand All @@ -43,14 +36,15 @@ The IOTA-Core exposes different functionality on different ports:
- `14626 UDP` - Autopeering port (optional).
- `14265 TCP` - REST HTTP API port (optional).

These ports are important for flawless node operation. The REST HTTP API port is optional and is only needed if
you want to offer access to your node's API. All ports can be customized inside
These ports are essential for flawless node operation. The REST HTTP API port is optional and is only needed if
you want to offer access to your node's API. You can customize all ports using
the [`config.json`](../how_tos/post_installation.md) file.

## Operating System

The IOTA-Core is written in Go and can be deployed on all major platforms.
The [recommended setup](../how_tos/using_docker.md) uses Docker to run the IOTA-Core together with some [INX](../inx-plugins) extensions secured behind a [Traefik](https://traefik.io) SSL reverse proxy.
The [recommended setup](../how_tos/using_docker.md) uses Docker to run the IOTA-Core together with some INX extensions
secured behind a [Traefik](https://traefik.io) SSL reverse proxy.

## Configuration

Expand Down
6 changes: 3 additions & 3 deletions docs/maintain/iota-core/2.0/docs/how_tos/post_installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The most important configuration files are:

There are default configuration files available that you can use:

- `config_testnet.json` - Includes the default values required to join the Shimmer Testnet.
- `config_testnet.json` - Includes the default values required to join the Testnet.
- `config_defaults.json` - Includes all default parameters used by the IOTA-core. You can use this file as a reference when customizing your `config.json`

You can pick one of these files and use it as your `config.json` to join the configured network.
Expand All @@ -52,7 +52,7 @@ Since offering the HTTP REST API to the public can consume your node's resources
To generate a JWT-token to be used with the protected routes you can run:

```sh
./hornet tool jwt-api --databasePath <path to your p2pstore> --salt <restAPI.jwtAuth.salt value from your config.json>
./iota-core tool jwt-api --databasePath <path to your p2pstore> --salt <restAPI.jwtAuth.salt value from your config.json>
```

If you are running our [recommended setup](using_docker.md) then see [here](using_docker.md#tools).
Expand All @@ -72,7 +72,7 @@ When using our [recommended setup](using_docker.md) this is done for you automat

You can find all the HTTP REST API related options in the [`config.json` reference](../references/configuration.md#restapi)

## Update to 2.x.x
## Update

You can update the IOTA-core to the latest stable version with no breaking updates by running the following command:

Expand Down
37 changes: 18 additions & 19 deletions docs/maintain/iota-core/2.0/docs/how_tos/using_docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,7 @@ import LinuxCommands from '@site/docs/_admonitions/_linux-commands.md';

# Install the IOTA-core using Docker


This guide represents the recommended setup to run an IOTA-core node.
This article guides the recommended setup to run an IOTA-core node.
It includes everything required to set up a public node accessible by wallets and applications:

- [IOTA-core](https://github.com/iotaledger/iota-core)
Expand All @@ -36,7 +35,7 @@ It includes everything required to set up a public node accessible by wallets an
1. A recent release of Docker enterprise or community edition. Avoid using the Docker version shipped with your OS since these are mostly out of date. You can find installation instructions in the [official Docker documentation](https://docs.docker.com/engine/install/).
2. [Docker Compose CLI plugin](https://docs.docker.com/compose/install/linux/).
3. A registered domain name pointing to the public IP address of your server. _(optional if not using HTTPS)_
4. Opening up the following ports in your servers firewall:
4. Opening up the following ports in your server's firewall:

- `15600 TCP` - Used for the IOTA-Core gossip.
- `14626 UDP` - Used for the IOTA-Core autopeering.
Expand Down Expand Up @@ -69,7 +68,7 @@ mkdir node-docker-setup && cd node-docker-setup && curl -L https://node-docker-s

### 1. Generate dashboard credentials

To access your IOTA-Core dashboard, a set of credentials need to be configured.
To access your IOTA-Core dashboard, you need to configure credentials.
Run the following command to generate a password hash and salt for the dashboard:

```sh
Expand All @@ -94,7 +93,7 @@ nano .env
```

Follow the instructions provided in the file.
With `nano` you can save your changes and exit the editor using `CTRL+O` and `CTRL+X`.
With `nano`, you can save your changes and exit the editor using `CTRL+O` and `CTRL+X`.

:::note

Expand All @@ -118,7 +117,7 @@ Add your IOTA-Core neighbor addresses to the `peering.json` file.

:::note

This step is recommended, but optional if you are using autopeering.
This step is recommended but optional if you are using autopeering.
See [peering](../references/peering.md) for more information.

:::
Expand All @@ -127,7 +126,7 @@ See [peering](../references/peering.md) for more information.

All files used by the IOTA-Core, the INX extensions, Traefik & co will be stored in a directory called `data`.
Docker image runs under user with user id `65532` and group id `65532`, so this directory needs to have the correct permissions to be accessed by the containers.
To create this directory with correct permissions run the contained script:
To create this directory with correct permissions, run the contained script:

```sh
./prepare_docker.sh
Expand All @@ -147,33 +146,33 @@ docker compose up -d

#### HTTPS

After starting the node you will be able to access your services at the following endpoints:
After starting the node, you will be able to access your services at the following endpoints:

- API: `https://node.your-domain.com/api/routes`
- IOTA-Core Dashboard: `https://node.your-domain.com/dashboard`
- Grafana: `https://node.your-domain.com/grafana` _(optional if using "monitoring" profile)_

:::warning

After starting your node for the first time, please change the default grafana credentials
User: `admin`
Password: `admin`
After starting your node for the first time, please change the default grafana credentials.
**User**: `admin`
**Password**: `admin`

:::

You can configure your wallet software to use `https://node.your-domain.com`.

#### HTTP

After starting the node you will be able to access your services at the following endpoints:
After starting the node, you will be able to access your services at the following endpoints:

- API: `http://localhost/api/routes`
- IOTA-Core Dashboard: `http://localhost/dashboard`
- Grafana: `http://localhost/grafana` _(optional if using "monitoring" profile)_

:::note

If you changed the default `HTTP_PORT` value, you will need to add the port to the urls.
If you changed the default `HTTP_PORT` value, you must add the port to the URLs.

:::

Expand All @@ -200,33 +199,33 @@ docker compose down

### Tools

To access the tools provided inside IOTA-Core you can use:
To access the IOTA-Core tools, you can use the following command:

```sh
docker compose run iota-core tool <tool-name>
```

To see the list of tools included run:
To see the list of tools included run the following:

```sh
docker compose run iota-core tool -h
```

## JWT Auth

To generate a JWT token to be used to access protected routes you can run:
To generate a JWT token to be used to access protected routes, you can run the following:

```sh
docker compose run iota-core tool jwt-api --databasePath data/p2pstore
```

- If you changed the `restAPI.jwtAuth.salt` value in the `config.json`, then you need to pass that value as a parameter as `--salt <restAPI.jwtAuth.salt value from your config.json>`
- If you changed the `restAPI.jwtAuth.salt` value in the `config.json`, then you need to pass that value as a parameter as `--salt <restAPI.jwtAuth.salt value from your config.json>`.

## INX

This setup includes the INX extensions listed at the beginning of this guide.
If you want to disable certain extensions you can comment out the different services in the `docker-compose.yml` file and restart the node.
If you want to disable certain extensions, you can comment out the different services in the `docker-compose.yml` file and restart the node.

# More Information

For more information look at the [Github repository](https://github.com/iotaledger/node-docker-setup)
You can find more information in the [GitHub repository](https://github.com/iotaledger/node-docker-setup)
Loading

0 comments on commit deae748

Please sign in to comment.