设置 Redash 实例

创建实例

对于基本部署,我们建议至少 4GB 的 RAM 和合理的 CPU 分配。随着使用量的增长,您可能需要额外的 RAM 和 CPU 功率来支持增加的后台工作进程和 API 进程。

要创建实例,您有以下选项

  1. AWS EC2 AMI
  2. Google Compute Engine 镜像
  3. 其他
  4. Docker

我们尚未更新 V10 的官方镜像。但是,您可以部署 V8 实例并按照这些说明进行升级。

下面有此过程的视频演示

AWS

使用我们创建的预构建 AMI 启动实例(对于小型部署,t2.small 应该足够)

区域 AMI
us-east-1 ami-0d915a031cabac0e0
us-east-2 ami-0b97435028ca44fcc
us-west-1 ami-068d0753a46192935
us-west-2 ami-0c457f229774da543
eu-west-1 ami-046c6a0123bf94619
eu-west-2 ami-0dbe8ba0cd21ea12b
eu-west-3 ami-041bf9180061ce7ea
eu-central-1 ami-0f8184e6f30cc0c33
eu-north-1 ami-08dd1b893371bcaac
ap-south-1 ami-0ff23052091536db2
ap-southeast-1 ami-0527e82bae7c51958
ap-southeast-2 ami-0bae8773e653a32ec
ap-northeast-1 ami-060741a96307668be
ap-northeast-2 ami-0d991ac4f545a6b34
sa-east-1 ami-076f350d5a5ec448d
ca-central-1 ami-0071deaa12b66d1bf

(以上 AMI 的版本为:8.0.0)

启动实例时,请确保使用安全组,该安全组仅允许端口 22 (SSH)、80 (HTTP) 和 443 (HTTPS) 上的传入流量。这些 AMI 基于 Ubuntu,因此您需要使用用户 ubuntu 通过 SSH 连接到实例。

现在继续“设置”。

Google Compute Engine

要在 GCE 上开始使用,请在您的Cloud Shell中运行以下命令。

首先,您需要将 Redash 镜像添加到您的帐户

$ gcloud compute images create "redash-8-0-0" --source-uri gs://redash-images/redash.8.0.0-b32245-1.tar.gz

接下来,您需要使用此镜像启动实例。建议使用 n1-standard-1 机器类型。您可以使用以下命令使用镜像启动实例(您可能需要使用 --zone 参数指定实例的 区域

$ gcloud compute instances create redash --image redash-8-0-0

现在继续“设置”。

其他

AWS 和 Google Compute Engine 镜像是使用我们的 设置脚本创建的,该脚本旨在在许多现代 Linux 发行版上运行。您可以按原样使用该脚本,也可以将其用作创建您自己的设置的蓝图。

脚本的作用是

  1. 安装 Docker 和 Docker Compose。
  2. 下载我们推荐的 Docker Compose 配置并创建初始配置。
  3. 启动一切。

请注意,该脚本假设您在“干净”的机器上运行它。如果您在用于其他目的的机器上运行此脚本,您可能需要根据您的需要进行调整。

Docker

对于每个 Redash 版本,我们还会创建更新的 Docker 镜像。我们的镜像遵循最佳实践,可用于任何容器编排平台,如 Kubernetes、ECS 或仅使用 Docker Compose(我们在镜像中使用)。

如果您不使用我们的云镜像之一,您必须手动设置 Redash 的密钥

  1. 在与您的 compose.yaml 文件相同的文件夹中创建一个 .env
  2. 用 bash 语法写入任何敏感的环境变量
REDASH_SECRET_KEY=...
REDASH_COOKIE_SECRET=...
GOOGLE_CLIENT_ID=...

不要将此文件提交到版本控制。

有关开发环境设置,请参阅开发人员指南(其中也包括特定于 Docker 的说明)。

要运行 Redash,您需要 Redash 的多个实例(API 服务器和运行查询的后台工作进程)以及 Redis 和 PostgreSQL。如果您不想或不能使用我们的镜像或设置脚本,您可以参考 Docker Compose 配置来了解您需要定义哪些服务。

设置

一旦您使用镜像或脚本创建了实例,您应该有一个正在运行的 Redash 实例,其中包含您入门所需的一切。Redash 应该可以使用您分配给它的服务器 IP 或 DNS 名称访问。您可以将您的浏览器指向此地址。

在您继续之前,它会要求您创建您的管理员帐户。完成此操作后,您就可以开始使用 Redash。

Initial Setup Screen

请确保在使用 CLI 或继续其余设置之前完成基于 Web 的设置。

要使您的设置更完整,您还需要手动执行以下几个步骤

邮件配置

为了使系统能够发送电子邮件(用户邀请、密码重置、警报触发时等等),您需要使用您使用的邮件服务器配置 Redash。邮件服务器配置是使用环境变量完成的。如果您使用的是我们的镜像之一,您可以通过编辑 /opt/redash/env 文件来完成此操作。

相关的配置变量是(请注意,并非所有变量都是必需的)

  • REDASH_MAIL_SERVER (默认值: localhost)
  • REDASH_MAIL_PORT (默认值: 25)
  • REDASH_MAIL_USE_TLS (默认值: false)
  • REDASH_MAIL_USE_SSL (默认值: false)
  • REDASH_MAIL_USERNAME (默认值: None)
  • REDASH_MAIL_PASSWORD (默认值: None)
  • REDASH_MAIL_DEFAULT_SENDER (发送方的电子邮件地址)

此外,您还需要设置 REDASH_HOST 的值,这是您的 Redash 实例的基本地址(DNS 名称或 IP)以及协议,例如:https://demo.redash.io

一旦您更新了配置,请重新启动所有服务(docker-compose up -d,运行 docker-compose restart 不够,因为它不会读取 env 文件的更改)。要测试电子邮件配置,您可以运行 docker-compose run --rm server manage send_test_mail

建议使用一些邮件服务,如 Amazon SESMailgun 来发送电子邮件,以确保可送达性。

Google OAuth 设置

如果您想使用 Google OAuth 进行用户身份验证,您需要创建一个 Google Developers 项目(请参阅说明),然后在 /opt/redash/env 文件中添加所需的配置。

  • REDASH_GOOGLE_CLIENT_ID (Google OAuth 客户端 ID)
  • REDASH_GOOGLE_CLIENT_SECRET (Google OAuth 客户端密钥)

更新后,重启 Web 服务器(docker-compose up -d server)。启用后,Redash 将使用 Google OAuth 对现有用户帐户进行身份验证。要启用属于特定域名的用户的自动创建,您可以在设置页面中添加此域名(或多个域名)。

其他配置选项

Redash 使用环境变量进行配置。有关环境变量的完整列表,请参阅设置文章

HTTPS

如果这是生产环境,您应该强制使用 HTTPS 并确保设置了 cookie 密钥(请参阅说明)。

安装健康检查

安装完成后,您可以通过调用 /ping API 端点进行健康检查。

RESPONSE
PONG.

如何升级?

建议在新版本发布时进行升级,以受益于错误修复和新功能。有关完整的升级说明,请参阅此处

    快速导航