|
| 1 | +# OpenSalami ValKey v9 container image |
| 2 | + |
| 3 | +## Note |
| 4 | +This build contains the first Release candidate of Valkey 9.0.0! This is not to be considered production ready! https://github.com/valkey-io/valkey/releases/tag/9.0.0-rc1 |
| 5 | + |
| 6 | +## What is ValKey? |
| 7 | + |
| 8 | +> ValKey is an open source (BSD) high-performance key/value datastore that supports a variety of workloads such as caching, message queues, and can act as a primary database. The project is backed by the Linux Foundation, ensuring it will remain open source forever. |
| 9 | +
|
| 10 | + |
| 11 | + |
| 12 | +## TLDR |
| 13 | +```console |
| 14 | +docker run --name valkey ghcr.io/opensalami/salami-valkey-9:latest |
| 15 | + |
| 16 | +#or |
| 17 | + |
| 18 | +podman run --name valkey ghcr.io/opensalami/salami-valkey-9:latest |
| 19 | + |
| 20 | +``` |
| 21 | + |
| 22 | + |
| 23 | +## Configuration |
| 24 | +We can configure ValKey via Environment Variables: |
| 25 | + |
| 26 | +| Environment variable | Default value | |
| 27 | +|:---------------------|:--------------| |
| 28 | +| VALKEY_DISABLE_COMMANDS | (empty) | |
| 29 | +| VALKEY_DATABASE | valkey | |
| 30 | +| VALKEY_AOF_ENABLED | yes | |
| 31 | +| VALKEY_RDB_POLICY | (empty) | |
| 32 | +| VALKEY_RDB_POLICY_DISABLED | no | |
| 33 | +| VALKEY_PRIMARY_HOST | (empty) | |
| 34 | +| VALKEY_PRIMARY_PORT_NUMBER | 6379 | |
| 35 | +| VALKEY_DEFAULT_PORT_NUMBER | 6379 | |
| 36 | +| VALKEY_PORT_NUMBER | 6379 | |
| 37 | +| VALKEY_ALLOW_REMOTE_CONNECTIONS | yes | |
| 38 | +| VALKEY_REPLICATION_MODE | (empty) | |
| 39 | +| VALKEY_REPLICA_IP | (empty) | |
| 40 | +| VALKEY_REPLICA_PORT | (empty) | |
| 41 | +| VALKEY_EXTRA_FLAGS | (empty) | |
| 42 | +| ALLOW_EMPTY_PASSWORD | no | |
| 43 | +| VALKEY_PASSWORD | (empty) | |
| 44 | +| VALKEY_PRIMARY_PASSWORD | (empty) | |
| 45 | +| VALKEY_ACLFILE | (empty) | |
| 46 | +| VALKEY_IO_THREADS_DO_READS | (empty) | |
| 47 | +| VALKEY_IO_THREADS | (empty) | |
| 48 | +| VALKEY_TLS_ENABLED | no | |
| 49 | +| VALKEY_TLS_PORT_NUMBER | 6379 | |
| 50 | +| VALKEY_TLS_CERT_FILE | (empty) | |
| 51 | +| VALKEY_TLS_CA_DIR | (empty) | |
| 52 | +| VALKEY_TLS_KEY_FILE | (empty) | |
| 53 | +| VALKEY_TLS_KEY_FILE_PASS | (empty) | |
| 54 | +| VALKEY_TLS_CA_FILE | (empty) | |
| 55 | +| VALKEY_TLS_DH_PARAMS_FILE | (empty) | |
| 56 | +| VALKEY_TLS_AUTH_CLIENTS | yes | |
| 57 | +| VALKEY_SENTINEL_PRIMARY_NAME | (empty) | |
| 58 | +| VALKEY_SENTINEL_HOST | (empty) | |
| 59 | +| VALKEY_SENTINEL_PORT_NUMBER | (empty) | |
| 60 | + |
| 61 | +Note: VALKEY_PORT_NUMBER defaults to VALKEY_DEFAULT_PORT_NUMBER (6379). VALKEY_TLS_PORT_NUMBER defaults to VALKEY_TLS_PORT (if set) or 6379. |
| 62 | + |
| 63 | + |
| 64 | + |
0 commit comments