Skip to content

Commit

Permalink
Adds Docket-hub Doc and Description (#4)
Browse files Browse the repository at this point in the history
* Addes Dockethub Docs and Description

---------

Signed-off-by: Roshan Khatri <[email protected]>
  • Loading branch information
roshkhatri authored Apr 6, 2024
1 parent a17ef72 commit 27d1812
Show file tree
Hide file tree
Showing 2 changed files with 93 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/update-dockerhub-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Update Dockerhub description

on:
push:
workflow_dispatch:

jobs:
update-dockerhub:
name: Update Dockerhub description
permissions:
contents: read
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Docker Hub Description
uses: peter-evans/dockerhub-description@v4
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
repository: ${{ secrets.DOCKERHUB_USERNAME }}/valkey
readme-filepath: ./dockerhub-description.md
short-description: 'Valkey is a high-performance data structure server that primarily serves key/value workloads.'
70 changes: 70 additions & 0 deletions dockerhub-description.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Quick reference

- **Maintained by**:
[the Valkey Community](https://github.com/valkey-io/valkey-container)

- **Where to get help**:
Please open an Issue stating your question on [the Valkey Community](https://github.com/valkey-io/valkey-container/issues).

# Supported tags and respective `Dockerfile` links
- [`unstable`](https://github.com/valkey-io/valkey-container/blob/master/unstable/debian/Dockerfile)
- [`unstable-alpine`](https://github.com/valkey-io/valkey-container/blob/master/unstable/alpine/Dockerfile)

What is [Valkey](https://github.com/valkey-io/valkey)?
--------------
Valkey is a high-performance data structure server that primarily serves key/value workloads.
It supports a wide range of native structures and an extensible plugin system for adding new data structures and access patterns.

# Security

For the ease of accessing Valkey from other containers via Docker networking, the "Protected mode" is turned off by default. This means that if you expose the port outside of your host (e.g., via `-p` on `docker run`), it will be open without a password to anyone. It is **highly** recommended to set a password (by supplying a config file) if you plan on exposing your Valkey instance to the internet.

# How to use this image

## start a valkey instance

```console
$ docker run --name some-valkey -d valkey/valkey:unstable
```

## start with persistent storage

```console
$ docker run --name some-valkey -d valkey/valkey:unstable valkey-server --save 60 1 --loglevel warning
```

There are several different persistence strategies to choose from. This one will save a snapshot of the DB every 60 seconds if at least 1 write operation was performed (it will also lead to more logs, so the `loglevel` option may be desirable). If persistence is enabled, data is stored in the `VOLUME /data`, which can be used with `--volumes-from some-volume-container` or `-v /docker/host/dir:/data` (see [docs.docker volumes](https://docs.docker.com/engine/tutorials/dockervolumes/)).

## connecting via `valkey-cli`

```console
$ docker run -it --network some-network --rm valkey/valkey:unstable valkey-cli -h some-valkey
```

## Additionally, If you want to use your own valkey.conf ...

You can create your own Dockerfile that adds a valkey.conf from the context into /data/, like so.

```dockerfile
FROM valkey
COPY valkey.conf /usr/local/etc/valkey/valkey.conf
CMD [ "valkey-server", "/usr/local/etc/valkey/valkey.conf" ]
```

Alternatively, you can specify something along the same lines with `docker run` options.

```console
$ docker run -v /myvalkey/conf:/usr/local/etc/valkey --name myvalkey valkey/valkey:unstable valkey-server /usr/local/etc/valkey/valkey.conf
```

Where `/myvalkey/conf/` is a local directory containing your `valkey.conf` file. Using this method means that there is no need for you to have a Dockerfile for your valkey container.

The mapped directory should be writable, as depending on the configuration and mode of operation, Valkey may need to create additional configuration files or rewrite existing ones.

# License

View [license information](https://github.com/valkey-io/valkey/blob/unstable/COPYING) for the software contained in this image.

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.

0 comments on commit 27d1812

Please sign in to comment.