valkey-container - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #golang #android #deep-learning #macos #windows #cli #kubernetes #awesome-list #security

valkey-container

(★ 198)

valkey-container

File Explorer

Download Latest Version (.zip)

- - ci.yml
  - update-descriptions.yml
  - verify-templating.yml
- dependabot.yaml
- - docker-build.sh
  - image-name.sh
- config.sh
- LICENSE
- README
- retry.sh
- - docker-entrypoint.sh
  - Dockerfile
- - docker-entrypoint.sh
  - Dockerfile
- - docker-entrypoint.sh
  - Dockerfile
- - docker-entrypoint.sh
  - Dockerfile
- - docker-entrypoint.sh
  - Dockerfile
- - docker-entrypoint.sh
  - Dockerfile
- - docker-entrypoint.sh
  - Dockerfile
- - docker-entrypoint.sh
  - Dockerfile
- - docker-entrypoint.sh
  - Dockerfile
- - docker-entrypoint.sh
  - Dockerfile
- - docker-entrypoint.sh
  - Dockerfile
- - docker-entrypoint.sh
  - Dockerfile
.gitattributes
.gitignore
apply-templates.sh
description-template.md
docker-entrypoint.sh
Dockerfile.template
generate-repo-description.py
generate-stackbrew-library.sh
LICENSE
README.md
update.sh
valkey-sbom.jq
versions.json
versions.sh

# Installation Guide

1. Get the code

git clone https://github.com/valkey-io/valkey-container

Downloads the entire project code from GitHub to your computer.

cd valkey-container

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.

docker build -f 7.2/alpine/Dockerfile -t valkey-container .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 valkey-container

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# valkey-container

This Project is the Git repo of Valkey "Official Images" on [Dockerhub](https://hub.docker.com/r/valkey/valkey/) and [GitHub Container Registry](https://ghcr.io/valkey-io/valkey).

The Project is now maintained by [the Valkey Community](https://github.com/valkey-io/valkey/)
and it was forked from [docker-library/redis](https://github.com/docker-library/redis).

## When should you build and publish new Docker Image?

You should build and publish a new Docker Image after a new major, minor or patch version of Valkey is released on the [main Valkey repository](https://github.com/valkey-io/valkey).

## How do you build and publish new version of a Docker Image?

*Pre-requisites: [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) this repo, create a private Docker Hub repo, and setup your GitHub secrets to access the private Docker Hub repo.*

1. Validate that the metadata for the new version is updated  the [Valkey hashes file](https://github.com/valkey-io/valkey-hashes/blob/main/README). If it is not updated, please open an issue [here](https://github.com/valkey-io/valkey-hashes/issues)
2. If a new major or minor version is released, please create a new directory in the `valkey-container` repo. For example: [`7.2`](https://github.com/valkey-io/valkey-container/tree/mainline/7.2).
3. Run the `update.sh` script locally which will update `versions.json`. It will also populate the Dockerfiles for the new versions in the respective directories. Running the `update.sh` file executes `versions.sh` which updates `versions.json` with the required metadata from the [Valkey hashes file](https://github.com/valkey-io/valkey-hashes/blob/main/README). Once `versions.json` is updated, `apply-templates.sh` is executed which updates Dockerfiles for all the versions directories in the repo. For example [`7.2`](https://github.com/valkey-io/valkey-container/tree/mainline/7.2).
4. Validate that the version and the info is populated correctly from the [Valkey hashes file](https://github.com/valkey-io/valkey-hashes/blob/main/README).
5. Verify all the tests pass on your fork and that your private Docker Hub repository has been updated.
6. Publish a PR with these changes. For example: [#8](https://github.com/valkey-io/valkey-container/pull/8)
7. Once the PR is merged, Sit back, relax and enjoy looking at your creation getting published to the official Docker Hub page.