Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MYST-445 Make install and readme instructions great again #284

Merged
merged 10 commits into from Aug 8, 2018

Conversation

Projects
None yet
4 participants
@tadovas
Copy link
Member

commented Jul 9, 2018

Key points:

  1. Runtime and config dirs defaults changed to current dir of executable
  2. Persistent data dir left untouched (home of user)
  3. Updated install and readme instructions
INSTALL.md Outdated
```bash
sudo apt-get install docker-ce

This comment has been minimized.

Copy link
@Waldz

Waldz Jul 9, 2018

Member

Same is duplicated in README.md

This comment has been minimized.

Copy link
@tadovas

tadovas Jul 10, 2018

Author Member

Fixed (should be)

@tadovas tadovas force-pushed the improvement/MYST-445-update-INSTALL.md branch from bcbe0f4 to 410bd13 Jul 9, 2018

sudo docker run --cap-add NET_ADMIN --net host --publish "1194:1194" --name mysterium-node -d mysteriumnetwork/mysterium-node:{VERSION} --agreed-terms-and-conditions
```
You can skip `{VERSION}` to fetch latest image.

Note: to run server, you will have to accept terms & conditions by adding '--agreed-terms-and-conditions' command line option.

This comment has been minimized.

Copy link
@Waldz

Waldz Jul 9, 2018

Member

Suggest to improve instruction like here: https://hub.docker.com/r/mysteriumnetwork/mysterium-node/

This comment has been minimized.

Copy link
@tadovas

tadovas Jul 10, 2018

Author Member

Both updated.

INSTALL.md Outdated
@@ -45,6 +21,7 @@ sudo docker logs -f mysterium-node


## Mysterium VPN node (Debian && Ubuntu) - tested on Ubuntu 16.04
Note: you need to replace {version} with specific version number from [releases](https://github.com/MysteriumNetwork/node/releases/)
### Download
* https://github.com/MysteriumNetwork/node/releases/download/{VERSION}/mysterium-node_linux_amd64.deb
* https://github.com/MysteriumNetwork/node/releases/download/{VERSION}/mysterium-node_linux_armhf.deb

This comment has been minimized.

Copy link
@zolia

zolia Jul 11, 2018

Member

we no longer build for 'armhf'.

This comment has been minimized.

Copy link
@tadovas

tadovas Jul 11, 2018

Author Member

Removed

INSTALL.md Outdated
mysterium_client --help
sudo mysterium_client && mysterium_client --cli
cd <extracedir>
sudo ./<mysterium_client or mysterium_server>

This comment has been minimized.

Copy link
@zolia

zolia Jul 11, 2018

Member

bit overkill, i'd just split into two commands.

This comment has been minimized.

Copy link
@tadovas

tadovas Jul 11, 2018

Author Member

Splitted into separate sections for client and node

func ensureOrCreateDir(dir string) error {
err := ensureDirExists(dir)
if os.IsNotExist(err) {
return os.MkdirAll(dir, 0600)

This comment has been minimized.

Copy link
@zolia

zolia Jul 11, 2018

Member

I would add some verbosity here.. "missing {dir} creating.. "

This comment has been minimized.

Copy link
@tadovas

tadovas Jul 11, 2018

Author Member

Added log line if attempting to create a dir

@tadovas tadovas force-pushed the improvement/MYST-445-update-INSTALL.md branch from c957e4c to f973328 Jul 11, 2018

@@ -19,29 +19,25 @@ glide install
go build github.com/mysterium/node

This comment has been minimized.

Copy link
@Waldz

Waldz Jul 11, 2018

Member

Compilation step not valid also. Should about dependencies only

This comment has been minimized.

Copy link
@tadovas

tadovas Jul 11, 2018

Author Member

Step changed from "Compile code" to "Fetch dependencies"

@tadovas tadovas changed the title WIP: MYST-445 Make install and readme instructions great again MYST-445 Make install and readme instructions great again Jul 11, 2018

@tadovas tadovas force-pushed the improvement/MYST-445-update-INSTALL.md branch from b45e117 to 24b2fc3 Jul 11, 2018

@tadovas tadovas force-pushed the improvement/MYST-445-update-INSTALL.md branch 2 times, most recently from 2e6ad88 to fbdb508 Jul 11, 2018

@Arrnas Arrnas referenced this pull request Jul 15, 2018

Closed

Improve documentation #297

@Waldz Waldz force-pushed the improvement/MYST-445-update-INSTALL.md branch from fbdb508 to a639f9f Aug 7, 2018

@Waldz

Waldz approved these changes Aug 8, 2018

@interro

interro approved these changes Aug 8, 2018

@tadovas tadovas merged commit a85a494 into master Aug 8, 2018

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details

@tadovas tadovas deleted the improvement/MYST-445-update-INSTALL.md branch Aug 8, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.