Skip to content

Quick Start

This guide will help you quickly deploy the TelegramPress system on your server. We recommend using Docker Compose for deployment, as it is the simplest and most stable method.

Prerequisites

Before starting, please ensure your server meets the following requirements:

  • OS: Any Linux distribution (Ubuntu 20.04+ / Debian 10+ recommended)
  • Dependencies:
  • Hardware: Recommended 2 cores, 4G RAM or higher
  • Network: Server must be able to access Telegram API and Tron nodes

Deployment Steps

1. Prepare Server & Install Panel (Optional)

If you prefer a graphical interface, you can install the Baota (aaPanel) panel. If you are familiar with the command line, you can operate directly in the terminal.

2. Get Source Code

Upload the project source code to your server, or clone the repository directly (assuming you have Git):

Download Source
bash
# Create directory
mkdir -p /www/wwwroot/tgnl-admin
cd /www/wwwroot/tgnl-admin

# Upload source files to this directory and unzip
# Ensure the directory structure contains docker-compose.yml

3. File Permissions

To ensure services in Docker containers can read/write files properly, setting permissions is recommended:

bash
# Set directory permissions
chmod -R 777 .

4. Configure Environment Variables

Copy the example configuration file and modify it:

bash
# Copy env file
cp .env.example .env

# Edit config file
vim .env

You need to modify key information in the .env file (such as database password, port, etc.). Also, check nl-2333/config.txt (if exists) or relevant Bot configuration files.

5. Start Services

Use Docker Compose to build and start all services:

bash
docker compose up -d --build

This command will automatically download dependencies, build images, and start the admin panel, database, and bot services.

Waiting for Startup

The first build may take a few minutes, please be patient.

6. Verify Deployment

Check container status:

bash
docker compose ps

If all containers are in Up state, the startup is successful.

Access the Admin Panel:

  • Open browser and visit: http://ServerIP:35474 (Port defaults to 35474, or the port you set in .env)

Initial Setup

  1. Login to Admin Panel

    • Default Username: admin
    • Default Password: admin123
  2. Authorization Activation

    • Go to Admin Panel -> Authorization
    • Enter activation code (for open source or test versions, there might be specific activation methods, or just use it directly)
  3. Configure Bot

    • Go to Admin Panel -> Bot Management
    • Enter Bot Token (Get from @BotFather)
    • Enter Admin TG ID
    • Click Save and Restart Bot

Congratulations

Your TelegramPress system has been successfully deployed and is running!

Released under the MIT License.