Browse Source

Added instructions

feature/dockerfile-arm
Gonzalo Javier Aune 5 years ago
parent
commit
c14c551647
  1. 11
      .lnd/lnd.conf
  2. 58
      README.md
  3. 11
      docker-compose.yml
  4. 11
      lnd.conf.sample

11
.lnd/lnd.conf

@ -0,0 +1,11 @@
bitcoin.mainnet=1
bitcoin.active=1
bitcoin.node=neutrino
alias=myalias
listen=0.0.0.0:9735
rpclisten=0.0.0.0:10009
ignore-historical-gossip-filters=true
nobootstrap=true
numgraphsyncpeers=1

58
README.md

@ -1,6 +1,6 @@
# Relay
**Relay** is a Node.js wrapper around [LND](https://github.com/lightningnetwork/lnd), handling connectivity and storage for [**Sphinx**](https://sphinx.chat). Communication between Relay nodes takes place entirely on the Lightning Network, so is decentralized, untraceable, and encrypted. Message content is also end-to-end encrypted using client public keys, on the **Sphinx** app itself.
**Relay** is a Node.js wrapper around [LND](https://github.com/lightningnetwork/lnd), handling connectivity and storage for [**Sphinx**](https://sphinx.chat). Communication between Relay nodes takes place entirely on the Lightning Network, so is decentralized, untraceable, and encrypted. Message content is also end-to-end encrypted using client public keys, on the **Sphinx** app itself.
![Relay](https://github.com/stakwork/sphinx-relay/raw/master/public/relay.jpg)
@ -13,6 +13,62 @@ Relay stores:
# run your own sphinx node
## Using Docker on Raspberry Pi
Install docker-compose: https://medium.com/@techiebouncer/install-docker-and-docker-compose-on-raspberry-pi-4-raspbian-buster-c5b78b9a0d08
Clone this repo.
Copy your id_rsa to clone the private lnd-lean repo.
```
cp ~/.ssh/id_rsa .
```
Build it.
```
docker-compose build
```
Edit your docker-compose.yml file replacing NODE_IP and NODE_ALIAS.
Relay will run on port 3000 local. You would need to point your router's port forwarding from 80 to 3000 to your docker machine.
Start up LND separately first.
```
docker-compose up lnd
```
- In another terminal, go to the project folder and run.
```
docker-compose exec lnd bash
```
Once you're given a bash, run `ping lnd` and take note of the IP, this is because we need to tell Relay where lnd is via the IP, this is a temporary measure due to the limitation of the grpc connection can only be done via IP and not domain name.
Edit your app.json file inside config and on the `production` key replace `node_ip` with the one from the ping.
Run Relay.
```
docker-compose up node_server
```
Create / Unlock your wallet
```
docker-compose exec lnd lncli create
docker-compose exec lnd lncli unlock
```
NOTE: All lncli commands need to be prepended with `docker-compose exec lnd`, this tells docker to execute **something** on the lnd container.
## Without Docker
You can run your own Sphinx node in order to have full ownership over your communication!
### download

11
docker-compose.yml

@ -12,11 +12,7 @@ services:
ports:
- "9735:9735"
- "10009:10009"
- "8080:8080"
command: 'lnd --accept-keysend'
# networks:
# - lnd_relay
# tty: true
node_server:
build:
context: .
@ -29,12 +25,9 @@ services:
- node_modules:/relay/node_modules
ports:
- "3000:3000"
# tty: true
command: "npm start"
# networks:
# - lnd_relay
environment:
- PORT=3000
- NODE_IP=51.37.119.104
- NODE_ALIAS=gonza-ireland
- NODE_IP=mynodeip
- NODE_ALIAS=myalias
- NODE_ENV=production

11
lnd.conf.sample

@ -0,0 +1,11 @@
bitcoin.mainnet=1
bitcoin.active=1
bitcoin.node=neutrino
alias=myalias
listen=0.0.0.0:9735
rpclisten=0.0.0.0:10009
ignore-historical-gossip-filters=true
nobootstrap=true
numgraphsyncpeers=1
Loading…
Cancel
Save