{"id":25521915,"url":"https://github.com/mu373/docker-electrs","last_synced_at":"2025-04-11T01:32:17.625Z","repository":{"id":188181689,"uuid":"678247842","full_name":"mu373/docker-electrs","owner":"mu373","description":"Run electrs on Docker using bitcoind running in a separate container. SSL supported.","archived":false,"fork":false,"pushed_at":"2025-01-20T03:43:50.000Z","size":21,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-24T22:40:48.467Z","etag":null,"topics":["bitcoin","bitcoind","docker","electrs","electrum-server"],"latest_commit_sha":null,"homepage":"","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mu373.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-14T05:31:42.000Z","updated_at":"2025-02-27T15:50:28.000Z","dependencies_parsed_at":null,"dependency_job_id":"b42145bf-1fa9-4776-9e23-c7364784dcae","html_url":"https://github.com/mu373/docker-electrs","commit_stats":null,"previous_names":["mu373/docker-electrs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mu373%2Fdocker-electrs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mu373%2Fdocker-electrs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mu373%2Fdocker-electrs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mu373%2Fdocker-electrs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mu373","download_url":"https://codeload.github.com/mu373/docker-electrs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248324966,"owners_count":21084839,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bitcoin","bitcoind","docker","electrs","electrum-server"],"created_at":"2025-02-19T18:17:35.434Z","updated_at":"2025-04-11T01:32:17.603Z","avatar_url":"https://github.com/mu373.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# docker-electrs\n\nRun [romanz/electrs](https://github.com/romanz/electrs) on Docker using `bitcoind` on a separate container.\n- Original documentation for electrs is available [here](https://github.com/romanz/electrs/blob/a1460ec4a90e45c863c29f66932dd91a0aea9f6f/doc/install.md).\n- For running `bitcoind` on Docker, you can use [mu373/docker-bitcoind](https://github.com/mu373/docker-bitcoind).\n\n## Setup\nSetup `docker-compose.yml` and environment variables\n```sh\ncp docker-compose-template.yml docker-compose.yml\ncp config.sample.toml config.toml\nvim config.toml # Edit the configuration to fit your needs\n```\n\nStart the container\n```sh\n# Make sure to start bitcoind container *before* starting this electrs container\ndocker compose up -d\n```\n\nAccess the shell inside the container\n```sh\n# In host\ndocker ps # Check container id\ndocker exec -it container_id bash\n```\n\nSee logs\n```sh\ndocker logs --tail 100 container_id\n\n# It should show logs something like this\n# Starting electrs 0.10.0 on x86_64 linux with Config { network: Bitcoin, db_path: \"/electrs/data/bitcoin\", daemon_dir: \"/data/.bitcoin\", daemon_auth: UserPass(\"root\", \"\u003csensitive\u003e\"), daemon_rpc_addr: 192.168.128.2:8332, daemon_p2p_addr: 192.168.128.2:8333, electrum_rpc_addr: 127.0.0.1:50001, monitoring_addr: 127.0.0.1:4224, wait_duration: 10s, jsonrpc_timeout: 15s, index_batch_size: 10, index_lookup_limit: None, reindex_last_blocks: 0, auto_reindex: true, ignore_mempool: false, sync_once: false, skip_block_download_wait: false, disable_electrum_rpc: false, server_banner: \"Welcome to electrs 0.10.0 (Electrum Rust Server)!\", signet_magic: e3cdb3a1, args: [] }\n# [2023-08-14T05:16:29.430Z INFO  electrs::metrics::metrics_impl] serving Prometheus metrics on 127.0.0.1:4224\n# [2023-08-14T05:16:29.430Z INFO  electrs::server] serving Electrum RPC on 127.0.0.1:50001\n# ...\n# [2023-08-14T05:36:55.049Z INFO  electrs::index] indexing 2000 blocks: [589681..591680]\n# [2023-08-14T05:37:37.995Z INFO  electrs::chain] chain updated: tip=0000000000000000001eba1320x7f2312b, height=591680\n# [2023-08-14T05:37:37.999Z INFO  electrs::index] indexing 2000 blocks: [591681..593680]\n```\n\n\n## SSL connection\nBy setting your own SSL certificate, electrs can be served through SSL at port 50002. [nginx](https://hub.docker.com/_/nginx) is used as the reverse proxy. If you do not prefer to use SSL, you can simply enable the binding setting for port 50001 in `docker-compose.yml`.\n\n- `/nginx/nginx.conf`\n    - Modified version of the default configuration file\n    - This file is binded to `/etc/nginx/nginx.conf` in the container.\n    - `include /etc/nginx/conf.stream.d/*.conf` has been added to add SSL support to electrs. (c.f. [(link)](https://serverfault.com/questions/1077988/nginx-does-not-open-specified-listen-port) )\n- `/nginx/conf.stream.d/electrs.conf`\n    - Configuration file to add SSL support to electrs.\n    - See the original documentation from romanz/electrs for details [(link)](https://github.com/romanz/electrs/blob/a1460ec4a90e45c863c29f66932dd91a0aea9f6f/doc/config.md#ssl-connection).\n- Install your SSL certificate at the root directory, or change the bind settings in `docker-compose.yml`.\n\n## Usage\nYour electrs node should be available at https://localhost:50002 (when using SSL).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmu373%2Fdocker-electrs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmu373%2Fdocker-electrs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmu373%2Fdocker-electrs/lists"}