opendesk README

项目的 README,来自 github.com/useopendesk/opendesk。合并为一个 markdown 文件:README.md。

opendesk

The open-source helpdesk.

opendesk.sh Docs CI status License Join us on Discord Follow @OpendeskHQ on X

Features · How it works · Quick start · Self-hosting · Docs · Community · Support

⭐ Help more teams find opendesk. Star this repo!

The opendesk inbox: live chats waiting, the unassigned queue, and a ticket where Ollie cancels and refunds an order

opendesk

opendesk brings your support email, live chat and help center into one shared inbox, and every change shows up live for everyone on the team. It ships as a hosted service at opendesk.sh and as a self-hosted install, and the two run the same code. Ollie, the built-in AI, drafts, triages and answers alongside your team, with any Anthropic or OpenAI-compatible provider, including local models.

Features

How it works

opendesk is one Go binary (the API, background jobs and the event relay), an Elixir realtime gateway that holds no database connection, and Postgres. Every change that someone else should see is written as an event in the same transaction as the change; the relay publishes it to NATS, the gateway pushes it to browsers, and webhooks deliver it to your endpoints. There is no Redis and no Kafka.

flowchart LR
  B["Browsers · apps"] --> C["Caddy"]
  C -- "/socket" --> RT["Realtime gateway"]
  C --> OD["opendesk<br/>API · jobs · web app"]
  OD --> DB[("Postgres")]
  OD -- "events" --> N{{"NATS"}}
  N --> RT
  OD --> WH["Webhooks"]
  OD --> M["Google · Microsoft · SMTP"]

Self-hosted, NATS runs embedded in the opendesk binary and the whole stack sits behind Caddy on one domain. The hosted service splits the same binary into API and worker roles. Full write-up in the introduction and the cloud architecture.

Quick start

You need Go, Node.js with pnpm, Elixir, and Docker for Postgres.

git clone https://github.com/useopendesk/opendesk && cd opendesk
cp .env.example .env
make dev-db      # Postgres on localhost:55432
make api         # the Go API and workers, with embedded NATS on :4222
make realtime    # the Elixir gateway on :4000
make web         # the web app on :5173

Open http://localhost:5173 and sign up. Until you configure a mail driver, verification and invitation emails are printed to the API log. make site and make docs run the marketing site and the docs. More in the contributing guide.

Self-hosting

Runs on Docker Compose

Self-hosted opendesk is free forever, with no limits, and runs the same code as the hosted service. One command installs it on any Linux server with Docker:

curl -fsSL https://opendesk.sh/install.sh | sh

It asks for your domain and an email for the TLS certificate, generates every secret, pins a release, verifies each file against the release's checksums, and serves opendesk over HTTPS with Caddy. Open your domain and sign up; the first account becomes the workspace owner. Add --wizard and it also asks about email, storage, inbound mail, AI and sign-ups. The script is checksummed at install.sh.sha256 if you would rather read and verify it first, and --dry-run prints the .env it would write without touching anything. Every flag: install script.

To build it from source instead:

git clone https://github.com/useopendesk/opendesk && cd opendesk
make selfhost-up

[!WARNING] The installer writes /opt/opendesk/.env, which holds the only copy of CREDENTIALS_KEY, the key that encrypts mailbox credentials. Lose it and every stored credential is unreadable. opendesk-ctl backup saves it with the database.

opendesk-ctl in the install directory runs the instance: status, logs, backup, restore, upgrade, start and stop. From here the self-hosting guide covers email, Google and Microsoft sign-in, storage, AI, hardening, scaling and backups.

Documentation

The full docs live at docs.opendesk.sh.

