Quick Start Guide

Connecting to Redis

GoFr simplifies the process of connecting to Redis.


Ensure you have Redis installed on your system.

Optionally, you can use Docker to set up a development environment as described below.

docker run --name gofr-redis -p 6379:6379 -d redis

You can set a sample key greeting using the following command:

docker exec -it gofr-redis bash -c 'redis-cli SET greeting "Hello from Redis."'

Configuration & Usage

GoFr applications relies on environment variables to configure and connect to a Redis server. These variables are stored in a file named .env located within the configs directory in your project root.

Following configuration keys are required for Redis connectivity:

  • REDIS_HOST: It specifies the hostname or IP address of your Redis server.
  • REDIS_PORT: It specifies the port number on which your Redis server is listening. The default Redis port is 6379.


The following code snippet demonstrates how to retrieve data from a Redis key named "greeting":

package main

import (



func main() {
	// Initialize GoFr object
	app := gofr.New()

	app.GET("/redis", func(ctx *gofr.Context) (interface{}, error) {
		// Get the value using the Redis instance

		val, err := ctx.Redis.Get(ctx.Context, "greeting").Result()
		if err != nil && !errors.Is(err, redis.Nil) {
			// If the key is not found, we are not considering this an error and returning ""
			return nil, err

		return val, nil

	// Run the application