A repo facilitating running ItchySats inside a Docker container on a x86-64 (e.g. macOS, Linux, Windows) or ARMv7 system.
ItchySats is a tool allowing CFD trading on Bitcoin - non-custodial, peer-to-peer, Bitcoin only.
You can find more information about ItchySats (along with complete source code) on the main github repo. FAQ might be another good source of knowledge if you get stuck.
The following guide assumes that you have Docker running, having docker-compose installed is also recommended. Docker website provides extensive tutorials on Docker installation, please refer there if you are new to Docker.
If you just want to check out the application, and want to try out a "demo" version, where you don't trade with real money, then this config is for you.
docker-compose --project-directory=testnet up -d
If you're ready to trade with real money, use the following command:
docker-compose --project-directory=mainnet up -d
Docker command starts an ItchySats service running in the background.
The service can be controlled via the provided web UI accessible on https://localhost:8000.
Web UI requires authentication via password generated from your taker_seed.
Credentials can be seen in Docker logs after typing in the following command (example for mainnet):
docker-compose --project-directory=mainnet logs
It is strongly recommended to not store ItchySats logs outside your machine without filtering the credentials out.
On the example of mainnet:
docker-compose --project-directory=mainnet down
- at this stage there is no automated backup of the wallet seed and the database (please backup up 'data' directory inside
testnetormainnetand store it securely) - due to using the same port, running mainnet and testnet version at the same time is not supported.
In case none of the above questions match the problem you're having, please feel free to reach out to us via one of the following channels:
We encourage community contributions whether it be a bug fix, feature suggestion or an improvement to the documentation.