Read this To learn
What is opendesk What you get, and how the parts fit together
Cloud quickstart Your account, workspace, first mailbox and chat widget on opendesk.sh
Self-host quickstart A server, a domain and one command to a running instance
Install script What the installer does, every flag, and how to verify it first
Configuration Every environment variable opendesk and the gateway read
Email Inbound forwarding, outbound replies and platform email
Backups and upgrades Backing up, restoring and moving between releases
Hardening A checklist for running opendesk securely on your own infrastructure
Scaling Splitting into API, worker and gateway roles, with an external NATS cluster
Mailboxes Forwarding your address in and replying from it
API reference Endpoints, auth, webhooks, events, realtime and MCP

Community

Have a question, found a bug, or want to shape where opendesk goes next?

Support

[!NOTE] Need a hand? We are happy to help. Ask in Discord, open a GitHub issue or email [email protected], and someone on the team will get back to you.

Would you rather not run it yourself? opendesk Cloud is the same code, hosted and operated by us. For larger teams we also help with migrating from another helpdesk, self-hosted deployments and support agreements. Tell us what you need at [email protected].

Try opendesk Cloud Email the team Ask on Discord

Contributing

Pull requests are welcome. Keep each one to a single logical change, and open an issue first for larger design or product changes. Read AGENTS.md and the files in contracts/ before changing an interface between parts. Before you open a PR, run make lint and make test for Go, and pnpm typecheck and pnpm lint in web/, or run pnpm qa in qa/ for everything your branch changes. See CONTRIBUTING.md, the contributing guide and the Code of Conduct. Need help rather than a change? See SUPPORT.md.

Logos, icons, colours and usage rules are in brand/.

Security

Found a vulnerability? Email [email protected] or open a private advisory instead of a public issue. See responsible disclosure.

License

Apache License 2.0. Copyright 2026 Mindroot Ltd. See LICENSE.

opendesk (useopendesk/opendesk)

正在搜索数据库…

这是什么?opendesk 将你的客服邮件、在线聊天和帮助中心整合到一个共享收件箱中,每项变更都会实时同步给团队所有成员。内置的 AI 助手 Ollie 会与你的团队一起起草回复、对工单分类并作答。
这是一个应用,还是拆分成多个服务?它是一个 Go 二进制程序,负责 API、后台任务和事件中继,同时搭配一个 Elixir 实时网关和一个 Postgres 数据库。自托管时,所有组件都通过 Caddy 部署在同一台服务器上;托管版本则只是把同一个二进制程序拆分为 API 角色和 Worker 角色。
我该怎么让它跑起来?自托管时,只需一条命令即可在任何装有 Docker 的 Linux 服务器上完成安装,安装过程会询问你的域名以及用于 TLS 证书的邮箱。本地开发则需要安装 Go、Node.js(含 pnpm)、Elixir,以及用于运行 Postgres 的 Docker,然后打开应用并注册账号。
我还需要另外安装 Redis 或 Kafka 吗?不需要。事件通过 NATS 传递,自托管时 NATS 内嵌在 opendesk 二进制程序中运行,因此无需单独部署 Redis 或 Kafka。
首次设置时有什么需要注意的坑吗?在你配置真实的邮件驱动之前,验证邮件和邀请邮件并不会真正发出,而只会打印到 API 日志中。
除了浏览器,我还能在别的地方使用它吗?可以——除了网页版收件箱,还提供适用于 macOS、Windows 和 Linux 的原生桌面应用,以及原生 iPhone 应用。
Ollie 是什么?Ollie 是内置的 AI 助手,可以起草回复、总结和分类工单、进行翻译,并基于你的知识库作答。它可以使用任何 Anthropic 或兼容 OpenAI 的服务商,包括本地模型。
opendesk 可以和哪些工具集成?它内置了与 Linear、GitHub、Jira、Sentry、Slack 和 Stripe 的集成,也支持任意 MCP 服务器,并开放了公共 REST API,提供带签名的 Webhook 和实时 Socket 连接。
opendesk Cloud 与自托管版本有什么不同?没有区别——opendesk Cloud 运行的是完全相同的代码,只是由团队托管和运营,适合不想自己部署的用户。
大小
43.3 MB
星标
509
时长
1个月
提交 · 90 天