Skip to content

🚀 release: v1.0.0-beta.3 #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .env.railway
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
PLATFORM_REDIS_URL="${{"Redis (Platform)".REDIS_URL}}" # Auto-configured Redis for bot data storage
POSTGRES_PASSWORD="${{"Postgres (Platform)".POSTGRES_PASSWORD}}" # Auto-configured database password
POSTGRES_USER="${{"Postgres (Platform)".POSTGRES_USER}}" # Auto-configured database username
POSTGRES_URL="${{"Postgres (Platform)".DATABASE_URL}}" # Auto-configured PostgreSQL connection URL
NODE_ENV="production" # Environment mode (keep as production for Railway)
WEBHOOK_POLL_INTERVAL="1000" # How often to check for agent replies (milliseconds)
DATABASE_SSL_VALIDATE="true" # Enable secure database connections (recommended)
TELEGRAM_BOT_TOKEN="" # Get from @BotFather on Telegram - REQUIRED
UNTHREAD_API_KEY="" # Get from Unthread dashboard API settings - REQUIRED
UNTHREAD_SLACK_CHANNEL_ID="" # Target Slack channel ID from Unthread - REQUIRED
UNTHREAD_WEBHOOK_SECRET="" # Webhook secret from Unthread dashboard - REQUIRED
WEBHOOK_REDIS_URL="" # Redis URL for webhook processing (optional for basic bot)
COMPANY_NAME="" # Your company name (optional - used in ticket formatting)
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@
# =============================================================================

# ======= Environment & Configuration =======
# Ignore all .env files except the example template
# Ignore all .env files except templates
.env*
!.env.example
!.env.railway

# ======= Build Output & Dependencies =======
# Node.js
Expand Down
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,11 @@ The **Official Unthread Telegram Bot** creates a seamless bridge between your cu

3. **Deploy Instantly**

**Option A: Docker (Recommended)**
**Option A: Railway (One-Click Deploy)**

[![deploy on railway](https://railway.com/button.svg)](https://railway.com/deploy/unthread-telegram-bo?referralCode=dTwT-i)

**Option B: Docker (Recommended)**

```bash
# Clone and setup
Expand All @@ -90,7 +94,7 @@ The **Official Unthread Telegram Bot** creates a seamless bridge between your cu
docker compose up -d
```

**Option B: Manual Installation**
**Option C: Manual Installation**

```bash
# Clone and setup
Expand All @@ -109,6 +113,15 @@ The **Official Unthread Telegram Bot** creates a seamless bridge between your cu
- Send `/start` to see if it responds
- Try creating a ticket with `/support`

## 🚂 One-Click Deploy

Deploy instantly to Railway with a single click:

[![deploy on railway](https://railway.com/button.svg)](https://railway.com/deploy/unthread-telegram-bo?referralCode=dTwT-i)

> [!TIP]
> Deploying using Railway directly supports this project's ongoing development and maintenance! 🚀

### **📋 Required Configuration**

Edit your `.env` file with these required values:
Expand Down Expand Up @@ -240,7 +253,7 @@ There are several ways you can support this project:

- [Become a sponsor](https://github.com/sponsors/wgtechlabs) and get some perks! 💖
- [Buy me a coffee](https://buymeacoffee.com/wgtechlabs) if you just love what I do! ☕
- Deploy using the [Railway Template](https://railway.com/template/nVHIjj?referralCode=dTwT-i) which directly supports the ongoing development! 🛠️
- Deploy using the [Railway Template](https://railway.com/deploy/unthread-telegram-bo?referralCode=dTwT-i) which directly supports the ongoing development! 🛠️

## ⭐ GitHub Star Nomination

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "unthread-telegram-bot",
"version": "1.0.0-beta.2",
"version": "1.0.0-beta.3",
"description": "Turn private Telegram groups into real-time support ticket hubs — powered by Unthread.io.",
"keywords": [
"telegram",
Expand Down
2 changes: 1 addition & 1 deletion src/config/env.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
* - TELEGRAM_BOT_TOKEN: Telegram Bot API authentication token
* - UNTHREAD_API_KEY: Unthread platform API key for ticket creation
* - UNTHREAD_SLACK_CHANNEL_ID: Target Slack channel for ticket routing
* - UNTHREAD_WEBHOOK_SECRET: Secret for webhook signature verification
* - UNTHREAD_WEBHOOK_SECRET: Secret for webhook signature verification (required for full integration)
* - PLATFORM_REDIS_URL: Redis connection for bot state management
* - WEBHOOK_REDIS_URL: Redis connection for webhook event processing
* - POSTGRES_URL: PostgreSQL database connection for persistent storage
Expand Down