Skip to content

Commit

Permalink
doc, docker: some minor changes to the README and Dockerfile (#22)
Browse files Browse the repository at this point in the history
* meta: update README.md with information more suited to the new SQL backend

* docker: remove BoltDB-related configuration from the Dockerfile
  • Loading branch information
DeedleFake authored Oct 27, 2021
1 parent 7d14bdd commit c656160
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 1 addition & 3 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,8 @@ FROM scratch
COPY --from=build /build/sips /sips
COPY --from=build /build/sipsctl /sipsctl

ENV XDG_CONFIG_HOME /data
ENV PATH /

EXPOSE 8080
VOLUME /data/sips

CMD ["sips"]
CMD ["sips"]
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,15 @@ SIPS is a Simple IPFS Pinning Service. It does the bare minimum necessary to pre
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 whateverUsernameYouWant
$ sipsctl tokens add --user whateverUsernameYouWant
$ 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/
[pinning-service-api]: https://ipfs.github.io/pinning-services-api-spec/

0 comments on commit c656160

Please sign in to comment.