|
| 1 | +# Dojo |
| 2 | + |
| 3 | +> Dojo is a self-hosted Bitcoin backend engineered for privacy. It powers Samourai Wallet and Ashigaru with a private, sovereign, and reliable full-node backend. |
| 4 | + |
| 5 | +Dojo is an open-source, self-hosted backend that puts privacy and sovereignty first. It bundles Bitcoin Core, Electrum Server, BTC-RPC Explorer, and Tor networking to keep your financial metadata off the surveillance web. Run it at home or on your server, and take advantage of advanced tools like BIP47, Auth47, and Boltzmann. |
| 6 | + |
| 7 | +Key features: |
| 8 | +- **Bitcoin Core**: Run your own full node and verify every block and transaction yourself—no third-party trust. Dojo ships with a tuned Core configuration for reliable, long-running operation. |
| 9 | +- **Electrum Server**: Local address indexing for fast wallet sync and history. All wallet lookups hit your server only—keeping XPUBs and addresses off remote services. |
| 10 | +- **BTC-RPC Explorer**: A lightweight block explorer served from your node. Browse blocks, transactions, and the mempool without leaking metadata to public sites. |
| 11 | +- **Tor Networking**: All services are reachable as Tor onion services by default. Keep your IP hidden and access Dojo privately from anywhere. |
| 12 | + |
| 13 | +## Installation |
| 14 | + |
| 15 | +- [Install Requirements](/install/requirements): Hardware and software requirements to run Dojo |
| 16 | +- [Install Dependencies](/install/install-dependencies): Install Docker and other dependencies |
| 17 | +- [Download and Verify](/install/download-and-verify): Download Dojo and verify PGP signatures |
| 18 | +- [Configure Dojo](/install/configure-dojo): Configure Dojo settings before installation |
| 19 | +- [Install Dojo](/install/install-dojo): Complete the Dojo installation process |
| 20 | +- [Monitoring Syncing Status](/install/monitoring-syncing-status): Monitor blockchain sync progress |
| 21 | +- [Segregated User](/install/segregated-user): Set up a dedicated user for Dojo |
| 22 | + |
| 23 | +## Usage |
| 24 | + |
| 25 | +- [Dojo Maintenance Tool](/usage/dojo-maintenance-tool): Manage your Dojo installation |
| 26 | +- [Updating Dojo](/usage/updating-dojo): Update Dojo to the latest version |
| 27 | +- [Personal Block Explorer](/usage/personal-block-explorer): Use BTC-RPC Explorer with your Dojo |
| 28 | +- [View and Edit Config Files](/usage/view-edit-config-files): Manage Dojo configuration |
| 29 | +- [Common Terminal Commands](/usage/common-terminal-commands): Useful commands for Dojo management |
| 30 | +- [Healthy Logs](/usage/healthy-logs): Understand Dojo log output |
| 31 | +- [General Usage Practice](/usage/general-usage-practice): Best practices for running Dojo |
| 32 | + |
| 33 | +## API Reference |
| 34 | + |
| 35 | +- [POST /auth/login](/api/POST_auth_login): Authenticate and obtain access token |
| 36 | +- [POST /auth/refresh](/api/POST_auth_refresh): Refresh authentication token |
| 37 | +- [GET /wallet](/api/GET_wallet): Get wallet information |
| 38 | +- [GET /xpub](/api/GET_xpub): Get xpub information |
| 39 | +- [POST /xpub](/api/POST_xpub): Register an xpub |
| 40 | +- [DELETE /xpub](/api/DELETE_xpub): Remove an xpub |
| 41 | +- [POST /xpub/lock](/api/POST_xpub_lock): Lock an xpub |
| 42 | +- [GET /xpub/import/status](/api/GET_xpub_import_status): Check xpub import status |
| 43 | +- [GET /multiaddr](/api/GET_multiaddr): Get multiple address information |
| 44 | +- [GET /unspent](/api/GET_unspent): Get unspent transaction outputs |
| 45 | +- [GET /txs](/api/GET_txs): Get transactions |
| 46 | +- [GET /tx](/api/GET_tx): Get transaction details |
| 47 | +- [GET /tx/hex](/api/GET_tx_hex): Get raw transaction hex |
| 48 | +- [GET /txout](/api/GET_txout): Get transaction output |
| 49 | +- [GET /seen](/api/GET_seen): Check if address has been seen |
| 50 | +- [POST /pushtx](/api/POST_pushtx): Broadcast a transaction |
| 51 | +- [POST /pushtx/schedule](/api/POST_pushtx_schedule): Schedule a transaction broadcast |
| 52 | +- [GET /fees](/api/GET_fees): Get current fee estimates |
| 53 | +- [GET /fees/estimator](/api/GET_fees_estimator): Get detailed fee estimation |
| 54 | +- [GET /header](/api/GET_header): Get block header |
| 55 | +- [GET /latest-block](/api/GET_latest_block): Get latest block information |
| 56 | +- [GET /support/services](/api/GET_support_services): Get supported services |
| 57 | + |
| 58 | +## Supporting Libraries |
| 59 | + |
| 60 | +- [BIP47](https://github.com/Dojo-Open-Source-Project/bip47): Reusable payment codes for private address exchange |
| 61 | +- [Auth47](https://github.com/Dojo-Open-Source-Project/auth47): Authentication scheme leveraging BIP47 identities |
| 62 | +- [Boltzmann](https://github.com/Dojo-Open-Source-Project/boltzmann): Privacy analysis tooling for transaction entropy |
| 63 | +- [One Dollar Fee Estimator](https://github.com/Dojo-Open-Source-Project/one-dollar-fee-estimator): Heuristic fee estimator aligned with Samourai's UX |
| 64 | + |
| 65 | +## Platforms |
| 66 | + |
| 67 | +Dojo is available on popular node platforms: |
| 68 | +- [Start9](https://github.com/ericpp/dojo-startos): One-click self-hosting OS with a marketplace and easy updates |
| 69 | +- [RoninDojo](https://ronindojo.io/): Dojo-focused platform with tailored tooling and guides |
| 70 | +- [Nodl](https://nodl.eu): Dedicated hardware node with curated services and support |
| 71 | + |
| 72 | +## Releases |
| 73 | + |
| 74 | +- [Latest Releases](/releases): View all Dojo releases and changelogs |
| 75 | + |
| 76 | +## Other |
| 77 | + |
| 78 | +- [PGP Keys](/pgp): Verify Dojo releases with PGP signatures |
| 79 | +- [Donate](/donate): Support Dojo development |
| 80 | +- [Warrant Canary](/canary): Transparency statement |
0 commit comments