Skip to content

Commit

Permalink
updated npm and docker image versions to reflect 1.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
yaruno committed Mar 5, 2024
1 parent 4a66c72 commit 38ad6ff
Show file tree
Hide file tree
Showing 9 changed files with 20 additions and 23 deletions.
14 changes: 7 additions & 7 deletions docs/docs/guides/how-to-run-streamr-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Start the Config Wizard with the below command. Docker will download the node im
#### Run the config wizard (Linux / macOS instructions)

```
sudo docker run -it -v $(cd ~/.streamrDocker && pwd):/home/streamr/.streamr streamr/node:v100.0.0-rc.1 bin/config-wizard
sudo docker run -it -v $(cd ~/.streamrDocker && pwd):/home/streamr/.streamr streamr/node bin/config-wizard
```

#### **Windows PowerShell instructions**
Expand All @@ -64,7 +64,7 @@ cd ~/.streamrDocker
Then run the Config Wizard:

```
docker run -it -v ${pwd}:/home/streamr/.streamr streamr/node:v100.0.0-rc.1 bin/config-wizard
docker run -it -v ${pwd}:/home/streamr/.streamr streamr/node bin/config-wizard
```

#### Using the Config Wizard
Expand All @@ -88,7 +88,7 @@ If you're running a node to become an Operator, then you could now jump back to
#### Linux / macOS instructions

```
sudo docker run -p 32200:32200 --name streamr --restart unless-stopped -d -v $(cd ~/.streamrDocker && pwd):/home/streamr/.streamr streamr/node:v100.0.0-rc.1
sudo docker run -p 32200:32200 --name streamr --restart unless-stopped -d -v $(cd ~/.streamrDocker && pwd):/home/streamr/.streamr streamr/node
```

#### Windows PowerShell instructions
Expand All @@ -99,7 +99,7 @@ First move into your node's folder:
cd ~/.streamrDocker
```
```
docker run -p 32200:32200 --name streamr --restart unless-stopped -d -v ${pwd}:/home/streamr/.streamr streamr/node:v100.0.0-rc.1
docker run -p 32200:32200 --name streamr --restart unless-stopped -d -v ${pwd}:/home/streamr/.streamr streamr/node
```

**The `docker run` command, deconstructed:**
Expand Down Expand Up @@ -147,11 +147,11 @@ See [Docker's documentation](https://docs.docker.com/engine/reference/commandlin
### Step 1: Install the recommended version using npm
If you don’t have Node.js installed, install it using [nvm](https://github.com/nvm-sh/nvm#installing-and-updating) or manually from the [Node.js site](https://nodejs.org/en/download/). The Streamr node requires at least Node.js version 16.x. Once installed, you can download, configure, and start the Streamr node.

- Run `npm install -g @streamr/node@100.0.0-rc.1` to download and install the package. You may need administrative access to run this command. The recommended version may be different to the version listed here, if in doubt, check the [npm registry](https://www.npmjs.com/package/@streamr/node?activeTab=versions).
- Run `npm install -g @streamr/node` to download and install the package. You may need administrative access to run this command. The recommended version may be different to the version listed here, if in doubt, check the [npm registry](https://www.npmjs.com/package/@streamr/node?activeTab=versions).

To install the Streamr node, run,
```
npm install -g @streamr/node@100.0.0-rc.1
npm install -g @streamr/node
```

There can be plenty of output from npm. If the installation fails with an error, you should address it before continuing.
Expand Down Expand Up @@ -233,7 +233,7 @@ For extra logging on your Streamr node, add the `LOG_LEVEL` environmental variab

For example,
```shell
sudo docker run -p 32200:32200 --name streamr --restart unless-stopped -d -e LOG_LEVEL=trace -v $(cd ~/.streamrDocker && pwd):/home/streamr/.streamr streamr/node:v100.0.0-rc.1
sudo docker run -p 32200:32200 --name streamr --restart unless-stopped -d -e LOG_LEVEL=trace -v $(cd ~/.streamrDocker && pwd):/home/streamr/.streamr streamr/node
```

## Mumbai node config
Expand Down
3 changes: 0 additions & 3 deletions docs/docs/guides/how-to-stake-and-earn.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,6 @@ To earn DATA tokens on Polygon you must be willing to hold and stake DATA tokens
- **Do NOT** create or sponsor Sponsorships. If you do tokens will be irreversibly sent to that Sponsorship contract. There is no undo for this.
:::

### Current node software version
Use node version: `v100.0.0-rc.1`. Do not use the `latest` tag release.

### Sponsorships
Sponsorships are the source of incentivization. These are visible on [The Hub](https://streamr.network/hub/network/sponsorships).

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/guides/how-to-update-your-streamr-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Keeping your node up to date is very important as new releases contain bug fixes
This guide is meant for Linux and MacOS. Windows Powershell commands will be slightly different.
:::

To update your Streamr node from `v100.0.0-testnet-three.6` to `v100.0.0-rc.1` (for example), run:
To update your Streamr node from `v100.0.0-testnet-three.6` to `latest` (for example), run:

```
sudo docker stop streamr && sudo docker rm streamr && sudo docker container prune --force
Expand All @@ -30,7 +30,7 @@ sudo docker rmi IMAGE_ID
Run your updated node with the new node version,

