CherryPBX

KO | EN

gitlite — search

#android #machine-learning #rust #deep-learning #docker #macos #nodejs #windows #cli #kubernetes #vue #security #ios #open-source

(★ 28)

Lightweight Web UI for IP-PBX systems with XSwitch as the backend.

CherryPBX Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# CherryPBX

A lightweight Web UI for IP-PBX systems with XSwitch as the backend.

It's still in early development, but we've chosen to build in public so everyone can follow our progress.

README in other languages:

- [中文说明](README-zh.md)

## About XSwitch

[XSwitch](https://xswitch.cn) is a VoIP system based on FreeSWITCH. It can be used as an IP-PBX, a video conferencing system, a call center server, or a gateway connecting to telecom carriers, other SIP services, WebRTC, and LLM services.

XSwitch has a nice Web UI (XUI), but it's not open source. People often ask for various features and functions that, while reasonable and useful, go far beyond XUI's design scope, which focuses primarily on FreeSWITCH management.

That's why we created CherryPBX - to build an open-source IP-PBX Web UI that everyone can use and customize to meet their specific needs. XSwitch provides powerful and comprehensive APIs, so you can potentially build any type of system - call centers, voice agents, and more.

## About Cherry Call

[Cherry Call](https://xswitch.cn/apps) is a streamlined app that integrates phone, contacts, meetings, and settings functionalities. It supports high-definition audio and video calls as well as conferencing features. It can be used in conjunction with CherryPBX.

## Tech Stack

- Next.js 16 + React 19 + TypeScript 5
- Tailwind CSS v4 + shadcn/ui

E.g.

```
$ pnpm --version && node --version
9.5.0
v22.12.0
```

## env

Create `.env`

```sh
make env
```

Check Makefile to find out how to do that manually if you don't have a `make` command on your computer.

Configure the environment variables before developing or running the application:

- `NEXT_PUBLIC_BACKEND_URL` is the frontend request base and should normally stay as `/`.
- `NEXT_PUBLIC_BACKEND_URL_TARGET` is the real XSwitch backend root URL. It defaults to `https://demo.xswitch.cn`, which is a public demo. Visit https://docs.xswitch.cn/faq/#demo to find the username and password for logging in. Alternatively you can point it to your own server (for example `http://localhost:8081`).

The browser calls same-origin `/api/...` endpoints first, and Next.js proxies them to `NEXT_PUBLIC_BACKEND_URL_TARGET` through rewrites to avoid CORS issues in local development and Docker deployment.

## Install dependencies

Run the following commands before development and production:

```bash
make install
```

## Development

```bash
make dev
```

## Build

```bash
make install                #Install dependencies
make build
```

node version >= 20.x.x

## Docker Build

The Docker deployment files live in [`docker/`](./docker).

Before building the image, update [`docker/.env`](./docker/.env) or create it from the example:

```bash
cd docker
cp .env.example .env
```

Set the Docker environment variables as follows:

```env
NEXT_PUBLIC_BACKEND_URL="/"
NEXT_PUBLIC_BACKEND_URL_TARGET="https://your-xswitch-host"
```

Build and start the production container:

```bash
cd docker
make network
make build-production
make start-production
```

Stop the production container:

```bash
cd docker
make stop-production
```

Notes:

- `NEXT_PUBLIC_BACKEND_URL` should normally remain `/`.
- Run `make network` once before `make start-production` to create the external `webapp` Docker network when needed.
- `make build-production` builds the image with `docker build`, while [`docker/compose.yaml`](./docker/compose.yaml) is only used to start and stop the already-built image.
- The Docker image builds the app with `next build --webpack` and runs the standalone Next.js server on port `3000`.
- [`docker/compose.yaml`](./docker/compose.yaml) uses an external Docker network named `webapp`.

## Lint

```bash
make check
```

## Links

- [Wiki](https://github.com/xswitch-cn/CherryPBX/wiki)
- [Github Discussions](https://github.com/rts-cn/rts/discussions/categories/cherrypbx)
- [Feedback](https://docs.xswitch.cn/howto/feedback/)

CherryPBX

CherryPBX Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

CherryPBX

CherryPBX Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README