search

ccbikai / BroadcastChannel

Turn your Telegram Channel into a MicroBlog.
https://memo.miantiao.me
GNU Affero General Public License v3.0
1.43k stars 752 forks source link
astro blog hacktoberfest microblog telegram telegram-channel

readme

BroadcastChannel

Turn your Telegram Channel into a MicroBlog.

English | 简体中文

✨ Features

🪧 Demo

Real users

Platform

  1. Cloudflare
  2. Netlify
  3. Vercel

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

🏗️ Deployment

Docker

  1. docker pull ghcr.io/ccbikai/broadcastchannel:main
  2. docker run -d --name broadcastchannel -p 4321:4321 -e CHANNEL=miantiao_me ghcr.io/ccbikai/broadcastchannel:main

Serverless

  1. Fork this project to your GitHub
  2. Create a project on Cloudflare/Netlify/Vercel
  3. Select the BroadcastChannel project and the Astro framework
  4. Configure the environment variable CHANNEL with your channel name. This is the minimal configuration, for more configurations see the options below
  5. Save and deploy
  6. Bind a domain (optional).
  7. 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=

## Enable Google Site Search
GOOGLE_SEARCH_SITE=memo.miantiao.me

## Enable tags page, separate tags with commas
TAGS=tag1,tag2,tag3

## Show comments
COMMENTS=true

## List of links in the Links page, Separate using commas and semicolons
LINKS=Title1,URL1;Title2,URL3;Title3,URL3;

## Sidebar Navigation Item, Separate using commas and semicolons
NAVS=Title1,URL1;Title2,URL3;Title3,URL3;

🙋🏻 FAQs

  1. 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.

☕ Sponsor

  1. Follow me on Telegram
  2. Follow me on 𝕏
  3. Sponsor me on GitHub