datproject/datbase

datBase

基于Dat的开放数据工具，为研究数据管道提供友好的应用支持。项目托管于[***]

![构建状态]([***]

已弃用说明

当前无活跃维护者。

核心功能

• 在浏览器中预览dat文件内容
• 从dat中下载单个文件
• 通过用户账户为dat创建短链接

使用场景

适用于研究人员管理和分享dat格式的研究数据，方便预览数据内容、按需下载文件，以及生成短链接简化数据分享流程。

配置说明

秘钥设置

每个部署应使用不同的秘钥，用于生成密码哈希和盐值。通过环境变量TOWNSHIP_SECRET设置秘钥。

数据库位置

指定应用数据（数据库及默认归档器）的存储位置，默认存储于./data。如需修改，可在配置中添加data键：

json
{
  "data": "/path/to/my/data"
}

封闭测试模式

若需开启封闭测试，添加whitelist键指定包含允许注册***的换行分隔文件路径。默认值false允许任何人注册。

json
{ "whitelist": "/path/to/my/list/of/folks.txt" }

folks.txt示例：

pamlikesdata@gmail.com
robert.singletown@sbcglobal.net

缓存与归档数据位置

设置dat数据在文件系统中的缓存位置，默认存储于data目录下的archiver子目录。可通过archiver键修改：

json
{ "archiver": "/mnt1/bigdisk/archiver-data" }

Mixpanel账户

若拥有Mixpanel账户，可通过环境变量MIXPANEL_KEY或配置文件中的mixpanel键设置API密钥，以报告基础信息：

json
{ "mixpanel": "<我的API密钥>" }

高级密码安全

如需更高级的密码生成安全，可使用ES512密钥。参考此教程生成密钥，并在配置中设置其路径：

json
{
  "township": {
    "db": "township.db",
    "publicKey": "secrets/ecdsa-p521-public.pem",
    "privateKey": "secrets/ecdsa-p521-private.pem",
    "algorithm": "ES512"
  }
}

Docker部署示例

单容器运行

bash
docker run -d \
  -p 3000:3000 \
  -v ./datbase-data:/data \
  -e TOWNSHIP_SECRET="your-secret-key" \
  datproject/datbase

Docker Compose示例

yaml
version: '3'
services:
  datbase:
    image: datproject/datbase
    ports:
      - "3000:3000"
    volumes:
      - ./datbase-data:/data
    environment:
      - TOWNSHIP_SECRET=your-secret-key