Bitcoin Cache Machine is open-source software that allows you to create a self-hosted privacy-preserving software-defined data-center. BCM is built entirely with free and open-source software and is meant primarily for home and small office use in line with the spirit of decentralization.

Note! Bitcoin Cache Machine REQUIRES a Trezor-T to function! Consider buying a dedicated device for your BCM data center, or use passphrases to maintain distinct keyspace.

IMPORTANT! BCM is brand new and unstable, only use testnet coins! Builds will be formally tagged using GPG.asc once a stable proof-of-concept has been created. The master branch represents the most up-to-date stable, and tested, version of BCM. BCM HAS NOT undergone formal security evaluation and should be considered for TESTING PURPOSES ONLY.

YOU ASSUME ALL RISK IN USING THIS SOFTWARE!!!

If you're involved with Bitcoin or care about your privacy, you will undoubtedly understand the importance of running your own fully-validating bitcoin node. Running a fully-validating node is easy enough--just download the software and run it on your home machine, but is that really enough to preserve your overall privacy? Did you configure it correctly? Are you also running a properly configured block explorer? Is your software up-to-date? Is your wallet software configured to consult your trusted full node (and ONLY your node)? Has TOR for these services been configured? Are you backing up user critical data in real time? In practice, there are ton of considerations that need to be addressed.

There are many areas where your privacy can be compromised if you're not careful. BCM is meant to handle many of these concerns by creating a software-defined data center at your home or office that's pre-configured to protect your overall privacy. If you can provide the necessary hardware (CPU, memory, disk), a LAN segment, and an internet gateway, BCM can do much of the rest. Bitcoin Cache Machine dramatically lowers the barriers to deploying and operating your own bitcoin payment infrastructure.

For more information about the motivations behind Bitcoin Cache Machine, visit the public website.

Here are some of the development goals for Bitcoin Cache Machine:

• Provide a self-contained, distributed, event-driven, software-defined data center that focuses on operational Bitcoin and Lightning-related IT infrastructure.
• Enable small-to-medium-sized scalability by adding commodity x86_x64 hardware for home and small office settings.
• Integrate free and open source software (FOSS)!
• Create a composable framework for deploying Bitcoin and Lightning-related components, databases, visualizations, web-interfaces, etc., allowing app developers to start with a fully-operational baseline data center.
• Automate the deployment and operation (e.g., backups, updates, vulnerability assessments, key and password management, etc.) of BCM deployments.
• Require hardware wallets for cryptographic operations (PGP, SSH, and Bitcoin transactions).
• Configure all software to protect user's privacy (e.g., TOR for external communication, disk encryption, minimal attack surface, etc.).
• Pursue Global Consensus and Local Consensus Models for core platform components, e.g., Bitcoin for global financial operations and cwtch for asynchronous, multi-peer communications.
• Enhance overall security and performance and network health by running a Tor middle relay and serving bitcoin blocks over Tor.

If you can run a modern Linux kernel and LXD, you can run BCM. BCM data-center workload components run as background server-side processes, so you'll usually want to have one or more always-on computers with a reliable Internet connection, especially if you're running something like BTCPay Server, which serves web pages (e.g., invoices) to external third parties or running a liquidity-providing Lightning node or acting a JoinMarket maker. You can run BCM data-center workloads directly on your Ubuntu installation or it can run in a hardware-based VM using multipass. User-facing GUI applications such as Electrum Wallet run within the context of docker which is automatically installed via snap.

All you need to get started is an SSH endpoint running Ubuntu 18.04. When running BCM standalone such a user-facing desktop or laptop, data center workloads run within the context of KVM-based Virtual Machine if supported by the hardware. README.md in the cluster directory has more details on prepping a bare-bones Ubuntu Server for a dedicated back-end server.

The first step to getting started with Bitcoin Cache Machine is to clone the git repo to your new SDN controller, a user-facing desktop or laptop.

NOTE: All BCM documentation ASSUMES you're working from a fresh install of Ubuntu (Desktop or Server) >= 18.04. Windows and MacOS are not directly supported, though you can always run Ubuntu in a VM. This goes for both the user-facing SDN controller and dedicated back-end x86_64 data center hardware.

