https://github.com/ipfs/helia-remote-pinning

A library that helps Helia consumers pin content via the https://ipfs.github.io/pinning-services-api-spec/. Initial design at https://pl-strflt.notion.site/create-interface-API-example-for-helia-remote-pinning-library-71011845a7b9476cb95ab425bb54455c
https://github.com/ipfs/helia-remote-pinning

helia ipfs ipfs-helia typescript-library

Last synced: 14 days ago
JSON representation

A library that helps Helia consumers pin content via the https://ipfs.github.io/pinning-services-api-spec/. Initial design at https://pl-strflt.notion.site/create-interface-API-example-for-helia-remote-pinning-library-71011845a7b9476cb95ab425bb54455c

• Host: GitHub
• URL: https://github.com/ipfs/helia-remote-pinning
• Owner: ipfs
• License: other
• Created: 2023-08-04T01:10:41.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-20T11:10:57.000Z (11 months ago)
• Last Synced: 2025-01-14T11:59:54.487Z (9 months ago)
• Topics: helia, ipfs, ipfs-helia, typescript-library
• Language: TypeScript
• Homepage:
• Size: 176 KB
• Stars: 7
• Watchers: 8
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  

    

  



# @helia/remote-pinning

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)

[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)

[![codecov](https://img.shields.io/codecov/c/github/ipfs/helia-remote-pinning.svg?style=flat-square)](https://codecov.io/gh/ipfs/helia-remote-pinning)

[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/helia-remote-pinning/js-test-and-release.yml?branch=main\&style=flat-square)](https://github.com/ipfs/helia-remote-pinning/actions/workflows/js-test-and-release.yml?query=branch%3Amain)

> A IPFS Pinning Service API implementation powered by Helia

## About

This repo contains a server implementation of the [IPFS Pinning Service API](https://ipfs.github.io/pinning-services-api-spec/) spec along with a client that can be used to interact with any compliant server implementation.

# Packages

- [`packages/client`](https://github.com/ipfs/helia-remote-pinning/tree/main/packages/client) Add remote pinning capabilities to Helia

- [`packages/interop`](https://github.com/ipfs/helia-remote-pinning/tree/main/packages/interop) Interop tests for the IPFS Pinning Service API client and server powered by Helia

- [`packages/server`](https://github.com/ipfs/helia-remote-pinning/tree/main/packages/server) An IPFS Pinning Service API server powered by Helia

# API Docs

- 

# License

Licensed under either of

- Apache 2.0, ([LICENSE-APACHE](https://github.com/ipfs/helia-remote-pinning/blob/main/LICENSE-APACHE) / )

- MIT ([LICENSE-MIT](https://github.com/ipfs/helia-remote-pinning/blob/main/LICENSE-MIT) / )

# Contribute

Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia-remote-pinning/issues).

Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.

Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)