Ecosystem/basicswap
1
0
Fork 0
mirror of https://github.com/basicswap/basicswap.git synced 2024-11-17 08:18:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
basicswap/doc/install.md
tecnovert 1da0d06ef0
doc: Improve install notes.
2019-07-30 00:46:10 +02:00

2.3 KiB
Raw Blame History

Prerequisites

$ sudo apt-get install git python3-pip protobuf-compiler
$ git clone https://github.com/tecnovert/basicswap.git

Run Using Docker

Docker must be installed and started: $ sudo systemctl status docker | grep Active

Should return a line containing: active (running)

$ cd basicswap/docker
$ docker-compose build
$ docker-compose up

You may need to run docker-compose with sudo, unless you've setup docker to be able to run from user accounts.

By default the data dir will be basicswap/docker/coindata

To run with a different data directory run:

$ export COINDATA_PATH=/tmp/part_swap_test/coindata

And copy the initial config there:

$ cp -r docker/coindata /tmp/part_swap_test/coindata

Before running docker-compose build

Install as Python Module with PIP

$ cd basicswap
$ protoc -I=basicswap --python_out=basicswap basicswap/messages.proto
$ pip3 install .
$ basicswap-prepare
$ basicswap-run

By default the data dir will be ~/.basicswap To run in a different directory and on testnet:

    $ basicswap-prepare -datadir=~/part_swap_test -testnet
    $ basicswap-run -datadir=~/part_swap_test -testnet

Run Without Installing

$ cd basicswap
$ pip install sqlalchemy protobuf pyzmq
$ protoc -I=basicswap --python_out=basicswap basicswap/messages.proto
$ export PYTHONPATH=$(pwd)
$ python bin/basicswap-prepare.py
$ python bin/basicswap-run.py

OSX

Install Homebrew:

https://brew.sh/

Command Line Tools:

$ xcode-select --install

Dependencies:

$ brew install python git protobuf gnupg

Python certificates:

$ /Applications/Python\ 3.7/Install\ Certificates.command

Basicswap

$ git clone https://github.com/tecnovert/basicswap.git
$ cd basicswap
$ protoc -I=basicswap --python_out=basicswap basicswap/messages.proto
$ pip3 install .
$ basicswap-prepare
$ basicswap-run

Windows

Install git and python3:

https://gitforwindows.org/
https://www.python.org/downloads/windows/

Right click in the directory you want to install into and select 'Git Bash Here':

$ git clone https://github.com/tecnovert/basicswap.git
$ cd basicswap
$ pip3 install .
$ basicswap-prepare
$ basicswap-run

Open url in browser: http://localhost:12700

Shutdown by pressing ctrl + c in the Git Bash console window.