Skip to content

DeedleFake/sips

Repository files navigation

SIPS

GitHub tag (latest SemVer) Go Report Card

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.

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:

$ 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.