Start by installing tor and git from your SDN Controller. Next, configure your local git client to clone the BCM github repository using TOR for transport. This prevents github.com (i.e., Microsoft) from recording your real IP address. (It might also be a good idea to use a TOR browser when browsing this repo directly on github.).

sudo apt-get update
sudo apt-get install -y tor git
BCM_GITHUB_REPO_URL="https://github.com/BitcoinCacheMachine/BitcoinCacheMachine"
git config --global http.$BCM_GITHUB_REPO_URL.proxy socks5://localhost:9050

You can now clone the BCM repository to your machine over TOR and run setup. You can update your local BCM git repo by running git pull from $BCM_GIT_DIR.

export BCM_GIT_DIR="$HOME/git/github/bcm"
mkdir -p "$BCM_GIT_DIR"
git clone "$BCM_GITHUB_REPO_URL" "$BCM_GIT_DIR"
cd "$BCM_GIT_DIR"
./setup.sh
source ~/.bashrc

You will need to log out and log back (or restart) in for your group membership to refresh. Feel free to change the directory in which you store the BCM repository on your machine. Just update the BCM_GIT_DIR variable. setup.sh sets up your SDN Controller so that you can use Bitcoin Cache Machine's CLI. Running bcm at the terminal ensures that all necessary dependencies are made avaible (LXD client, dockerd) and builds the docker images needed to run bcm commands. The first place you should look for help is the CLI --help menus, e.g., bcm --help.

After the BCM CLI is available, you can deploy your own infrastructure using the bcm stack start command. For example, to deploy the spark lightning web wallet and all its dependencies including clightning and bitcoind, run the bcm stack start spark command. Other components you can deploy either alone or in combination with other software include:

DC=data center: processes that run in the "back-end" or "server-side". The back-end can run on a dedicated set Ubuntu machines (preferred for mainnet/production), or you can run the back-end on a user-facing desktop/laptop (useful for testnet/development). The back-end can run as a Type I VM or can be running under an LXD process installed on your localhost (local). There are trade-offs to using each approach (local/ssh/vm) which are discussed in more detail in the Cluster directory.

User-facing applications can be either GUI-based or web-based apps (AppType). Desktop GUI applications are fully integrated into an automatically deployed back-end infrastructure. Web-based applications, such as BTCPay Server or Spark run as server-side data center workloads but are accessed through a web browser. The eventual goal is to expose BCM application-level services locally (console), over the local network using a Wireguard VPN, and through authenticated TOR onion services when accessing BCM services over the Internet.

Running bcm stack start electrum starts an Electrum wallet desktop application that's configured to consult a self-hosted Electrum server electrs which itself is configured to consult a self-hosted Bitcoin Core full node operating over Tor. Each bcm stack start command automatically deploys all required back-end infrastructure to the active cluster, helping you to operate in a more trust-minimized manner.

You can use the bcm info command to view your current BCM environment variables: certificate, password, ssh, wallet, and certificate stores, cluster under management, and target chain (i.e., mainnet, testnet, regtest). Run bcm config set chain=mainnet to instruct the BCM cli to deploy mainnet applications to the active cluster. At this time BCM deploys a full archival node, so your hardware must be beefy enough. Future BCM versions will support pruned mode if all protocols support that.

The best documentation can be found using the CLI --help menus. You can also consult the README.md files in the major directories of this repo. Consult CLI README for notes on how to use the BCM CLI.

Click the following link to view projects that are related to BCM:

NodeLauncher CipherNode Nodl.it Casa

Users wanting to contribute to the project may submit pull requests for review. Users wanting to contribute documentation can fork the BCM public website here and add blog posts in the _posts directory. A Keybase Team has been created for those wanting to discuss project ideas and coordinate. Keybase Team for Bitcoin Cache Machine

You can also donate to the development of BCM by sending Bitcoin (BTC) to the following address.

• Public on-chain donations: 3KNX4GTmXETtnFWFXvFqXg9sDJCbLvD8Zf