Merge pull request #703 from KPrasch/docs

[Hotfix] Include network domain flag in NuFT Guide
pull/705/head
Tux 2019-01-30 01:24:32 +00:00 committed by GitHub
commit 6f1649e374
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 5 deletions

View File

@ -74,6 +74,10 @@ Activate your virtual environment
3. Install Nucypher
Install nucypher with git and pip3 into your virtual environment
.. note::
We recommend NuFT nodes install directly from master to help ensure your node is using pre-released features and hotfixes
.. code::
@ -145,7 +149,7 @@ NuCypher is maintaining a purpose-built endpoint to initially connect to the tes
.. code:: bash
$(nucypher) nucypher ursula run --teacher-uri <SEEDNODE_URI>
$(nucypher) nucypher ursula run --network <NETWORK_DOMAIN> --teacher-uri <SEEDNODE_URI>
...
2. Verify Connection
@ -181,7 +185,7 @@ Subsequent node restarts do not need the teacher endpoint specified.
.. code:: bash
(nucypher)$ nucypher ursula run
(nucypher)$ nucypher ursula run --network <NETWORK_DOMAIN>
...
Alternately you can run your node as a system service.
@ -206,7 +210,7 @@ Use this template to create a file named *ursula.service* and place it in */etc/
User=<YOUR USER>
Type=simple
Environment="NUCYPHER_KEYRING_PASSWORD=<YOUR PASSWORD>"
ExecStart=<VIRTUALENV PATH>/bin/nucypher ursula run <SEEDNODE_URI>
ExecStart=<VIRTUALENV PATH>/bin/nucypher ursula run --network <NETWORK_DOMAIN> --teacher-uri <SEEDNODE_URI>
[Install]
WantedBy=multi-user.target
@ -279,7 +283,7 @@ Update your virtual environment
.. code::
(nucypher)$ pip3 install git+https://github.com/nucypher/nucypher.git@federated`
(nucypher)$ pip3 install git+https://github.com/nucypher/nucypher.git@master`
3. Restart Ursula Node
@ -292,7 +296,7 @@ Interactive method:
$ source nucypher/bin/activate
...
(nucypher)$ nucypher ursula run
(nucypher)$ nucypher ursula run --network <NETWORK_DOMAIN>
OR