Add docker compose for one step setup with testnet #1000
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
romanz
reviewed
Mar 17, 2024
README.md
Outdated
| @@ -28,25 +27,26 @@ If you can't use our guide, please ask about what you don't understand or consid | |||
| Note that this implementation of Electrum server is optimized for **personal/small-scale (family/friends) usage**. | |||
| It's a bad idea to run it publicly as it'd expose you to DoS and maybe also other attacks. | |||
| If you want to run a public server you may be interested in the [Blockstream fork of electrs](https://github.com/Blockstream/electrs) | |||
| which is better optimized for public usage at the cost of consuming *significantly* more resources. | |||
| which is better optimized for public usage at the cost of consuming _significantly_ more resources. | |||
There was a problem hiding this comment.
Oh, no, that's just my editor's auto-format plugin changed it while save the file. I'll remove this change, soon.
| -zmqpubrawtx=tcp://0.0.0.0:28335 -zmqpubhashblock=tcp://0.0.0.0:28336 | ||
| -txindex=1 -rpcbind=0.0.0.0 -rpcallowip=0.0.0.0/0 | ||
| -rpcport=18332 -rest -listen=1 -listenonion=0 | ||
| -rpcauth=alice:128f22494cc2208ea8376a3d0b45a131$9cc0187c0e49f35454a3ed1250e40ecaef420cfcd294d3ac22496adbe64f04b9 |
There was a problem hiding this comment.
Is it possible to not use a constant rpcauth?
There was a problem hiding this comment.
I'm using this constant rpcauth just for easy use. Others may delete it and generate their own rpcauth via rpcauth.py, put it to ./bitcoind/bitcoin.conf and change the line auth = "alice:alice" in conf.toml to their own config.
Also, if you want to using cookie file to auth, there's a way to do it:
- you can remove the
rpcauthconfig - append one line in
docker-compose.ymlin[electrs] > volumessection:- ./cookie:/electrs/.cookie - adjust the
conf.tomlfile, i.e. comment out therpcauthline, un-commentcookie_fileand set it's value to/electrs/.cookie - start with
docker compose up -d, this command will only start bitcoind, but not electrs - copy the bitcoind's cookie file's content to
./cookiefile:cat ./bitcoind/testnet3/.cookie > cookie - rebuild electrs with
docker compose up -d --build --no-deps electrs
But i thought it's kind complicate, most people just want one-click to use it.
| @@ -0,0 +1,45 @@ | |||
| version: "3" | |||
| services: | |||
There was a problem hiding this comment.
Suggested change
| services: | |
| services: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It's not easy to setup using rpcauth to connect to bitcoin core, so i just make it much easier for testnet setup. Hope that helps those who want to deploy an testnet with electrs quickly, just one command (
docker compose up -d)