How to host your own?

Prerequisites

Not much, really.

1. Electrum server running with indexed blockchain data. Ideally with Websocket support, but not required, you can use proxy.
2. Git + Docker

Configuring Electrum server

Due to the nature of web technologies, Btceed can’t communicate with Electrum server directly over TCP. Some Electrum server implementations support Websocket protocol. If that’s your case, you don’t need a proxy.

No proxy

If your Electrum server supports it, you should use Websocket protocol. In Fulcrum, you’d want to include ws = 0.0.0.0:50003 in your Fulcrum config.

Proxy

Your Electrum server is probably already listening on TCP (typically 50001) or SSL (typically 50002) port. For example, in Fulcrum, you’d want tcp = 0.0.0.0:50001 present in your config. You probably already have this enabled for other services like Sparrow Wallet.

Running Btceed

1. Clone the repo. git clone https://github.com/pycanis/btceed.git

2. Set environmental variables located in app/.env.

   Point VITE_ELECTRUM_WS_SERVER_URL to your Electrum server (if using proxy - ws://localhost:7000 or other valid hostname / IP address).

   VITE_BLOCKCHAIN_EXPLORER_URL to your self-hosted blockchain explorer. By default, mempool space is used.

3. Start Docker container(s) as described below.

No proxy

1. Simply run docker compose up app -d in the root of the repo.

2. Btceed should be running on http://localhost:5234.

Proxy

1. Set ELECTRUM_HOST and ELECTRUM_PORT in proxy/.env. The port should point to TCP port of your Electrum server. ELECTRUM_USE_SSL should be true if your Electrum server uses SSL.

2. In the root of the repo, run docker compose up -d.

3. Btceed should be running on http://localhost:5234.

In ideal scenario, you should also put reverse proxy in front of Btceed to get the SSL termination.