{"id":15190444,"url":"https://github.com/stackzoo/voltbot","last_synced_at":"2025-10-27T14:30:20.964Z","repository":{"id":213062542,"uuid":"732726958","full_name":"stackzoo/voltbot","owner":"stackzoo","description":"Lightning node bot ⚡🤖","archived":false,"fork":false,"pushed_at":"2024-01-08T15:11:39.000Z","size":1493,"stargazers_count":10,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2024-09-28T20:23:27.789Z","etag":null,"topics":["automation","bitcoin","bot","golang","lightning-network","lnd","slack"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"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/stackzoo.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-17T16:30:10.000Z","updated_at":"2024-01-16T17:00:24.000Z","dependencies_parsed_at":"2024-09-18T17:04:23.711Z","dependency_job_id":null,"html_url":"https://github.com/stackzoo/voltbot","commit_stats":{"total_commits":18,"total_committers":2,"mean_commits":9.0,"dds":"0.11111111111111116","last_synced_commit":"3752a65ee4a192edb77c5aa1fcf76cb5b955a3ad"},"previous_names":["stackzoo/voltbot"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackzoo%2Fvoltbot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackzoo%2Fvoltbot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackzoo%2Fvoltbot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackzoo%2Fvoltbot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stackzoo","download_url":"https://codeload.github.com/stackzoo/voltbot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219861215,"owners_count":16556006,"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":["automation","bitcoin","bot","golang","lightning-network","lnd","slack"],"created_at":"2024-09-27T20:23:23.607Z","updated_at":"2025-10-27T14:30:20.555Z","avatar_url":"https://github.com/stackzoo.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# VOLTBOT\n[![oci](https://github.com/stackzoo/voltbot/actions/workflows/oci.yaml/badge.svg)](https://github.com/stackzoo/voltbot/actions/workflows/oci.yaml)\n[![Latest Release](https://img.shields.io/github/release/stackzoo/voltbot.svg)](https://github.com/stackzoo/voltbot/releases/latest)\n[![Go Report Card](https://goreportcard.com/badge/github.com/stackzoo/voltbot)](https://goreportcard.com/report/github.com/stackzoo/voltbot)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)  \n\u003cimg src=\"images/voltbot-logo-nobg.png\" alt=\"logo\" width=\"160\"/\u003e\n\nLightning node bot ⚡🤖\n\n### Supported Products\n\n- [Slack](https://slack.com/)\n\n### Supported Lightning Nodes Implementations\n\n- [LND](https://github.com/lightningnetwork/lnd)\n\n## Abstract\nVoltbot is a lightweight bot that retrieves lightning node stats and send them via different channels.  \nThis can be beneficial for monitoring node instances.  \nVoltbot communicates with the *LND* instance through [gRPC](https://grpc.io/).  \n\n\n\n## Instructions\n\nTo operate, the bot requires reading configuration data from a JSON file.  \nThe configuration file must be located within the `config` folder at the root directory and must be named `voltbot_config.json`.  \nYou can take a look at the example file inside the `config` folder:  \n```json\n{\n    \"lnd_node_endpoint\": \"\u003cnode-endpoint:port\u003e\",\n    \"lnd_node_tls_cert_path\": \"config/tls.cert\",\n    \"lnd_node_macaroon_hex_path\": \"config/macaroon.hex\",\n    \"slack_channel_id\": \"\u003cslack-channel-id\u003e\",\n    \"slack_token\": \"\u003cslack-token\u003e\"\n}\n```  \nAt present, the retrieval of statistics is hard-coded to occur every *360 minutes* (6 hours).  \n\n### Run with docker\nThe project includes a GitHub Action that publishes an OCI image (container) to the GitHub registry when a new version is tagged.  \nConsequently, it is possible to run the project directly as a container.  \n  \n  \nPull the image:  \n```console\ndocker pull ghcr.io/stackzoo/voltbot:0.0.5\n```  \nAnd the run the container by mapping the local folder that contains the configuration files:  \n```console\ndocker run -v \"/your/local/config/path/config:/config\" ghcr.io/stackzoo/voltbot:0.0.5\n```  \n\n\u003e[!Note]\n\u003e You can also pull the Image compiled for ARM architecture, for example if you want to run the bot on a raspberry pi or another edge device.  \n\u003e In order to do that you just need to use the \"-arm\" tag, for example: `docker pull ghcr.io/stackzoo/voltbot:0.0.5-arm`  \n\nAll the published Images can be found [here](https://github.com/stackzoo/voltbot/pkgs/container/voltbot).\n\n\n## Example\n\n\u003cimg src=\"images/slack-message.png\" alt=\"logo\" width=\"900\"/\u003e\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackzoo%2Fvoltbot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstackzoo%2Fvoltbot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackzoo%2Fvoltbot/lists"}