Skip to content

Commit c656160

Browse files
authored
doc, docker: some minor changes to the README and Dockerfile (#22)
* meta: update README.md with information more suited to the new SQL backend * docker: remove BoltDB-related configuration from the Dockerfile
1 parent 7d14bdd commit c656160

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

Dockerfile

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,8 @@ FROM scratch
1212
COPY --from=build /build/sips /sips
1313
COPY --from=build /build/sipsctl /sipsctl
1414

15-
ENV XDG_CONFIG_HOME /data
1615
ENV PATH /
1716

1817
EXPOSE 8080
19-
VOLUME /data/sips
2018

21-
CMD ["sips"]
19+
CMD ["sips"]

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,15 @@ SIPS is a Simple IPFS Pinning Service. It does the bare minimum necessary to pre
1111
Setup
1212
-----
1313

14+
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.
15+
1416
After installation, SIPS will have no users or tokens in its database. To create some, use the `sipsctl` utility that is provided:
1517

1618
```bash
17-
$ sipsctl users add whateverUsernameYouWant
18-
$ sipsctl tokens add --user whateverUsernameYouWant
19+
$ sipsctl users add -db "$DATABASE_URL" whateverUsernameYouWant
20+
$ sipsctl tokens add -db "$DATABASE_URL" --user whateverUsernameYouWant
1921
```
2022

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

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

0 commit comments

Comments
 (0)