https://github.com/chancehudson/cidhookd

A webhook server for pinning ipfs cids
https://github.com/chancehudson/cidhookd

Last synced: over 1 year ago
JSON representation

A webhook server for pinning ipfs cids

• Host: GitHub
• URL: https://github.com/chancehudson/cidhookd
• Owner: chancehudson
• Created: 2019-01-11T08:39:47.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-01-31T10:38:33.000Z (over 7 years ago)
• Last Synced: 2024-07-21T00:41:10.657Z (about 2 years ago)
• Language: JavaScript
• Size: 838 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# cidhookd [![Build Status](https://travis-ci.org/JChanceHud/cidhookd.svg?branch=master)](https://travis-ci.org/JChanceHud/cidhookd) [![](https://img.shields.io/npm/v/cidhookd.svg)](https://www.npmjs.com/package/cidhookd)

A server for easily pinning IPFS cids from ephemeral IPFS nodes (like on CI, local machine, etc).

## Install

Install the server with `npm install -g cidhookd`.

## Usage

Once installed the server can be run with the `cidhookd` command.

The docker image [`jchancehud/cidhookd`](https://cloud.docker.com/u/jchancehud/repository/docker/jchancehud/cidhook) can also be used.

## API

`cidhookd` http servers have 2 endpoints:

- `/:cid` - `POST` - Pins the supplied IPFS cid

- `/:cid` - `DELETE` - Unpins the supplied IPFS cid

The `cidhookd` server runs a [`jsipfs`](https://github.com/ipfs/js-ipfs) node with requested content pinned.

### CLI

The [`cidhook`](https://github.com/jchancehud/cidhook) package can be used to interact with `cidhookd` servers.

## License

MIT