BTW 开源项目教程

BTW 开源项目教程

btw Open source Medium alternative- set up your personal blog in minutes. 项目地址: https://gitcode.com/gh_mirrors/bt/btw

1. 项目介绍

BTW（By The Way）是一个开源的个人网站构建工具，旨在为用户提供一个快速搭建个人博客的平台。用户可以选择使用BTW的在线服务，也可以通过开源版本进行自托管。BTW支持多种功能，包括文章发布、编辑、管理等，适合个人博客、技术笔记等多种用途。

2. 项目快速启动

2.1 环境准备

在开始之前，请确保您的系统上已安装以下软件：

• Docker
• Docker-compose

2.2 安装步骤

1. 克隆项目仓库

   git clone https://github.com/btw-so/btw.git
   cd btw
   

2. 配置环境变量

   编辑 deploy/docker-compose.dev.yml 文件，设置以下必填字段：

   ADMIN_EMAIL: "your-email@example.com"
   ADMIN_SLUG: "your-unique-slug"
   

   其他可选字段包括：

   • ADMIN_OTP: 6位数字的OTP码，用于登录验证。
   • SECRET: 自定义的唯一密钥。
   • SMTP_HOST, SMTP_PORT, SMTP_USER, SMTP_PASS, SMTP_FROM: SMTP服务相关配置。
   • S3_ENDPOINT, S3_BUCKET, S3_KEY, S3_SECRET: 用于图片上传的S3存储配置。

3. 启动服务

   在 deploy 目录下执行以下命令：

   docker-compose -f docker-compose.dev.yml up
   

4. 访问应用

   服务启动后，您可以通过浏览器访问 http://localhost:9000 进行登录和开始写作。如果设置了自定义域名，可以通过 http://localhost:9222 查看已发布的文章。

3. 应用案例和最佳实践

3.1 个人博客

BTW非常适合用于搭建个人博客，用户可以通过简单的配置快速发布文章，并自定义博客的外观和功能。例如，用户可以设置自定义域名、添加社交媒体链接等。

3.2 技术笔记

对于技术爱好者和开发者来说，BTW也是一个理想的技术笔记平台。用户可以记录开发过程中的问题、解决方案、学习笔记等，并通过BTW的编辑器进行格式化和排版。

4. 典型生态项目

4.1 Docker

BTW项目本身使用了Docker进行容器化部署，这使得项目在不同环境中的一致性和可移植性得到了保障。用户可以通过Docker快速启动BTW服务，无需担心环境配置问题。

4.2 PostgreSQL

BTW使用PostgreSQL作为其数据库后端，提供了稳定和高效的数据存储解决方案。用户可以通过配置 TASKS_DATABASE_URL 来连接到自己的PostgreSQL数据库。

4.3 S3 存储

对于需要图片上传功能的用户，BTW支持与S3存储服务的集成。用户可以通过配置S3相关参数，将图片上传到云存储中，从而提高博客的访问速度和可靠性。

---

通过以上步骤，您可以快速启动BTW项目，并开始构建您的个人博客或技术笔记平台。BTW的开源特性使得用户可以根据自己的需求进行定制和扩展，满足不同场景下的使用需求。

btw Open source Medium alternative- set up your personal blog in minutes. 项目地址: https://gitcode.com/gh_mirrors/bt/btw