mempool/README.md

# The Mempool Open Source Project® [![mempool](https://img.shields.io/endpoint?url=https://dashboard.cypress.io/badge/simple/ry4br7/master&style=flat-square)](https://dashboard.cypress.io/projects/ry4br7/runs)

https://user-images.githubusercontent.com/93150691/226236121-375ea64f-b4a1-4cc0-8fad-a6fb33226840.mp4

<br>

Mempool is the fully-featured mempool visualizer, explorer, and API service running at [mempool.space](https://mempool.space/). 

It is an open-source project developed and operated for the benefit of the Bitcoin community, with a focus on the emerging transaction fee market that is evolving Bitcoin into a multi-layer ecosystem.

# Installation Methods

Mempool can be self-hosted on a wide variety of your own hardware, ranging from a simple one-click installation on a Raspberry Pi full-node distro all the way to a robust production instance on a powerful FreeBSD server. 

**Most people should use a one-click install method.** Other install methods are meant for developers and others with experience managing servers. 

<a id="one-click-installation"></a>
## One-Click Installation

Mempool can be conveniently installed on the following full-node distros: 
- [Umbrel](https://github.com/getumbrel/umbrel)
- [RaspiBlitz](https://github.com/rootzoll/raspiblitz)
- [RoninDojo](https://code.samourai.io/ronindojo/RoninDojo)
- [myNode](https://github.com/mynodebtc/mynode)
- [Start9](https://github.com/Start9Labs/embassy-os)

**We highly recommend you deploy your own Mempool instance this way.** No matter which option you pick, you'll be able to get your own fully-sovereign instance of Mempool up quickly without needing to fiddle with any settings.

## Advanced Installation Methods

Mempool can be installed in other ways too, but we only recommend doing so if you're a developer, have experience managing servers, or otherwise know what you're doing.

- See the [`docker/`](./docker/) directory for instructions on deploying Mempool with Docker.
- See the [`backend/`](./backend/) and [`frontend/`](./frontend/) directories for manual install instructions oriented for developers.
- See the [`production/`](./production/) directory for guidance on setting up a more serious Mempool instance designed for high performance at scale.
Update mosp strings from tm to r 2023-06-27 16:24:31 +02:00			`# The Mempool Open Source Project® [![mempool](https://img.shields.io/endpoint?url=https://dashboard.cypress.io/badge/simple/ry4br7/master&style=flat-square)](https://dashboard.cypress.io/projects/ry4br7/runs)`
Update installation instructions for nginx/certbot (fixes #6) 2019-08-23 02:51:12 +02:00
Add poster image for readme video Also add line-break after video and remove screenshot. 2023-03-20 03:58:39 +01:00			`https://user-images.githubusercontent.com/93150691/226236121-375ea64f-b4a1-4cc0-8fad-a6fb33226840.mp4`

			`<br>`
Add mempool promo video (via YouTube) in README 2023-03-02 14:42:56 +01:00
Adjust opening readme description 2022-05-02 20:15:28 +02:00			`Mempool is the fully-featured mempool visualizer, explorer, and API service running at [mempool.space](https://mempool.space/).`
Add instructions for Docker Hub to README 2020-03-29 20:58:28 +02:00
Add back overwritten sentence to main readme 2022-05-07 23:20:58 +02:00			`It is an open-source project developed and operated for the benefit of the Bitcoin community, with a focus on the emerging transaction fee market that is evolving Bitcoin into a multi-layer ecosystem.`

Adjust main readme 2022-05-03 19:04:02 +02:00			`# Installation Methods`
Update README with instructions for various installation methods 2021-02-11 06:57:43 +01:00
Edit installation methods list + 1-click section Remove HA item. 2022-05-02 20:35:03 +02:00			`Mempool can be self-hosted on a wide variety of your own hardware, ranging from a simple one-click installation on a Raspberry Pi full-node distro all the way to a robust production instance on a powerful FreeBSD server.`
Update README with instructions for various installation methods 2021-02-11 06:57:43 +01:00
Move manual install docs away from main readme Replace with links to docker/, frontend/, and /backend. 2022-05-19 18:43:37 +02:00			`Most people should use a one-click install method. Other install methods are meant for developers and others with experience managing servers.`
Move Docker instructions to the top level README 2022-01-13 02:18:33 +01:00
Edit installation methods list + 1-click section Remove HA item. 2022-05-02 20:35:03 +02:00			`<a id="one-click-installation"></a>`
Adjust main readme 2022-05-03 19:04:02 +02:00			`## One-Click Installation`
Move Docker instructions to the top level README 2022-01-13 02:18:33 +01:00
Edit installation methods list + 1-click section Remove HA item. 2022-05-02 20:35:03 +02:00			`Mempool can be conveniently installed on the following full-node distros:`
			`- [Umbrel](https://github.com/getumbrel/umbrel)`
			`- [RaspiBlitz](https://github.com/rootzoll/raspiblitz)`
			`- [RoninDojo](https://code.samourai.io/ronindojo/RoninDojo)`
			`- [myNode](https://github.com/mynodebtc/mynode)`
			`- [Start9](https://github.com/Start9Labs/embassy-os)`
Move Docker instructions to the top level README 2022-01-13 02:18:33 +01:00
Move manual install docs away from main readme Replace with links to docker/, frontend/, and /backend. 2022-05-19 18:43:37 +02:00			`We highly recommend you deploy your own Mempool instance this way. No matter which option you pick, you'll be able to get your own fully-sovereign instance of Mempool up quickly without needing to fiddle with any settings.`
Update README instructions and nginx.conf for v2.0 release 2021-01-11 15:07:16 +01:00
Move manual install docs away from main readme Replace with links to docker/, frontend/, and /backend. 2022-05-19 18:43:37 +02:00			`## Advanced Installation Methods`
Update installation instructions for nginx/certbot (fixes #6) 2019-08-23 02:51:12 +02:00
Move manual install docs away from main readme Replace with links to docker/, frontend/, and /backend. 2022-05-19 18:43:37 +02:00			`Mempool can be installed in other ways too, but we only recommend doing so if you're a developer, have experience managing servers, or otherwise know what you're doing.`
Add instructions and screenshots to README 2019-07-22 10:46:36 +02:00
Move manual install docs away from main readme Replace with links to docker/, frontend/, and /backend. 2022-05-19 18:43:37 +02:00			- See the [`docker/`](./docker/) directory for instructions on deploying Mempool with Docker.
Clarify that manual installs are meant for devs 2022-06-11 17:05:53 +02:00			- See the [`backend/`](./backend/) and [`frontend/`](./frontend/) directories for manual install instructions oriented for developers.
			- See the [`production/`](./production/) directory for guidance on setting up a more serious Mempool instance designed for high performance at scale.