```
sudo docker run -p 32200:32200 --name streamr --restart unless-stopped -d -v $(cd ~/.streamrDocker && pwd):/home/streamr/.streamr streamr/node:v100.0.0-rc.1
sudo docker run -p 32200:32200 --name streamr --restart unless-stopped -d -v $(cd ~/.streamrDocker && pwd):/home/streamr/.streamr streamr/node
```

Your updated node will now be running. As usual, you can checkup on it with
Expand All @@ -52,7 +52,7 @@ pm2 stop streamr

Next, globally install the node upgrade:
```
npm install -g @streamr/node@100.0.0-rc.1
npm install -g @streamr/node
```

And then you can run the node:
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/guides/nodejs.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This is a quickstart guide on creating your first stream using the Streamr TypeS
The Streamr SDK is available on [NPM](https://www.npmjs.com/package/@streamr/node) and can be installed simply with:

```shell
$ npm install @streamr/sdk@100.0.0-rc.1
$ npm install @streamr/sdk
```

Having trouble installing the SDK? Maybe our [troubleshooting](../usage/streamr-js-client/how-to-use#Troubleshooting) section will help.
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/guides/use-any-language-or-device.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ If you have a Helium setup, you may benefit from reading this blog post first, [
You'll need to run a [Streamr node](../streamr-network/streamr-nodes.md) to connect your app to.

```shell
$ npm i -g @streamr/node@100.0.0-rc.1
$ npm i -g @streamr/node
```

Before the Streamr node can be started, its configuration files need to be created using the following command:
Expand Down Expand Up @@ -61,7 +61,7 @@ $ npm init
The Streamr SDK is available on [NPM](https://www.npmjs.com/package/@streamr/sdk) and can be installed simply with:

```shell
$ npm install @streamr/sdk@100.0.0-rc.1
$ npm install @streamr/sdk
```

Having trouble installing the client? Maybe our [troubleshooting](../usage/streamr-js-client/how-to-use#Troubleshooting) section will help.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/guides/web-app-frameworks.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ First you need to install the Streamr SDK in your application:
The SDK is available on [NPM](https://www.npmjs.com/package/@streamr/sdk) and can be installed simply with:

```shell
$ npm install @streamr/sdk@100.0.0-rc.1
$ npm install @streamr/sdk
```

Having trouble installing the SDK? Maybe our [troubleshooting](../usage/streamr-js-client/how-to-use#Troubleshooting) section will help.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/help/operator-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ If you’ve been running a Streamr node in the past you might be familiar with a
- You can run ~~up to 5 nodes per IP address~~ any number of nodes from the same IP address, although one node per machine is recommended
- Rewards are ~~automatically paid out at the beginning of the following month~~ claimed from active Sponsorships at any time
- You can stake ~~up to 20K DATA per node~~ as much as you want. Note that at least 5% of Operator stake must come from the owner, and therefore delegations can not exceed 95%.
- To participate, use specific versions/tags of the Streamr node software, such as `v100.0.0-testnet-three.3`. The `latest` tag still points to the previous milestone (Brubeck) software.
- To participate, you can use the `latest` tag. NPM package and docker images will automatically refer to the latest version if no version tag is given.
- There is no need for a "beneficiary address" in Streamr 1.0. Instead, the node configuration contains the Operator contract address.
:::

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/streamr-network/brubeck-network/run-a-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -266,10 +266,10 @@ See [Docker's documentation](https://docs.docker.com/engine/reference/commandlin
If you don’t have Node.js installed, install it using [nvm](https://github.com/nvm-sh/nvm#installing-and-updating) or manually from the [Node.js site](https://nodejs.org/en/download/). The Streamr Node requires at least Node.js version 18.x. Once installed, you can download, configure, and start the Streamr Node.

### Step 1: Install the latest version using npm
- Run `npm install -g @streamr/node@100.0.0-rc.1` to download and install the package. You may need administrative access to run this command.
- Run `npm install -g @streamr/node` to download and install the package. You may need administrative access to run this command.

```
npm install -g @streamr/node@100.0.0-rc.1
npm install -g @streamr/node
```

There can be plenty of output from npm. If the installation fails with an error, you should address it before continuing.
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/usage/streamr-js-client/how-to-use.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The Streamr SDK, is the main TypeScript library for interacting with the Streamr
The SDK is available on [npm](https://www.npmjs.com/package/@streamr/sdk) and can be installed simply by:

```
npm install @streamr/sdk@100.0.0-rc.1
npm install @streamr/sdk
```

### Importing streamr-client
Expand All @@ -38,7 +38,7 @@ NodeJS `18.13.x` is the minimum required version, ideally version 20 and later.
For usage in the browser include the latest build, e.g. by including a `<script>` tag pointing at a CDN:

```html
<script src="https://unpkg.com/@streamr/sdk@100.0.0-rc.1/streamr-sdk.web.js"></script>
<script src="https://unpkg.com/@streamr/sdk/streamr-sdk.web.js"></script>
```

#### Browser extension
Expand Down Expand Up @@ -90,4 +90,4 @@ export OPENSSL_ROOT_DIR="/opt/homebrew/opt/[email protected]"

Make sure to restart your terminal as the system variables then reload into your zsh terminal

Run `npm install @streamr/sdk@100.0.0-rc.1` in your project folder
Run `npm install @streamr/sdk` in your project folder

0 comments on commit 38ad6ff

Please sign in to comment.