From c65616051cb15af8a09fe4352976d1822dd8629a Mon Sep 17 00:00:00 2001 From: DeedleFake Date: Wed, 27 Oct 2021 14:35:50 -0400 Subject: [PATCH] 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 --- Dockerfile | 4 +--- README.md | 8 +++++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/Dockerfile b/Dockerfile index b329aa9..e3bc248 100644 --- a/Dockerfile +++ b/Dockerfile @@ -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"] \ No newline at end of file diff --git a/README.md b/README.md index 43534dd..705cc90 100644 --- a/README.md +++ b/README.md @@ -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/ \ No newline at end of file