Skip to content

Commit 89a33fc

Browse files
authored
chore: final pre-release updates (#20)
1 parent 7e77d08 commit 89a33fc

File tree

3 files changed

+21
-9
lines changed

3 files changed

+21
-9
lines changed

.github/workflows/ci.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ jobs:
1717
strategy:
1818
matrix:
1919
os: [ubuntu-latest, macos-latest, windows-latest]
20+
fail-fast: false
2021

2122
steps:
2223
- uses: actions/checkout@v3
@@ -30,7 +31,7 @@ jobs:
3031
uses: arduino/setup-protoc@v2
3132
with:
3233
version: "21.12"
33-
token: ${{ secrets.GITHUB_TOKEN }}
34+
repo-token: ${{ secrets.GITHUB_TOKEN }}
3435

3536
- name: Check formatting
3637
run: cargo fmt -- --check
@@ -102,4 +103,5 @@ jobs:
102103
cargo publish -vv -p denokv_proto
103104
cargo publish -vv -p denokv_sqlite
104105
cargo publish -vv -p denokv_remote
106+
cargo publish -vv -p denokv_timemachine
105107
cargo publish -vv -p denokv

Dockerfile

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,5 @@ LABEL org.opencontainers.image.licenses=MIT
1515

1616
COPY --from=builder /usr/src/denokv/target/release/denokv /usr/local/bin/
1717

18-
ENTRYPOINT ["/usr/local/bin/denokv"]
18+
ENTRYPOINT ["/usr/local/bin/denokv"]
19+
CMD ["serve"]

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Then run the `denokv` Docker image, mounting the `/data` directory as a volume
6969
and specifying a random access token.
7070

7171
```sh
72-
docker run -it --init -p 4512:4512 -v ./data:/data ghcr.io/denoland/denokv --sqlite-path /data/denokv.sqlite serve --access-token <random-token>
72+
docker run -it --init -p 4512:4512 -v ./data:/data ghcr.io/denoland/denokv serve --sqlite-path /data/denokv.sqlite --access-token <random-token>
7373
```
7474

7575
You can now access the database from your Deno programs by specifying the access
@@ -142,6 +142,14 @@ period of inactivity will be slow, as the database needs to be started. You can
142142
avoid this by setting `min_machines_running` to `1`, and setting
143143
`auto_stop_machines = false`.
144144

145+
### Install binary
146+
147+
You can download a prebuilt binary from the
148+
[releases page](https://github.com/denoland/denokv/releases/tag/0.1.0) and place
149+
it in your `PATH`.
150+
151+
You can also compile from source by running `cargo install denokv --locked`.
152+
145153
## How to connect
146154

147155
### Deno
@@ -155,9 +163,14 @@ const kv = await Deno.openKv("http://localhost:4512");
155163
Make sure to specify your access token in the `DENO_KV_ACCESS_TOKEN` environment
156164
variable.
157165

158-
## Running as a replica of a hosted KV database
166+
<!-- TBD: ### Node.js -->
167+
168+
## Advanced setup
169+
170+
### Running as a replica of a hosted KV database
159171

160-
`denokv` has a mode for running as a replica of a KV database hosted on Deno Deploy through the S3 backup feature.
172+
`denokv` has a mode for running as a replica of a KV database hosted on Deno
173+
Deploy through the S3 backup feature.
161174

162175
To run as a replica:
163176

@@ -188,10 +201,6 @@ To checkout the snapshot at a specific recoverable point:
188201
denokv --sqlite-path /data/denokv.sqlite pitr checkout 0100000002c0f4c10000
189202
```
190203

191-
<!-- TBD: ### Node.js -->
192-
193-
## Advanced setup
194-
195204
### Continuous backup using LiteFS
196205

197206
TODO

0 commit comments

Comments
 (0)