https://github.com/deedlefake/sips

A Simple IPFS Pinning Service
https://github.com/deedlefake/sips

golang hacktoberfest ipfs

Last synced: 2 months ago
JSON representation

A Simple IPFS Pinning Service

• Host: GitHub
• URL: https://github.com/deedlefake/sips
• Owner: DeedleFake
• License: mit
• Created: 2021-03-02T04:30:53.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-08-22T04:03:36.000Z (5 months ago)
• Last Synced: 2024-08-22T05:22:59.126Z (5 months ago)
• Topics: golang, hacktoberfest, ipfs
• Language: Go
• Homepage:
• Size: 168 KB
• Stars: 21
• Watchers: 4
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
SIPS

====

[![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/DeedleFake/sips)](https://pkg.go.dev/github.com/DeedleFake/sips)

[![Go Report Card](https://goreportcard.com/badge/github.com/DeedleFake/sips)](https://goreportcard.com/report/github.com/DeedleFake/sips)

*Disclaimer: SIPS is still in early development and is not guaranteed to do much of anything. Although it should function for basic usage, expect bugs, and definitely don't use it for anything that has money associated with it.*

SIPS is a Simple IPFS Pinning Service. It does the bare minimum necessary to present a functional [pinning service][pinning-service-api].

Setup

-----

SIPS is capable of using either Postgres or SQLite3 as its backend. By default only Postgres is available, but the `sqlite3` build tag will add support for SQLite3.

After installation, SIPS will have no users or tokens in its database. To create some, use the `sipsctl` utility that is provided:

```bash

$ sipsctl users add -db "$DATABASE_URL" whateverUsernameYouWant

$ sipsctl tokens add -db "$DATABASE_URL" --user whateverUsernameYouWant

```

You can then use that token with a pinning service client to add, remove, and list pins.

[pinning-service-api]: https://ipfs.github.io/pinning-services-api-spec/