btw

btw-soGPL-3.0活跃维护

几分钟就能搭好个人博客的开源建站工具,无需写代码,适合想脱离 Medium 独立写作的人。

Open source Medium alternative- set up your personal blog in minutes.

暂无版本1,253star101fork同步于 2026-11-07 07:33 UTC

怎么上手

由 README 提炼,执行前请确认
cd deploy && docker-compose -f docker-compose.dev.yml up
硬件要求按 README 说明

README 未说明,只要求本机安装最新版 Docker 与 Docker Compose,并有一个可用的 Postgres 实例

下载:源码 zip·GitHub Releases(安装包)本站不镜像安装包

项目说明

由 README 自动翻译提炼

开源个人博客搭建工具,几分钟内自建 Medium 风格个人网站

几分钟就能搭好个人博客的开源建站工具,无需写代码,适合想脱离 Medium 独立写作的人。

核心能力

  • 用 Docker Compose 一键启动编辑器与博客站点
  • 在编辑器内撰写并发布文章,按 slug 访问博客
  • 可选 OTP 邮箱验证码登录保护写作后台
  • 可选 S3 配置支持编辑器内图片上传
  • 基于 Postgres 存储内容,首次启动自动建库

容易踩的坑

启动前必须在 deploy/docker-compose.dev.yml 中填写 ADMIN_EMAIL 和 ADMIN_SLUG 两个必填项;需要自备可用的 Postgres 实例,并修改默认 SECRET;图片上传依赖额外配置 S3_ENDPOINT 等变量,OTP 登录依赖 SMTP 配置,不配则相应功能不可用

内容由模型根据 README 生成,可能不完整或不准确,以官方文档为准。看原文 README

最近发版

0 个版本

暂无 release 数据(可能没有发版,或尚未同步)。

用户点评

登录用户的真实使用记录,可按版本和硬件筛选
共 0 条

    还没有人点评。第一个说出真实体验的人最有价值。

    README 原文

    未翻译

    github-cover


    btw

    btw is an open source personal website builder.

    You can sign up and use btw without installing anything. You can also use the open source version to self-host.

    btw-editor-screenshot

    Demo blogs published using btw:

    Table of contents

    Getting started

    These instructions will help you to get a copy of the project up and running on your local machine

    Pre-requisites

    • Install the latest version of Docker, Docker-compose on your system
    • Working postgres instance
    • SMTP credentials (Ex: from mailgun)

    Installation

    Set ADMIN_EMAIL and ADMIN_SLUG in deploy/docker-compose.dev.yml. These are the only mandatory fields. Your database will be automatically configured on the first setup. Details of other variables in the docker-compose file:

    Variable NameDescription
    TASKS_DATABASE_URLConnection URL to your PG DB (For development, the URL is already configured)
    ADMIN_EMAILYour email address (REQUIRED)
    ADMIN_SLUGUnique slug (REQUIRED)
    ADMIN_OTP(OPTIONAL) Set a unique 6 digit code, if you want the writer to be behind OTP login. OTP login turned off by default
    SECRETUnique secret (change the default secret)
    SMTP_HOSTSMTP HOST (OPTIONAL, used to email OTPs for login)
    SMTP_PORTOPTIONAL
    SMTP_USEROPTIONAL
    SMTP_PASSOPTIONAL
    SMTP_FROMOPTIONAL
    S3_ENDPOINT(OPTIONAL) Set this if you need image uploads to work in editor
    REACT_APP_S3_ENDPOINTOPTIONAL
    S3_BUCKETOPTIONAL
    S3_KEYOPTIONAL
    S3_SECRETOPTIONAL

    Development

    1. Execute the following commands from the deploy folder:
      docker-compose -f docker-compose.dev.yml up
      
    2. Visit localhost:9000 to login and start writing
    3. If you set your slug and publish any articles, you can view them at localhost:9222?domain=

    Community

    • Twitter: Product updates & memes.
    • Discord: If you have questions or just want to hang out, come & say hi!

    Coming next

    • Simplified development setup
    • Sample cloud deployment setup
    • Sample custom domain setup instructions
    • Feature roadmap
    • Documentation
    • Contributing guidelines

    License

    See the LICENSE file for details.