mirror of https://github.com/d0zingcat/BroadcastChannel.git synced 2026-05-14 07:26:50 +00:00

Files

ccbikai 39e2ccbd8d feat: clarify Telegram channel setup in docs

Improved documentation clarity on configuring Telegram channel usernames, added troubleshooting section for common deployment issues, and emphasized the necessity of public channels and correct username format to ensure successful deployment.

2024-08-08 12:23:41 +08:00

3.9 KiB

Raw Blame History

BroadcastChannel

Turn your Telegram Channel into a MicroBlog.

English | 简体中文

✨ Features

Turn your Telegram Channel into a MicroBlog
SEO friendly
0 JS on the browser side
RSS and RSS JSON

🪧 Demo

Real users

Platform

BroadcastChannel supports deployment on serverless platforms like Cloudflare, Netlify, Vercel that support Node.js SSR, or on a VPS. For detailed tutorials, see Deploy your Astro site.

🧱 Tech Stack

Framework: Astro
CMS: Telegram Channels
Template: Sepia

🏗️ Deployment

Fork this project to your GitHub
Create a project on Cloudflare/Netlify/Vercel
Select the BroadcastChannel project and the Astro framework
Configure the environment variable CHANNEL with your channel name. This is the minimal configuration, for more configurations see the options below
Save and deploy
Bind a domain (optional).
Update code, refer to the official GitHub documentation Syncing a fork branch from the web UI.

⚒️ Configuration

## Telegram Channel Username, must be configured. The string of characters following t.me/
CHANNEL=miantiao_me

## Language and timezone settings, language options see [dayjs](https://github.com/iamkun/dayjs/tree/dev/src/locale)
LOCALE=en
TIMEZONE=America/New_York

## Social media usernames
TELEGRAM=ccbikai
TWITTER=ccbikai
GITHUB=ccbikai
MASTODON=mastodon.social/@Mastodon
BLUESKY=bsky.app

## The following two social media need to be URLs
DISCORD=https://DISCORD.com
PODCAST=https://PODCAST.com

## Header and footer code injection, supports HTML
FOOTER_INJECT=FOOTER_INJECT
HEADER_INJECT=HEADER_INJECT

## SEO configuration options, can prevent search engines from indexing content
NO_FOLLOW=false
NO_INDEX=false

## Sentry configuration options, collect server-side errors
SENTRY_AUTH_TOKEN=SENTRY_AUTH_TOKEN
SENTRY_DSN=SENTRY_DSN
SENTRY_PROJECT=SENTRY_PROJECT

## Telegram host name and static resource proxy, not recommended to modify
HOST=telegram.dog
STATIC_PROXY=

Frequently Asked Questions

Why is the content empty after deployment?
- Check if the channel is public, it must be public
- The channel username is a string, not a number
- Turn off the "Restricting Saving Content" setting in the channel
- Redeploy after modifying environment variables
- Telegram blocks public display of some sensitive channels, you can verify by visiting https://t.me/s/channelusername.

3.9 KiB Raw Blame History Unescape Escape