xbrowsersync/api

xBrowserSync

API Docker镜像

xBrowserSync是一款免费的浏览器数据同步工具，支持在不同浏览器和设备间同步数据，以隐私和性为核心设计。详细信息请访问[]。

本仓库包含Docker文件，可快速部署您自己的https://github.com/xbrowsersync/api，支持单独运行API镜像，或通过数据库和反向代理构建生产级HTTPS服务。

运行API镜像

单独运行API镜像需要MongoDB实例和（建议）反向代理的Web服务器。

1. 创建settings.json文件，包含所需的自定义https://github.com/xbrowsersync/api#3-modify-configuration-settings值（如连接MongoDB的设置）。例如，在Windows服务器上运行Docker和MongoDB时，可使用以下设置指向主机上的MongoDB实例：

   json
   {
     "db": {
       "host": "host.docker.internal"
     }
   }
   

2. （可选）在主机上创建环境变量存储MongoDB中xBrowserSync数据库的用户名和密码：

   • XBROWSERSYNC_DB_USER
   • XBROWSERSYNC_DB_PWD

3. 运行以下命令启动API容器（替换/path/to/settings.json为实际路径）。服务将通过8080端口暴露。若未创建环境变量，需直接在命令中提供用户名和密码：

   bash
   docker run --name xbs-api -p 8080:8080 -e XBROWSERSYNC_DB_USER -e XBROWSERSYNC_DB_PWD -v /path/to/settings.json:/usr/src/api/config/settings.json -d docker.xuanyuan.run/xbrowsersync/api
   

   现在可通过http://127.0.0.1:8080访问您的xBrowserSync API服务。

运行生产级服务

若您没有MongoDB实例或计划将服务暴露到互联网，建议使用提供的https://github.com/xbrowsersync/api-docker/blob/master/docker-compose.yml，它将创建配置完整的MongoDB数据库、xBrowserSync API和Caddy反向代理容器。Caddy会自动获取并更新SSL证书，确保服务通过HTTPS安全运行。

1. 克隆https://github.com/xbrowsersync/api-docker/仓库：

   bash
   git clone https://github.com/xbrowsersync/api-docker.git
   

2. 打开https://github.com/xbrowsersync/api-docker/blob/master/.env文件，更新`API_HOSTNAME`为服务暴露的主机名（确保DNS已指向主机IP），并修改`DB_USERNAME`和`DB_PASSWORD`为自定义值。

3. （可选）打开https://github.com/xbrowsersync/api-docker/blob/master/settings.json文件，添加自定义配置值。注意：不要修改`db.host`值。

4. 运行以下命令启动容器：

   bash
   docker-compose up -d
   

   现在可通过.env文件中API_HOSTNAME定义的地址，通过HTTPS访问您的xBrowserSync API服务。

升级流程

若您使用docker-compose.yml创建了生产级服务，升级MongoDB版本时可能遇到数据库错误。建议导出旧版本数据并恢复到新版本：

1. 连接到MongoDB容器：

   bash
   docker exec -it xbs-db bash
   

2. 使用https://docs.mongodb.com/database-tools/mongodump/将数据导出到`xbs-db-backups`卷：

   bash
   mongodump --db $XBS_DB_NAME --host localhost --port 27017 --username $XBS_DB_USERNAME --password $XBS_DB_PASSWORD --authenticationDatabase admin --archive=/data/backups/xbs-db-`date +"%Y-%m-%d"`.gz --gzip
   

3. 退出容器并导航到api-docker仓库目录，停止并删除所有容器：

   bash
   docker-compose down
   

4. 删除xbs-db-data卷（先通过docker volume ls查找卷名，如api-docker_xbs-db-data）：

   bash
   docker volume rm api-docker_xbs-db-data
   

5. 获取最新代码并启动容器：

   bash
   git pull
   docker-compose up -d
   

6. 连接到新的MongoDB容器：

   bash
   docker exec -it xbs-db bash
   

7. 使用https://docs.mongodb.com/database-tools/mongorestore/恢复数据（替换`{BackupFileName}`为实际备份文件名）：

   bash
   mongorestore --username $XBS_DB_USERNAME --password $XBS_DB_PASSWORD --authenticationDatabase admin --verbose=5 --gzip --drop --archive=/data/backups/{BackupFileName}
   

问题与功能请求

Docker相关问题请在https://github.com/xbrowsersync/api-docker/issues提交；若发现xBrowserSync API本身的问题或需请求新功能，请在https://github.com/xbrowsersync/api/issues/提交。