{
  "schema_version": 2,
  "id": "integrate/redis-arrow-flight/install",
  "title": "Run the server",
  "url": "https://redis.io/docs/latest/integrate/redis-arrow-flight/install/",
  "summary": "Run the Redis Arrow Flight server with Docker or as a binary, and check that it works.",
  "tags": [
    "docs",
    "integrate",
    "oss",
    "rs",
    "rc"
  ],
  "last_updated": "2026-11-17T10:18:45Z",
  "page_type": "content",
  "content_hash": "02af22ed42ead86b774135f5faf008765a40eeb3308471672d30b003cc4a0135",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "You can run the Redis Arrow Flight server as a container or as a single\nbinary. Either way, it needs a running Redis database. For SQL, the database\nneeds the Query Engine (Search) enabled. See the\n[requirements](https://redis.io/docs/latest/integrate/redis-arrow-flight#requirements).\n\n> [!WARNING]\n> The published server has no client authentication and no TLS. Anyone who can\n> reach its port can read and change the data that its Redis credentials can\n> reach. The binary listens on `localhost` by default, so only clients on the\n> same machine can connect. The container image listens on all interfaces\n> inside the container, so publish its port on `127.0.0.1` as shown in\n> [Run with Docker](#run-with-docker). Expose the server to other machines only\n> on a trusted network."
    },
    {
      "id": "run-with-docker",
      "title": "Run with Docker",
      "role": "content",
      "text": "1. Start the server. This command assumes Redis is running on your host at\n   port 6379, and that you use Docker Desktop:\n\n    [code example]\n\n   The `127.0.0.1:` prefix publishes the port on your machine only. Without\n   it, Docker publishes the unauthenticated server on every host network\n   interface. Don't use the server's `-listen` option to restrict a container.\n   A `localhost` bind inside the container refuses connections that arrive\n   through the published port.\n\n   With Docker Engine on Linux, put Redis and the server on the same Docker\n   network, and use the Redis container's name in `REDIS_URI` instead of\n   `host.docker.internal`.\n\n1. Check the log. The server prints a line like this when it is serving:\n\n    [code example]\n\nThe `--pull=always` option fetches the latest published image each time. To\nrun a specific release, replace `latest` with a release tag."
    },
    {
      "id": "run-the-binary",
      "title": "Run the binary",
      "role": "content",
      "text": "Release archives are available for macOS on Apple silicon and for Linux on\nx86-64 and ARM64. The following script finds the latest release for your\nplatform, verifies its checksum, and starts it against Redis on your host. It\nneeds `curl`, `tar`, and `shasum`:\n\n[code example]\n\nThe server runs in the foreground and listens on `localhost:8815`. For other\nplatforms, see\n[Run locally from source](https://redis.github.io/redis-apache-arrow-flight/docs/local-development/)."
    },
    {
      "id": "check-that-the-server-works",
      "title": "Check that the server works",
      "role": "content",
      "text": "The server's health check isn't a reliable readiness signal. It reports\n`UNKNOWN` whether or not Redis is reachable. To check that the server is\nready, run a query through a client.\n\n1. Install the Flight SQL driver for Python:\n\n    [code example]\n\n1. Run a query:\n\n    [code example]\n\n   The command prints `[{'one': 1}]`."
    },
    {
      "id": "configure-the-server",
      "title": "Configure the server",
      "role": "configuration",
      "text": "Each option is a command-line flag and has an environment variable. To list\nthem all, run the server with `-h`. The most useful options are:\n\n| Flag | Environment variable | Default | Meaning |\n| :-- | :-- | :-- | :-- |\n| `-redis-uri` | `REDIS_URI` | `redis://localhost:6379/0` | The Redis database to serve. See [connection URLs](https://redis.io/docs/latest/develop/clients/connection-urls) for the format. |\n| `-listen` | `FLIGHT_LISTEN` | `localhost:8815` (`0.0.0.0:8815` in the container image) | The address and port to listen on. Set an address that other machines can reach only on a trusted network, because the server has no authentication. In a container, leave it unchanged and publish the port on `127.0.0.1` instead. |\n| `-dataset-ttl` | `FLIGHT_DATASET_TTL` | `0` (keep) | How long to keep uploaded datasets before they expire. |\n| `-key-prefix` | `FLIGHT_KEY_PREFIX` | `arrowflight:` | The prefix of the Redis keys that store datasets. |\n| `-pool-max-open` | `FLIGHT_POOL_MAX_OPEN` | `32` | The maximum number of driver connections in use at once for each Redis user. |\n| `-shutdown-timeout` | `FLIGHT_SHUTDOWN_TIMEOUT` | `25s` | How long running calls can finish after a stop signal before the server cancels them. |\n| `-log-level` | `FLIGHT_LOG_LEVEL` | `info` | The log level: `debug`, `info`, `warn`, or `error`. |\n\nThe `-auth`, `-tls-cert`, and `-tls-key` options, and a `rediss://` Redis URI,\nmake the published server exit at startup with the message\n`requested enterprise feature is unavailable in this build`.\n\nFor the complete list, including streaming, memory, and session limits, see the\n[server guide](https://redis.github.io/redis-apache-arrow-flight/docs/server-guide/)."
    },
    {
      "id": "next-steps",
      "title": "Next steps",
      "role": "content",
      "text": "- [Connect and query](https://redis.io/docs/latest/integrate/redis-arrow-flight/connect)"
    }
  ],
  "examples": [
    {
      "id": "run-with-docker-ex0",
      "language": "bash",
      "code": "docker run --rm --pull=always -p 127.0.0.1:8815:8815 \\\n      -e REDIS_URI=redis://host.docker.internal:6379/0 \\\n      ghcr.io/redis/redis-apache-arrow-flight:latest",
      "section_id": "run-with-docker"
    },
    {
      "id": "run-with-docker-ex1",
      "language": "text",
      "code": "level=INFO msg=\"serving Arrow Flight\" addr=[::]:8815 redis=redis://host.docker.internal:6379/0 auth=none tls=false sessions=true",
      "section_id": "run-with-docker"
    },
    {
      "id": "run-the-binary-ex0",
      "language": "bash",
      "code": "(\n  set -eu\n  case \"$(uname -s)-$(uname -m)\" in\n    Darwin-arm64) PLATFORM=darwin-arm64 ;;\n    Linux-x86_64) PLATFORM=linux-amd64 ;;\n    Linux-aarch64|Linux-arm64) PLATFORM=linux-arm64 ;;\n    *) echo \"No published binary for this platform; use Docker or build from source.\" >&2; exit 1 ;;\n  esac\n  RELEASE_URL=$(curl -fsSL -o /dev/null -w '%{url_effective}' \\\n    https://github.com/redis/redis-apache-arrow-flight/releases/latest)\n  VERSION=${RELEASE_URL##*/}\n  ARCHIVE=\"redis-flight-server-${VERSION}-${PLATFORM}\"\n  DOWNLOAD=\"https://github.com/redis/redis-apache-arrow-flight/releases/download/${VERSION}\"\n  curl -fLO \"${DOWNLOAD}/${ARCHIVE}.tar.gz\"\n  curl -fLO \"${DOWNLOAD}/${ARCHIVE}.tar.gz.sha256\"\n  shasum -a 256 -c \"${ARCHIVE}.tar.gz.sha256\"\n  tar -xzf \"${ARCHIVE}.tar.gz\"\n  \"./${ARCHIVE}/redis-flight-server\" -redis-uri redis://localhost:6379/0\n)",
      "section_id": "run-the-binary"
    },
    {
      "id": "check-that-the-server-works-ex0",
      "language": "bash",
      "code": "python -m pip install adbc-driver-flightsql pyarrow",
      "section_id": "check-that-the-server-works"
    },
    {
      "id": "check-that-the-server-works-ex1",
      "language": "bash",
      "code": "python -c \"\n    import adbc_driver_flightsql.dbapi as flight_sql\n    with flight_sql.connect('grpc://localhost:8815', autocommit=True) as conn, conn.cursor() as cur:\n        cur.execute('SELECT 1 AS one')\n        print(cur.fetch_arrow_table().to_pylist())\n    \"",
      "section_id": "check-that-the-server-works"
    }
  ]
}
