https://github.com/ceramicnetwork/go-ipfs-healthcheck
https://github.com/ceramicnetwork/go-ipfs-healthcheck
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ceramicnetwork/go-ipfs-healthcheck
- Owner: ceramicnetwork
- Created: 2021-10-16T20:09:40.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-07-27T01:19:07.000Z (almost 3 years ago)
- Last Synced: 2025-01-20T23:06:57.109Z (over 1 year ago)
- Language: Go
- Size: 255 KB
- Stars: 3
- Watchers: 5
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# go-ipfs-healthcheck
A plugin for [kubo](https://github.com/ipfs/kubo) that serves a healthcheck endpoint which returns the status of the IPFS node.
# Installation
This is a preloaded plugin built in-tree into go-ipfs when it's compiled.
```sh
git clone https://github.com/ipfs/kubo
cd kubo
# Pull in the plugin (you can specify a version other than "latest" if you'd like)
go get github.com/ceramicnetwork/go-ipfs-healthcheck/plugin@latest
# Add the plugin to the [preload list](https://github.com/ipfs/go-ipfs/blob/master/docs/plugins.md#preloaded-plugins)
echo "\nhealthcheck github.com/ceramicnetwork/go-ipfs-healthcheck/plugin 0" >> plugin/loader/preload_list
# Download dependencies
go mod download
# Build go-ipfs with the plugin
make build
# If an error occurs, try
go mod tidy
make build
```
# Usage
Run Kubo IPFS node and check its status.
```sh
./cmd/ipfs/ipfs daemon
curl -X GET http://localhost:8011
```
# Future work
- [ ] Use `ipfs dag stat` for healthcheck endpoint (See https://github.com/ipfs/go-ipfs/pull/8429/files)
# Resources
[Kubo Plugins](https://github.com/ipfs/kubo/blob/master/docs/plugins.md)
# Maintainers
[@v-stickykeys](https://github.com/v-stickykeys)
# License
Fully open source and dual-licensed under MIT and Apache 2.