ndom91/briefkasten

Briefkasten

镜像概述和主要用途

Briefkasten 是一款自托管的书签管理应用程序，支持与任何 Prisma 兼容的数据库（如 MySQL、Postgres、SQLite 等）配合使用。它提供了丰富的书签管理功能，包括通过浏览器扩展保存、自动提取标题描述、分类标签组织、全文搜索等，适用于需要自行管理书签数据的个人或团队。

核心功能和特性

• 多方式保存：支持通过浏览器扩展、拖放URL到页面等方式保存书签
• 自动提取信息：自动提取网页标题和描述
• 便捷操作：提供键盘快捷键，提升操作效率
• 组织管理：支持按分类和标签对书签进行组织
• 数据迁移：支持从标准HTML格式导入和导出书签
• 图片获取：通过后台任务获取书签关联图片（需配合相关服务）
• 多视图支持：提供多种视图模式展示书签
• 全文搜索：支持对书签内容进行全文搜索
• API接口：提供REST API，方便集成和扩展
• 灵活登录：支持OAuth和***魔法链接登录

使用场景和适用范围

• 个人用户需要自托管书签解决方案，保护数据隐私
• 团队需要共享和管理书签资源
• 希望通过分类、标签和搜索高效管理大量书签的用户
• 需要跨设备同步书签，但不想使用第三方服务的场景

详细使用方法和配置说明

前提条件

1. 可运行Next.js应用的服务器或托管平台（如Vercel、Netlify）
2. 若使用OAuth登录，需在NextAuth.js支持的任一提供商处创建开发者账户
3. Prisma兼容数据库（如MySQL、Postgres、SQLite等）
4. 图片存储空间（如Supabase、ImageKit、Cloudinary，可选）

Docker部署步骤

1. 安装依赖

确保已安装docker和docker-compose。

2. 获取代码并配置环境变量

bash
# 克隆仓库
git clone git@github.com:ndom91/briefkasten.git && cd briefkasten

# 复制环境变量示例文件并编辑
cp .env.example .env

编辑.env文件，至少配置以下关键变量：

• DATABASE_URL：数据库连接URL，使用Postgres容器时示例：postgres://bkAdmin:briefkasten@postgres:5432/briefkasten?sslmode=disable
• NEXTAUTH_URL：应用访问URL（如http://localhost:3000）
• NEXTAUTH_SECRET：随机生成的安全密钥

3. 启动服务

bash
# 启动应用和数据库容器
docker-compose up -d

4. 初始化数据库

bash
# 进入应用容器
docker exec -it bk-app /bin/bash

# 推送数据库架构
pnpm db:push

5. 访问应用

应用默认在http://localhost:3000运行。

docker-compose配置示例

以下是基本的docker-compose.yml配置（通常已包含在仓库中）：

yaml
version: '3'

services:
  postgres:
    image: postgres:14
    environment:
      POSTGRES_USER: bkAdmin
      POSTGRES_PASSWORD: briefkasten
      POSTGRES_DB: briefkasten
    volumes:
      - postgres_data:/var/lib/postgresql/data
    restart: always

  app:
    build: .
    depends_on:
      - postgres
    environment:
      - DATABASE_URL=postgres://bkAdmin:briefkasten@postgres:5432/briefkasten?sslmode=disable
      # 其他环境变量从.env文件加载
    ports:
      - "3000:3000"
    restart: always
    volumes:
      - .env:/app/.env

volumes:
  postgres_data:

相关工具

• 浏览器扩展：https://github.com/ndom91/briefkasten-extension%EF%BC%8C%E5%8F%AF%E5%9C%A8%E6%B5%8F%E8%A7%88%E7%BD%91%E9%A1%B5%E6%97%B6%E5%BF%AB%E9%80%9F%E6%B7%BB%E5%8A%A0%E4%B9%A6%E7%AD%BE
• Android分享：配合HTTP Shortcuts应用，实现从Android分享菜单保存书签
• 截图任务：https://github.com/ndom91/briefkasten-scrape%EF%BC%8C%E7%94%A8%E4%BA%8E%E5%90%8E%E5%8F%B0%E8%8E%B7%E5%8F%96%E4%B9%A6%E7%AD%BE%E5%9B%BE%E7%89%87

许可证

MIT