ITADN
eduardolat/pgbackweb
README.md
以下内容由 AI 翻译,如有问题请点此提交 issue 反馈

PG Back Web

🐘 通过用户友好的 Web 界面轻松实现 PostgreSQL 备份!🌐💾

CI Status Go Report Card Release Version Docker Pulls License

[!NOTE] 我们在成长!新名称,更广阔的未来

PG Back Web 正在成为 UFO Backup!新名称反映了项目未来将超越 PostgreSQL 的愿景,让强大的备份功能变得简单且人人可用

对路线图感到好奇,或想塑造项目的未来?加入 社区 讨论想法并影响决策,欢迎所有人的意见!

赞助商

感谢以下赞助商对 PG Back Web 的支持!您的贡献帮助项目持续运行和发展!🚀

Become a sponsor
成为赞助商
FetchGoat - Simplifying Logistics
FetchGoat - 简化物流

为什么选择 PG Back Web?

PG Back Web 不仅仅是一个备份工具。它是确保您的 PostgreSQL 数据安全性和可用性的可靠伙伴:

  • 🎯 为每个人设计:从个人开发者到团队。
  • ⏱️ 节省时间:自动化您的备份,忘掉手动任务。
  • 即插即用:不要浪费时间在复杂的配置上。

功能

  • 📦 直观的 Web 界面:轻松管理您的备份,无需数据库专业知识。
  • 📅 计划备份:设置后无需操心。PG Back Web 会处理其余部分。
  • 📈 备份监控:通过执行日志可视化您的备份状态。
  • 📤 即时下载与恢复:在需要时直接从 Web 界面恢复和下载您的备份。
  • 🖥 多版本支持:兼容 PostgreSQL 13、14、15、16、17 和 18。
  • 📁 本地与 S3 存储:将备份存储在本地,或添加任意数量的 S3 存储桶以获得更大的灵活性。
  • ❤️‍🩹 健康检查:自动检查您的数据库和目的地的健康状况。
  • 🔔 Webhooks:当备份完成、失败、健康检查失败或其他事件发生时,接收通知。
  • 🔒 安全优先:使用 PGP 加密保护您的敏感信息。
  • 🛡️ 开源信任:基于 AGPL v3 许可协议的开源代码,由强大的 pg_dump 工具提供支持。
  • 🌚 深色模式:因为我们都喜欢深色模式。

安装

PG Back Web 以 Docker 镜像形式提供。您只需设置 3 个环境变量即可开始使用!

以下是使用 Docker Compose 运行 PG Back Web 的示例,请根据您的需要进行调整:

services:
  pgbackweb:
    image: eduardolat/pgbackweb:latest
    ports:
      - "8085:8085" # Access the web interface at http://localhost:8085
    volumes:
      - ./backups:/backups # If you only use S3 destinations, you don't need this volume
    environment:
      # Optional environment variables are ignored, see the configuration section below for more details
      PBW_ENCRYPTION_KEY: "my_secret_key" # Change this to a strong key
      PBW_POSTGRES_CONN_STRING: "postgresql://postgres:password@postgres:5432/pgbackweb?sslmode=disable"
    depends_on:
      postgres:
        condition: service_healthy

  postgres:
    image: postgres:18
    environment:
      POSTGRES_USER: postgres
      POSTGRES_DB: pgbackweb
      POSTGRES_PASSWORD: password
    ports:
      - "5432:5432"
    volumes:
      - ./data:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U postgres"]
      interval: 5s
      timeout: 5s
      retries: 5

你可以观看这个 YouTube 视频,了解设置 PG Back Web 有多简单。

配置

你只需要配置以下环境变量:

  • PBW_ENCRYPTION_KEY: 你的加密密钥。请生成一个强随机密钥并妥善保管,因为 PG Back Web 使用它来加密敏感数据。

  • PBW_POSTGRES_CONN_STRING: 用于存储 PG Back Web 数据的 PostgreSQL 数据库的连接字符串。

  • PBW_LISTEN_HOST: 可选。服务器监听的 Host,默认 0.0.0.0

  • PBW_LISTEN_PORT: 可选。服务器监听的 Port,默认 8085

  • PBW_PATH_PREFIX: 可选。应用程序 URL 的路径前缀。当你希望将应用程序部署在子路径下时使用此选项(例如,/pgbackweb)。必须以 / 开头且不能以 / 结尾。默认为空。

  • TZ: 可选。你的时区。默认为 UTC。这会影响日志记录、备份文件名以及 Web 界面中的默认时区。

截图

重置密码

您可以在运行 PG Back Web 的服务器上执行以下命令来重置您的 PG Back Web 密码:

docker exec -it <container_name_or_id> sh -c change-password

你应该将 <container_name_or_id> 替换为 PG Back Web 容器的名称或 ID,然后只需按照说明操作即可。

后续步骤

在此链接中,你可以查看已确认为未来更新的功能列表:

后续步骤 ⏭️

成为赞助商

🙏 感谢为支持本项目而慷慨解囊的杰出赞助商!您的贡献有助于 PG Back Web 的持续运行与发展。如果您希望加入并成为赞助商,请访问 赞助页面 并成为伟大事业的一部分! 🚀

🥇 金牌赞助商

Become a gold sponsor
成为金牌赞助商
FetchGoat - Simplifying Logistics
FetchGoat - Simplifying Logistics

🥈 银牌赞助商

Become a silver sponsor
成为银牌赞助商

🥉 铜牌赞助商

Become a bronze sponsor
成为青铜赞助商

加入社区

有改进 PG Back Web 的想法吗?请为该项目做出贡献!欢迎提出任何建议和 Pull Request。

许可证

本项目 100% 开源,采用 AGPL v3 许可证 - 详见 LICENSE 文件。


💖 喜欢 Love PG Back Web? 请在 GitHub 上给我们一个 ⭐,并与您的同事分享该项目。一起,我们可以让 PostgreSQL 备份对每个人更加易用!