Typesense 中文文档

# 安装 Typesense

以下是几种可用的安装和运行 Typesense 的选项。

# 选项 1: Typesense Cloud

运行 Typesense 最简单的方式是使用我们托管的云服务 Typesense Cloud (opens new window)。

  • 使用 GitHub 账号登录
  • 选择配置并点击 Launch（启动）。几分钟内您就能获得一个可立即使用的集群。
  • 然后点击 "Generate API Key"（生成 API 密钥），这将为您提供在代码中使用的域名和 API 密钥。

# 选项 2: 本地机器/自托管

您也可以在本地机器上运行或自托管 Typesense。

在我们的下载页面 (opens new window)可以找到适用于 Linux 和 macOS 的 DEB、RPM 和预编译二进制文件。

我们还在 Docker hub (opens new window) 上发布了官方的 Typesense Docker 镜像。

# Docker

# Docker Compose

mkdir "$(pwd)"/typesense-data

docker-compose up

# Kubernetes 部署

以下是社区支持的 Kubernetes 部署方案：

# 通过 Homebrew 在 Mac 上安装

macOS 兼容性说明

macOS 原生二进制文件仅支持 macOS Ventura (13.x) 及以上版本。

对于旧版 macOS，请使用上述的 Docker 或 Docker Compose 安装方式。

对于 Intel 芯片的 Mac：

  • 默认 API 密钥为 xyz，默认端口为 8108
  • 配置文件位于 /usr/local/etc/typesense/typesense.ini
  • 日志文件存储在 /usr/local/var/log/typesense/
  • 数据目录位于 /usr/local/var/lib/typesense/

对于 Apple Silicon 芯片的 Mac：

  • 默认 API 密钥为 xyz，默认端口为 8108
  • 配置文件位于 /opt/homebrew/etc/typesense/typesense.ini
  • 日志文件存储在 /opt/homebrew/var/log/typesense/
  • 数据目录位于 /opt/homebrew/var/lib/typesense/

# Mac 二进制安装

与 macOS 的兼容性

macOS 原生二进制文件仅适用于 macOS Ventura (13.x) 或更高版本。

对于旧版 macOS，请使用上述的 Docker 或 Docker Compose 安装方法。

# Ubuntu/Debian 的 DEB 包安装

  • 配置文件位于 /etc/typesense/typesense-server.ini
    • 管理员 API 密钥会自动生成，可以在配置文件中找到。
  • 日志文件在 /var/log/typesense/ 目录下
  • 数据目录在 /var/lib/typesense/ 目录下

兼容性说明

Typesense Server v26.0 需要 Ubuntu 20 或更高版本。

# CentOS/RHEL 上的 RPM 包

  • 配置文件位于 /etc/typesense/typesense-server.ini
    • 管理员 API 密钥会自动生成，可以在配置文件中找到。
  • 日志文件在 /var/log/typesense/ 目录下
  • 数据目录在 /var/lib/typesense/ 目录下

兼容性说明

Typesense Server v26.0 需要较新版本的 Linux 内核。

# Linux 二进制文件

兼容性说明

Typesense Server v26.0 需要 Ubuntu 20 或更高版本，或较新版本的 Linux 内核。

# Windows (WSL) (opens new window)

注意：安装后可能会看到消息"installed typesense-server package post-installation script subprocess returned error exit status 1"。 您可以安全地忽略此错误消息。执行 apt list --installed | grep typesense 应该会显示安装成功。

您可以通过在 cmd 中执行 wsl hostname -I 获取运行 Typesense 的服务器的 hostname。

你应该能够直接从 Windows 系统连接这个主机名/IP地址。

如果你希望 Typesense 在系统启动时自动运行，可以创建一个包含命令 powershell.exe /c wsl.exe sudo /usr/bin/./typesense-server --config=/etc/typesense/typesense-server.ini 的 BAT 文件，并将其设置为开机启动。

默认情况下，Typesense 会启动在 8108 端口，安装过程会生成一个随机的 API 密钥，你可以通过位于 /etc/typesense/typesense-server.ini 的配置文件查看或修改该密钥。

TIP

我们这里启动的是单节点，但 Typesense 也可以运行在集群模式下。更多详情请参阅高可用性章节。

# 使用 GPU（可选）

使用 GPU 将有助于为向量搜索和语音查询生成嵌入向量。

您需要安装以下额外依赖项，之后 Typesense 将自动利用任何可用的 Nvidia GPU：

  1. 按照 Nvidia 官网的说明安装 CUDA (opens new window)。

    需要特别安装以下版本的软件包：cuda=11.8.0-1、libcudnn8=8.9.2.26-1+cuda11.8 和 libcudnn8-dev=8.9.2.26-1+cuda11.8 及其依赖项。

  2. 按照 cuDNN 安装指南 (opens new window) 安装 cuDNN。

    需要特别安装 libcudnn8 和 libcudnn8-dev 软件包。

  3. 将以下内容添加到 /etc/profile.d/cuda-path.sh：

    export PATH=/usr/local/cuda/bin${PATH:+:${PATH}}
export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:/usr/local/cuda/lib64
export CUDA_HOME=/usr/local/cuda

  4. 安装 Typesense GPU 依赖包：

# 🆗 健康检查

您可以使用 /health API 端点来验证服务器是否已准备好接受请求。

curl http://localhost:8108/health
{"ok":true}

# ⚙️ 配置 Typesense

您可以通过命令行参数来配置 Typesense Server 的各种设置。 详细了解如何配置，请参阅参考文章： 如何配置 Typesense Server。

← 安装客户端 →