mirror of
https://github.com/abhinavxd/libredesk.git
synced 2025-10-23 05:11:57 +00:00
Update README.md
This commit is contained in:
83
README.md
83
README.md
@@ -1,4 +1,4 @@
|
||||
<a href="https://zerodha.tech"><img src="https://zerodha.tech/static/images/github-badge.svg" align="right" /></a>
|
||||
<a href="https://zerodha.tech"><img src="https://zerodha.tech/static/images/github-badge.svg" align="right" alt="Zerodha Tech Badge" /></a>
|
||||
|
||||
|
||||
# Libredesk
|
||||
@@ -10,37 +10,72 @@ Visit [libredesk.io](https://libredesk.io) for more info. Check out the [**Live
|
||||

|
||||
|
||||
|
||||
> [!CAUTION]
|
||||
> This project is currently in **alpha**. Features and APIs may change and are not yet fully tested.
|
||||
> **CAUTION:** This project is currently in **alpha**. Features and APIs may change and are not yet fully tested.
|
||||
|
||||
## Features
|
||||
|
||||
- **Multi Inbox**
|
||||
Libredesk supports multiple inboxes, letting you manage conversations across teams effortlessly.
|
||||
- **Granular Permissions**
|
||||
Create custom roles with granular permissions for teams and individual agents.
|
||||
- **Smart Automation**
|
||||
Eliminate repetitive tasks with powerful automation rules. Auto-tag, assign, and route conversations based on custom conditions.
|
||||
- **CSAT Surveys**
|
||||
Measure customer satisfaction with automated surveys.
|
||||
- **Macros**
|
||||
Save frequently sent messages as templates. With one click, send saved responses, set tags, and more.
|
||||
- **Smart Organization**
|
||||
Keep conversations organized with tags, custom statuses for conversations, and snoozing. Find any conversation instantly from the search bar.
|
||||
- **Auto Assignment**
|
||||
Distribute workload with auto assignment rules. Auto-assign conversations based on agent capacity or custom criteria.
|
||||
- **SLA Management**
|
||||
Set and track response time targets. Get notified when conversations are at risk of breaching SLA commitments.
|
||||
- **Business Intelligence**
|
||||
Connect your favorite BI tools like Metabase and create custom dashboards and reports with your support data—without lock-ins.
|
||||
- **AI-Assisted Response Rewrite**
|
||||
Instantly rewrite responses with AI to make them more friendly, professional, or polished.
|
||||
- **Command Bar**
|
||||
Opens with a simple shortcut (CTRL+k) and lets you quickly perform actions on conversations.
|
||||
|
||||
And more checkout - [libredesk.io](https://libredesk.io)
|
||||
|
||||
|
||||
## Developer Setup
|
||||
## Installation
|
||||
|
||||
#### Prerequisites
|
||||
### Docker
|
||||
|
||||
- **go**
|
||||
- **pnpm**
|
||||
- **postgreSQL >= 13**
|
||||
- **redis**
|
||||
The latest image is available on DockerHub at [`libredesk/libredesk:latest`](https://hub.docker.com/r/libredesk/libredesk/tags?page=1&ordering=last_updated&name=latest).
|
||||
|
||||
1. **Clone the repository**:
|
||||
```shell
|
||||
# Download the compose file to the current directory.
|
||||
curl -LO https://github.com/abhinavxd/libredesk/raw/master/docker-compose.yml
|
||||
|
||||
```bash
|
||||
git clone https://github.com/abhinavxd/libredesk.git
|
||||
cd libredesk
|
||||
```
|
||||
# Copy the config.sample.toml to config.toml and edit it as needed.
|
||||
cp config.sample.toml config.toml
|
||||
|
||||
2. **Create config file**:
|
||||
# Run the services in the background.
|
||||
docker compose up -d
|
||||
|
||||
- Copy the sample configuration file `config.toml.sample` to `config.toml`:
|
||||
|
||||
```bash
|
||||
cp config.toml.sample config.toml
|
||||
```
|
||||
- Edit the `config.toml` file to configure your postgres and redis connection settings.
|
||||
# Setting System user password.
|
||||
docker exec -it libredesk_app ./libredesk --set-system-user-password
|
||||
```
|
||||
|
||||
3. **Run in development mode**:
|
||||
Go to `http://localhost:9000` and login with username `System` and the password you set using the --set-system-user-password command.
|
||||
|
||||
- Backend: `make run-backend`
|
||||
- Frontend: `make run-frontend`
|
||||
See [installation docs](https://libredesk.io/docs/installation/)
|
||||
|
||||
__________________
|
||||
|
||||
### Binary
|
||||
- Download the [latest release](https://github.com/abhinavxd/libredesk/releases) and extract the libredesk binary.
|
||||
- Copy config.sample.toml to config.toml and edit as needed.
|
||||
- `./libredesk --install` to setup the Postgres DB (or `--upgrade` to upgrade an existing DB. Upgrades are idempotent and running them multiple times have no side effects).
|
||||
- Run `./libredesk --set-system-user-password` to set the password for the System user.
|
||||
- Run `./libredesk` and visit `http://localhost:9000` and login with username `System` and the password you set using the --set-system-user-password command.
|
||||
|
||||
See [installation docs](https://libredesk.app/docs/installation)
|
||||
__________________
|
||||
|
||||
|
||||
## Developers
|
||||
If you are interested in contributing, refer to the [developer setup](developer-setup.md). The backend is written in Go and the frontend is Vue js 3 with Shadcn for UI components.
|
||||
|
Reference in New Issue
Block a user