Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wabarc/ipfs-pinner
A toolkit helps upload files to IPFS pinning services.
https://github.com/wabarc/ipfs-pinner
file-sharing infura ipfs ipfs-pinner ipfs-pinning-services nft nftstorage pinata web3 web3storage
Last synced: 2 months ago
JSON representation
A toolkit helps upload files to IPFS pinning services.
- Host: GitHub
- URL: https://github.com/wabarc/ipfs-pinner
- Owner: wabarc
- License: gpl-3.0
- Created: 2020-07-18T16:58:04.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-14T03:13:19.000Z (4 months ago)
- Last Synced: 2024-10-19T23:31:23.535Z (3 months ago)
- Topics: file-sharing, infura, ipfs, ipfs-pinner, ipfs-pinning-services, nft, nftstorage, pinata, web3, web3storage
- Language: Go
- Homepage:
- Size: 125 KB
- Stars: 57
- Watchers: 5
- Forks: 16
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ccamel - wabarc/ipfs-pinner - A toolkit helps upload files to IPFS pinning services. (Go)
README
# ipfs-pinner
[](https://goreportcard.com/report/github.com/wabarc/ipfs-pinner)
[](https://pkg.go.dev/github.com/wabarc/ipfs-pinner)
[](https://github.com/wabarc/ipfs-pinner/releases)
[](https://snapcraft.io/ipfs-pinner)
`ipfs-pinner` is a toolkit to help upload files or specific content id to IPFS pinning services.
Supported Golang version: See [.github/workflows/testing.yml](./.github/workflows/testing.yml)
## Installation
Via Golang package get command
```sh
go get -u github.com/wabarc/ipfs-pinner/cmd/ipfs-pinner
```
Using [Snapcraft](https://snapcraft.io/ipfs-pinner) (on GNU/Linux)
```sh
snap install ipfs-pinner
```
## Usage
### Supported Pinning Services
#### [Infura](https://infura.io)
Infura is a freemium pinning service that doesn't require any additional setup.
It's the default one used. Please bear in mind that Infura is a free service,
so there is probably a rate-limiting.
##### How to enable
Command-line:
Use flag `-p infura`.
```sh
$ ipfs-pinner
A CLI tool for pin files or directory to IPFS.
Usage:
ipfs-pinner [flags] [path]...
Flags:
-p string
Pinner sceret or password.
-t string
IPFS pinner, supports pinners: infura, pinata, nftstorage, web3storage. (default "infura")
-u string
Pinner apikey or username.
```
Go package:
```go
import (
"fmt"
"github.com/wabarc/ipfs-pinner/pkg/infura"
)
func main() {
cid, err := infura.PinFile("file-to-path");
if err != nil {
fmt.Sprintln(err)
return
}
fmt.Println(cid)
}
```
or requests with project authentication
```go
import (
"fmt"
"github.com/wabarc/ipfs-pinner/pkg/infura"
)
func main() {
inf := &infura.Infura{ProjectID: "your-project-id", ProjectSecret: "your-project-secret"}
cid, err := inf.PinFile("file-to-path");
if err != nil {
fmt.Sprintln(err)
return
}
fmt.Println(cid)
}
```
#### [Pinata](https://pinata.cloud)
Pinata is another freemium pinning service. It gives you more control over
what's uploaded. You can delete, label and add custom metadata. This service
requires signup.
##### Environment variables
Unix*:
```sh
IPFS_PINNER_PINATA_API_KEY=
IPFS_PINNER_PINATA_SECRET_API_KEY=
```
Windows:
```sh
set IPFS_PINNER_PINATA_API_KEY=
set IPFS_PINNER_PINATA_SECRET_API_KEY=
```
##### How to enable
Command-line:
Use flag `-p pinata`.
```sh
ipfs-pinner -p pinata file-to-path
```
Go package:
```go
import (
"fmt"
"github.com/wabarc/ipfs-pinner/pkg/pinata"
)
func main() {
pnt := pinata.Pinata{Apikey: "your api key", Secret: "your secret key"}
cid, err := pnt.PinFile("file-to-path");
if err != nil {
fmt.Sprintln(err)
return
}
fmt.Println(cid)
}
```
#### [NFT.Storage](https://nft.storage)
NFT.Storage is a long-term storage service designed for off-chain NFT data
(like metadata, images, and other assets) for up to 31GiB in size. Data is
content addressed using IPFS, meaning the URL pointing to a piece of data
(“ipfs://…”) is completely unique to that data.
##### How to enable
Command-line:
Use flag `-p nftstorage`.
```sh
ipfs-pinner -p nftstorage file-to-path
```
Go package:
```go
import (
"fmt"
"github.com/wabarc/ipfs-pinner/pkg/nftstorage"
)
func main() {
nft := nftstorage.NFTStorage{Apikey: "your api key"}
cid, err := nft.PinFile("file-to-path");
if err != nil {
fmt.Sprintln(err)
return
}
fmt.Println(cid)
}
```
#### [Web3.Storage](https://web3.storage)
Web3.Storage is a service to make building on top of Filecoin as simple as
possible - giving the developers the power of open, distributed networks via
a friendly JS client library. Behind the scenes, Web3.Storage is backed by
Filecoin and makes content available via IPFS leveraging the unique
properties of each network.
##### How to enable
Command-line:
Use flag `-p web3storage`.
```sh
ipfs-pinner -p web3storage file-to-path
```
Go package:
```go
import (
"fmt"
"github.com/wabarc/ipfs-pinner/pkg/web3storage"
)
func main() {
web3 := web3storage.Web3Storage{Apikey: "your api key"}
cid, err := web3.PinFile("file-to-path");
if err != nil {
fmt.Sprintln(err)
return
}
fmt.Println(cid)
}
```
## License
Permissive GPL 3.0 license, see the [LICENSE](https://github.com/wabarc/ipfs-pinner/blob/main/LICENSE) file for details.