Skip to content

Commit

Permalink
restructure readme
Browse files Browse the repository at this point in the history
  • Loading branch information
openoms committed Feb 15, 2021
1 parent 91728dc commit e7a2ce6
Showing 1 changed file with 32 additions and 19 deletions.
51 changes: 32 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# JoininBox

A terminal based graphical menu for JoinMarket.
A minimalistic, security focused linux environment for JoinMarket with a terminal based graphical menu.

<p align="left">
<img width="400" src="/images/menu.png">
Expand All @@ -11,28 +11,41 @@ A terminal based graphical menu for JoinMarket.
<img width="400" src="/images/menu.payjoin.png">
</p>

## Build a dedicated JoinMarket Box remotely connected to a full node

<p align="left">
<img width="400" src="/images/joininbox.jpeg">
</p>

### Tested environments for JoininBox
### Features

* Send transactions with improved privacy using CoinJoin and PayJoin
* Run the Yield Generator as a service and earn fees for providing liquidity
* Use the JoinMarket-QT GUI remotely over SSH
* Signet support to test for free

### Connect to a Bitcoin Core node

* Try signet locally
* Connect remotely to a
* RaspiBlitz over LAN or Tor
* RoninDojo over LAN or Tor
* Run locally as part of the RaspiBlitz SERVICES
* (Soon: run a pruned node locally on JoininBox)

### Required Hardware
* RaspberryPi 4 ([alternatively any other computer running a Debian Linux flavour](#tested-environments))
* 32 Gb SDcard
* (USB SSD to run a pruned bitcoin node locally)
### Set up JoininBox on Linux

#### Tested environments
* Debian Buster X86_64 desktop
* Hardkernel Odroid XU4 running 32 bit Armbian Buster
* [Raspberry Pi 4 running 64bit Debian Buster](https://github.com/openoms/joininbox/blob/master/FAQ.md#build-the-sdcard-image)
* [Hardkernel Odroid XU4 running 32bit Armbian Buster](https://github.com/openoms/joininbox/blob/master/FAQ.md#set-up-armbian-on-the-hardkernel-odroid-xu4)
* Hardkernel Odroid C4 running 64bit Armbian Focal and Buster
* Raspberry Pi Zero, 3 and 4 running Raspberry OS (32 bit Buster)
### Connected to Bitcoin Core
* running locally
* on RaspiBlitz over LAN or Tor
* on RoninDojo over Tor

### Install and set up the base image
* [Set up Armbian on the Hardkernel Odroid XU4](https://github.com/openoms/joininbox/blob/master/FAQ.md#set-up-armbian-on-the-hardkernel-odroid-xu4)
* [Download and verify Raspbian SDcard image for a Raspberry Pi](https://github.com/openoms/joininbox/blob/master/FAQ.md#download-and-verify-raspbian-sdcard-image-for-a-raspberry-pi)

### Set up JoininBox
* Continue to work as the `root` user or change with:
* Raspberry Pi Zero, [3 and 4 running RaspberryOS](https://github.com/openoms/joininbox/blob/master/FAQ.md#download-and-verify-raspbian-sdcard-image-for-a-raspberry-pi) (32bit Buster)

#### Install JoininBox
* Start as the `root` user or change with:
`$ sudo - su`

* Run the [build script](https://github.com/openoms/joininbox/blob/master/build_joininbox.sh):
Expand All @@ -55,7 +68,7 @@ the default password is: `joininbox` - will be prompted to change it on the firs

## More info

* [Video demonstration](https://www.youtube.com/watch?v=uGHRjilMhwY) / [Slides](https://keybase.pub/oms/slides/RaspiBlitz_Tech_DeepDive/Running_JoinMarket_on_the_RaspiBlitz.pdf) of running JoinMarket with JoininBox on the RaspiBlitz
* [Video demonstration](https://www.youtube.com/watch?v=uGHRjilMhwY) / [slides](https://keybase.pub/oms/slides/RaspiBlitz_Tech_DeepDive/Running_JoinMarket_on_the_RaspiBlitz.pdf) of running JoinMarket with JoininBox on the RaspiBlitz
* How to [prepare a remote node to accept the JoinMarket connection](prepare_remote_node.md)
* [Frequently Asked Questions and notes](FAQ.md)
* [JoinMarket on the RaspiBlitz guide](https://github.com/openoms/bitcoin-tutorials/blob/master/joinmarket/README.md)
Expand All @@ -64,7 +77,7 @@ the default password is: `joininbox` - will be prompted to change it on the firs

## Forums

* Keybase: https://keybase.io/team/raspiblitz#joinmarket
* Telegram: https://t.me/joinmarketorg
* IRC: #joinmarket on Freenode
* Reddit: https://www.reddit.com/r/joinmarket/
* Keybase: https://keybase.io/team/raspiblitz#joinmarket

0 comments on commit e7a2ce6

Please sign in to comment.