Skip to content

Commit

Permalink
update readme & change run.sh
Browse files Browse the repository at this point in the history
  • Loading branch information
alexdovzhanyn committed Dec 6, 2018
1 parent 95bd3d0 commit 096d313
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 5 deletions.
33 changes: 29 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,35 @@

An implementation of the Elixium Network full node.

## Installation
### How to Run

Just install the dependencies: `mix deps.get` (you must have Elixir installed).
Grab the appropriate [latest release](https://github.com/ElixiumNetwork/elixium_node/releases/latest)
and unzip it. If you don't see a release fitting your system, you will
have to build from source.

## Running the Node
The next step is to [port forward](https://www.pcworld.com/article/244314/how_to_forward_ports_on_your_router.html)
ports 31013, 31014, and 32123 on your router. If you don't do this, other
nodes on the network won't be able to connect to yours.

All you need to do is run `mix`
Next, double-click the run.sh file to run the node.

#### Advanced Usage

People who are comfortable working within a terminal may prefer to create their own
run script. To see usage options, cd into the directory where the node is extracted,
and run `./bin/elixium_node usage`.

### Building from Source

If none of the release candidates match your system architecture, it will be
necessary to build from source. It is important to have elixir installed on your
machine, this can be done by following the [installation instructions](https://elixir-lang.org/install.html).

In order to build from source:

1. Clone this repository
2. Run `mix deps.get`
3. Run `MIX_ENV=prod mix release`

Upon successful build, a tarball containing the compiled build can be found
in `_build/prod/rel/elixium_node/releases/<version_number>/elixium_node.tar.gz`
2 changes: 1 addition & 1 deletion rel/overlays/run.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ stty cols 150

SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"

$SCRIPT_DIR/bin/elixium_node foreground --address EX054sbR7BtpfuwpyFvDwWd27ffUhwrRvSeQHgW27cbDz5YyUM2Ue
$SCRIPT_DIR/bin/elixium_node foreground

0 comments on commit 096d313

Please sign in to comment.