Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JoeyKhd authored Dec 31, 2018
1 parent 35a3837 commit 2a86920
Showing 1 changed file with 47 additions and 30 deletions.
77 changes: 47 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,59 +1,76 @@
## Go EFSN
<div align="center"><img src ="https://i.imgur.com/lixyKZe.png" height="100px" /></div>

## Go eFSN

Fusion would like to extend its gratitude to the Ethereum Foundation. Fusion has used the official open-source golang implementation of the Ethereum protocol.


## Quick Start on docker
## Run a Gateway

Change the parameter `YOURDIRECTORY` to your local directory

### Build the Gateway
`docker build --file Dockerfile.gtw -t fusionnetwork/gateway`

`docker run -it -p 9001:9001 -v YOURDIRECTORY:/fusion-node fusionnetwork/gateway`

#Build the gateway
docker build --file Dockerfile.gtw -t fusionnetwork/gateway
docker run -it -p 9001:9001 -v /Users/work/dev/dockerVolume/fusion-node:/fusion-node  fusionnetwork/gateway
### Run a Gateway
`docker run -it -p 9001:9001 -v YOURDIRECTORY:/fusion-node fusionnetwork/gateway`

#Run a gateway
docker run -it -p 9001:9001 -v /Users/work/dev/dockerVolume/fusion-node:/fusion-node  fusionnetwork/gateway
You can now connect via `ws://localhost:9001z

Change the parameter /Users/work/dev/dockerVolume/fusion-node to your local directory
## Run a miner (Ubuntu 16.04)

Connect via ws://localhost:9001
Please, to run a miner on Ubuntu use the following guide.

#run a miner on docker
Instructions to run on ubuntu linux in under 10 minutes
Open up the terminal and execute the following commands:

Open up terminal and fill in the following commands.
`sudo apt-get update`

sudo apt-get update
sudo apt-get install docker.io
`sudo apt-get install docker.io`

Now it is time to pay attention since we need to have all directories set up correctly.

Replace the following to fit you:

THEDIRECTORYFORYOURNODE = (example: /home/yourname/psn)
YOURWALLETADDRESSHERE = (example: '0xwhatever') single quotes must not be removed.
NAMEOFYOURNODEHERE = AFusioniteNode
`THEDIRECTORYFORYOURNODE` = (example: /home/yourname/psn)

type in: sudo nano runpsn.sh
`YOURWALLETADDRESSHERE` = (example: '0xwhatever') | Note : Single quotes must not be removed.

`NAMEOFYOURNODEHERE` = AFusionNode

Type in: `sudo nano runpsn.sh`
paste in the following line with your corresponding replacements:

sudo docker run -v THEDIRECTORYFORYOURNODE:/fusion-node fusionnetwork/efsn -u 'YOURWALLETADDRESSHERE' -e NAMEOFYOURNODEHERE
`sudo docker run -v THEDIRECTORYFORYOURNODE:/fusion-node fusionnetwork/efsn -u 'YOURWALLETADDRESSHERE' -e NAMEOFYOURNODEHERE`

Save the file by hitting `CTRL+O` and exit Nano by pressing `CTRL+X`

We now have to make our .sh file executable. Run the following commands:

`sudo chmod +x runpsn.sh`

Execute the sh file by running:

`sudo ./runpsn.sh`

You will now notice that the node doesn't run because the password file and keystore file are missing.

Put your keystore in the `THEDIRECTORYFORYOURNODE/data/keystore` folder

exit nano by pressing ctrl-x
and the password.txt file in: `THEDIRECTORYFORYOURNODE/password.txt`

run the following commands:
sudo chmod +x runpsn.sh
sudo ./runpsn.sh
`Note: Password file must be named password.txt and the keystore must have UTC in it's name.`

you will see that the node doesn't run because the password file and keystore are missing.
put your keystore in the THEDIRECTORYFORYOURNODE/data/keystore folder
and a password file like this THEDIRECTORYFORYOURNODE/password.txt
After finishing the above tasks run the node again by typing.

run ./runpsn.sh again.
`sudo ./runpsn.sh`

VOILA A NODE RUNNING!!!
Your node is now set up successfully.

#API Reference
## API Reference

Api reference can be found at https://github.com/FUSIONFoundation/web3-fusion-extend
The API reference can be found [here](https://github.com/FUSIONFoundation/web3-fusion-extend)

## Building the source

Expand Down

0 comments on commit 2a86920

Please sign in to comment.