Skip to content

Commit

Permalink
cmd/multinode: Add further documentation (#4556)
Browse files Browse the repository at this point in the history
The text has been expanded a bit to clarify that it is necessary to create identity files with an example before using the Docker image.
Changed the <identity-dir> placeholder to <multinode-identity-dir> so no one confuses them with the storagenode identity files.
Changed the <storage-dir> placeholder to <multinode-config-dir> so no one confuses them with the storagenode 'config' folder.

fixed #4547
  • Loading branch information
Sembeth committed Feb 22, 2022
1 parent b11d144 commit d015805
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions cmd/multinode/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,30 @@

[Tech Preview Forum Post](https://forum.storj.io/t/tech-preview-multinode-dashboard-binaries/14572)

## Running in Docker
## Generate identity files

In order to run this docker image, you need to generate an identity like this:
In order to run this Docker image, you need to create an identity for the Multinode Dashboard.
For this you need the binaries of the Identity Tool, which you can find in the latest version here:

[https://github.com/storj/storj/releases/latest](https://github.com/storj/storj/releases/latest)

In this example under Windows, we use the file `identity_windows_amd64.zip`, download it and unzip it.
Then we open a PowerShell window in the folder where the `identity.exe` was unzipped and run the following command:
```
identity create multinode --difficulty 10
./identity.exe create multinode --difficulty 10
```

If we run this command on Windows, the identity files will be created in the folder `%appdata%\Storj\Identity\multinode`.

## Running the Multinode Dashboard in Docker

Then start the image like this, while replacing the directories marked by the `< >` with your parameters below:

```
docker run -d --restart unless-stopped \
--user $(id -u):$(id -g) \
-p 127.0.0.1:15002:15002/tcp \
--mount type=bind,source="<identity-dir>",destination=/app/identity \
--mount type=bind,source="<storage-dir>",destination=/app/config \
--mount type=bind,source="<multinode-identity-dir>",destination=/app/identity \
--mount type=bind,source="<multinode-config-dir>",destination=/app/config \
--name multinode storjlabs/multinode:latest
```

0 comments on commit d015805

Please sign in to comment.