xbrowsersync/api

xBrowserSync

API Docker镜像

![]([] ![]([]

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

本仓库包含Docker文件，可快速部署您自己的https://github.com/xbrowsersync/api%EF%BC%8C%E6%94%AF%E6%8C%81%E5%8D%95%E7%8B%AC%E8%BF%90%E8%A1%8CAPI%E9%95%9C%E5%83%8F%EF%BC%8C%E6%88%96%E9%80%9A%E8%BF%87%E6%95%B0%E6%8D%AE%E5%BA%93%E5%92%8C%E5%8F%8D%E5%90%91%E4%BB%A3%E7%90%86%E6%9E%84%E5%BB%BA%E7%94%9F%E4%BA%A7%E7%BA%A7HTTPS%E6%9C%8D%E5%8A%A1%E3%80%82

运行API镜像

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

1. 创建settings.json文件，包含所需的自定义https://github.com/xbrowsersync/api#3-modify-configuration-settings%E5%80%BC%EF%BC%88%E5%A6%82%E8%BF%9E%E6%8E%A5MongoDB%E7%9A%84%E8%AE%BE%E7%BD%AE%EF%BC%89%E3%80%82%E4%BE%8B%E5%A6%82%EF%BC%8C%E5%9C%A8Windows%E6%9C%8D%E5%8A%A1%E5%99%A8%E4%B8%8A%E8%BF%90%E8%A1%8CDocker%E5%92%8CMongoDB%E6%97%B6%EF%BC%8C%E5%8F%AF%E4%BD%BF%E7%94%A8%E4%BB%A5%E4%B8%8B%E8%AE%BE%E7%BD%AE%E6%8C%87%E5%90%91%E4%B8%BB%E6%9C%BA%E4%B8%8A%E7%9A%84MongoDB%E5%AE%9E%E4%BE%8B%EF%BC%9A

   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 xbrowsersync/api
   

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

运行生产级服务

若您没有MongoDB实例或计划将服务暴露到互联网，建议使用提供的https://github.com/xbrowsersync/api-docker/blob/master/docker-compose.yml%EF%BC%8C%E5%AE%83%E5%B0%86%E5%88%9B%E5%BB%BA%E9%85%8D%E7%BD%AE%E5%AE%8C%E6%95%B4%E7%9A%84MongoDB%E6%95%B0%E6%8D%AE%E5%BA%93%E3%80%81xBrowserSync API和Caddy反向代理容器。Caddy会自动获取并更新SSL证书，确保服务通过HTTPS安全运行。

1. 克隆https://github.com/xbrowsersync/api-docker/%E4%BB%93%E5%BA%93%EF%BC%9A

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

2. 打开https://github.com/xbrowsersync/api-docker/blob/master/.env%E6%96%87%E4%BB%B6%EF%BC%8C%E6%9B%B4%E6%96%B0%60API_HOSTNAME%60%E4%B8%BA%E6%9C%8D%E5%8A%A1%E6%9A%B4%E9%9C%B2%E7%9A%84%E4%B8%BB%E6%9C%BA%E5%90%8D%EF%BC%88%E7%A1%AE%E4%BF%9DDNS%E5%B7%B2%E6%8C%87%E5%90%91%E4%B8%BB%E6%9C%BAIP%EF%BC%89%EF%BC%8C%E5%B9%B6%E4%BF%AE%E6%94%B9%60DB_USERNAME%60%E5%92%8C%60DB_PASSWORD%60%E4%B8%BA%E8%87%AA%E5%AE%9A%E4%B9%89%E5%80%BC%E3%80%82

3. （可选）打开https://github.com/xbrowsersync/api-docker/blob/master/settings.json%E6%96%87%E4%BB%B6%EF%BC%8C%E6%B7%BB%E5%8A%A0%E8%87%AA%E5%AE%9A%E4%B9%89%E9%85%8D%E7%BD%AE%E5%80%BC%E3%80%82%E6%B3%A8%E6%84%8F%EF%BC%9A%E4%B8%8D%E8%A6%81%E4%BF%AE%E6%94%B9%60db.host%60%E5%80%BC%E3%80%82

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. 使用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. 使用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%E6%8F%90%E4%BA%A4%EF%BC%9B%E8%8B%A5%E5%8F%91%E7%8E%B0xBrowserSync API本身的问题或需请求新功能，请在https://github.com/xbrowsersync/api/issues/%E6%8F%90%E4%BA%A4%E3%80%82