Bullet Board

子弹板，用于快速传递简要数据，实现无登录、无授权、无需下载的三无产品。

Demo: bbdemo.990521.xyz, API password: bbdemo

不建议使用本程序存储任何重要文件与信息！

快速安装 / Quick Start

配置 / Settings

设置项 / Key	环境变量 / Env Key	默认值 / Value	备注 / Comment
$save_path	BB_SAVE_PATH	_tmp	存储文件夹
$api_passwd	BB_API_PASSWD	NULL	API接口密码，建议仅通过环境变量设置
$base_url	BB_BASE_URL	AUTO	基础地址，如http://bbdemo.990521.xyz(此设置已经自动配置，仅出现预料外情况下使用)

在部署子弹板前，需要对index.php文件进行设置，设置$base_url变量的值为您的站点地址，或者通过环境变量BB_BASE_URL设置（环境变量设置优先级高于变量设置，推荐使用环境变量设置）。

请确保BB_SAVE_PATH环境变量或$save_path变量指向的目录路径（默认为index.php文件同级目录_tmp）可读可写。

重定向 / REWRITE

Apache 设置

需要开启 mod_rewrite 并对站点设置 .htaccess 文件. 详见 How To Set Up mod_rewrite for Apache.

Nginx 设置

请参考下方案例并设置Nginx配置文件：

如果子弹板位于网站根目录：

location / {
    rewrite ^/([a-zA-Z0-9_-]+)$ /index.php?note=$1;
}

如果子弹板位于网站子目录（以note子目录为例）:

location ~* ^/notes/([a-zA-Z0-9_-]+)$ {
    try_files $uri /notes/index.php?note=$1;
}

Docker部署

使用默认参数部署到80端口，以当前目录映射为临时文件保存目录：

docker run --name bulletboard -v $(pwd):/app/_tmp  -p 8000:80 -itd jokin1999/bulletboard

GearHost 一键部署

GearHost部署后，每次更新都将 清空数据！

以下教程基于已经Fork本项目的基础上进行！

Fork this project first!

中文

• 注册/登录 GearHost
• 创建一个CloudSite并进入控制台
• 点击Domain并绑定域名
• Config设置中
  • PHP VERSION -> 7.0或更新版本
  • APP SETTINGS新增以下设置
    • BB_BASE_URL => 你的网站域名（必须设置）
    • BB_SAVE_PATH => 数据存储文件夹
• Publish中
  • 选择 GitHub
  • 选择 Authorize 并填写相关信息
  • 选择 bulletboard 项目（Project）， master 分支（Branch）
  • 点击 Activate

English

• Register / Login on GearHost
• Create an CloudSite and enter the console of it
• Click Domain and bind your domain
• Click Config
  • PHP VERSION -> 7.0 or newer version
  • add the following settings to APP SETTINGS
    • BB_BASE_URL => your domain（necessary）
    • BB_SAVE_PATH => data folder
• Click Publish
  • Click GitHub
  • Click Authorize and follow the guide
  • Click bulletboard Project， master Branch
  • Click Activate

API接口 / API Interface

基本参数说明

API接口使用GET方式传递并返回JSON格式数据

键 / Key	值 / Value	备注 / Comment
raw	NULL	设置任意值将直接返回文件内容，仅获取内容时有效
apipasswd	API Password	API 接口密码
apiaction	API Action	API 指令，参考下方API Action

API Action

Action	Comment	备注
gdl	Get the data list	返回数据文件表
cd	Clear all the data	清空数据文件夹

API 返回

成功案例：

{
  "code": 0,
  "msg": "Success.",
  "data": [...],
  "version": "1.0.0"
}

失败案例：

{
  "code": 1,
  "msg": "Not found action.",
  "data": null,
  "version": "1.0.0"
}

关于 / About

This project is forked from pereorga/minimalist-web-notepad

Changes can be checked in commits.

If there is any problem about copyright and license, please email me (327928971@qq.com) and let me know.