{"id":13499274,"url":"https://github.com/bajohns/lightning-in-a-box","last_synced_at":"2025-12-30T05:26:43.546Z","repository":{"id":138546267,"uuid":"119149857","full_name":"bajohns/lightning-in-a-box","owner":"bajohns","description":"To get on the Lightning network, now.","archived":false,"fork":false,"pushed_at":"2018-05-28T01:00:35.000Z","size":18,"stargazers_count":12,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-31T17:39:22.591Z","etag":null,"topics":["bitcoin","docker","lightning-network"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bajohns.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2018-01-27T09:15:15.000Z","updated_at":"2023-04-22T13:43:35.000Z","dependencies_parsed_at":"2024-01-14T03:50:54.554Z","dependency_job_id":"8c28fb44-d4f7-4492-ba7d-1d8620c7e07d","html_url":"https://github.com/bajohns/lightning-in-a-box","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bajohns%2Flightning-in-a-box","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bajohns%2Flightning-in-a-box/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bajohns%2Flightning-in-a-box/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bajohns%2Flightning-in-a-box/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bajohns","download_url":"https://codeload.github.com/bajohns/lightning-in-a-box/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246140565,"owners_count":20729797,"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","docker","lightning-network"],"created_at":"2024-07-31T22:00:31.755Z","updated_at":"2025-12-30T05:26:43.518Z","avatar_url":"https://github.com/bajohns.png","language":"Shell","funding_links":[],"categories":["Developer Resources"],"sub_categories":["Misc"],"readme":"## lightning-in-a-box\n\n`tl;dr: ./start.sh`\n\nThis project aims to be a single-command launch for lnd/btcd on testnet (for now). It requires some understanding of Docker to use and is tailored for a Unix for now.\n\nIf you want to run lightning on command-line; try it out!\n\n_Note_: The Lightning testnet is alpha software and always in flux. Be aware that updating your node can require clearing all local data (sometimes including wallets).\n\n### Setup (docker)\n\nYou need docker \u0026 docker-compose. If you have OSX then just run `brew bundle` as this repo has a Brewfile.\n\n### Usage\n\n#### lnd\n\nOnce docker is installed just execute `./start.sh` and you are off. This script is a very small wrapper around docker-compose. You should see docker-compose build lnd and then start the lnd container.\n\nA few things have to happen for you to start making channels:\n\n* Docker must build the container(s) including a build of lnd from source. This is done on purpose so that everyone can see the code that will be running.\n* LND must sync its filter chain. By default lnd must retrieve the filter chain from a compatible btcd node. This repo uses the community full node @ [faucet.lightning.community](faucet.lightning.community)\n* LND must connect with peers on the network to create channels and route payments. This will only happen after the filter chain sync.\n\n_Depending on your internet speed this can take awhile_\n\n#### lncli\n\nThe primary way to work with lnd is through the accompanying `lncli`. This is built along side the daemon but its in the container. To eliminate the need for jumping in the container to work there are wrapper scripts in the `bin` directory.\n\n`./bin/lncli` executes commands against your lnd as if it was native.\n\nYou will know your lnd is ready to go when it reports back `synced_to_chain`.\n\n```\n\u003e ./bin/lncli getinfo\n{\n    \"identity_pubkey\": \"0318d4c7aff98202fa7ab4bb3a45198fe78a691834b391cf542eaea875e745641d\",\n    \"alias\": \"0318d4c7aff98202fa7a\",\n    \"num_pending_channels\": 0,\n    \"num_active_channels\": 4,\n    \"num_peers\": 5,\n    \"block_height\": 1261956,\n    \"block_hash\": \"000000000005c17f47d70b692ec5a72c8b511016e2bedc42c3ea1014ebb4ff6f\",\n    \"synced_to_chain\": true,\n    \"testnet\": true,\n    \"chains\": [\n        \"bitcoin\"\n    ],\n    \"uris\": [\n    ]\n}\n```\n\n### Next steps\n\nIf you are looking for more resources on lnd - like how to open a channel - check out the official docs on the [lnd repo](https://github.com/lightningnetwork/lnd).\n\nAlso, if you are familiar with docker-compose you will see this repo contains btcd and bitcoind. There is more to come....\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbajohns%2Flightning-in-a-box","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbajohns%2Flightning-in-a-box","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbajohns%2Flightning-in-a-box/lists"}