JakeHillion/storj
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

cmd/multinode: Add further documentation (#4556)

Browse Source 
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
This commit is contained in:
Sembeth 2022-02-22 14:42:54 +01:00 committed by GitHub
parent b11d144bb6
commit d015805d15
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
cmd/multinode/README.md
View File

@ -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
```