Categorygithub.com/DeedleFake/sips
modulepackage
0.3.0
Repository: https://github.com/deedlefake/sips.git
Documentation: pkg.go.dev

# README

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.

# Packages

No description provided by the author
No description provided by the author
No description provided by the author

# Functions

Handler returns a new HTTP handler that uses h to handle pinning service requests.
Token returns the auth token associated with the context.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

Pin describes a single pinned item.
PinQuery provides query info for finding pinning requests.
PinStatus indicates the status of a pinning request and provides associated info.

# Interfaces

PinHandler is an interface satisfied by types that can be used to handle pinning service requests.
StatusError is implemented by errors returned by PinHandler implementations that want to send custom status codes to the client.

# Type aliases

RequestStatus is the status of a given pinning request.
TextMatchingStrategy indicates a strategy to use for matching one string against another.