PG Back Web 项目使用教程

PG Back Web 项目使用教程

pgbackweb 🐘 Effortless PostgreSQL backups with a user-friendly web interface! 🌐💾 项目地址: https://gitcode.com/gh_mirrors/pg/pgbackweb

1. 项目的目录结构及介绍

PG Back Web 是一个用于简化 PostgreSQL 数据库备份的开源项目。以下是项目的目录结构及其简单介绍：

pgbackweb/
├── .devcontainer/
├── .github/
│   └── workflows/
├── .vscode/
├── assets/
├── cmd/
├── docker/
├── internal/
├── scripts/
├── .env.dev
├── .env.example
├── .gitignore
├── .golangci.yaml
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── deno.json
├── deno.lock
├── go.mod
├── go.sum
├── sqlc.yaml
├── tailwind.config.ts
└── taskfile.yaml

• .devcontainer/: 包含开发容器配置。
• .github/workflows/: 包含 GitHub Actions 工作流文件，用于自动化构建、测试等。
• .vscode/: 包含 Visual Studio Code 的项目配置。
• assets/: 存放静态资源，如图标、样式表等。
• cmd/: 包含程序的入口文件和主要逻辑。
• docker/: 包含 Docker 相关的配置文件。
• internal/: 包含项目内部使用的库和模块。
• scripts/: 包含项目的辅助脚本。
• .env.dev 和 .env.example: 包含开发环境的配置文件示例。
• .gitignore: 指定 Git 忽略的文件和目录。
• .golangci.yaml: 包含 Go 语言风格和静态分析工具的配置。
• CONTRIBUTING.md: 包含贡献指南。
• LICENSE: 包含项目许可证信息。
• README.md: 项目描述和基本信息。
• 其他文件：项目依赖和配置文件。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/pgbackweb/main.go。以下是该文件的主要功能：

• 设置日志记录器。
• 加载配置文件。
• 初始化数据库连接。
• 设置 HTTP 服务器，并监听指定端口。
• 处理 HTTP 请求，并提供相应的服务。

package main

import (
    "github.com/eduardolat/pgbackweb/internal/app"
    "log"
)

func main() {
    // 初始化应用配置
    cfg, err := app.NewConfig()
    if err != nil {
        log.Fatalf("error loading config: %v", err)
    }

    // 初始化应用
    app, err := app.New(cfg)
    if err != nil {
        log.Fatalf("error creating app: %v", err)
    }

    // 运行应用
    if err := app.Run(); err != nil {
        log.Fatalf("error running app: %v", err)
    }
}

3. 项目的配置文件介绍

项目的配置文件通常位于项目根目录下的 .env.example 文件中，这是一个示例配置文件，实际使用时应将其复制为 .env 并根据实际情况进行修改。

以下是配置文件中可能包含的一些配置项：

PBW_ENCRYPTION_KEY=your_secret_key
PBW_POSTGRES_CONN_STRING=postgresql://user:password@localhost:5432/dbname?sslmode=disable
PBW_LISTEN_HOST=0.0.0.0
PBW_LISTEN_PORT=8085
TZ=Asia/Shanghai

• PBW_ENCRYPTION_KEY: 加密密钥，用于加密敏感数据。
• PBW_POSTGRES_CONN_STRING: PostgreSQL 数据库连接字符串。
• PBW_LISTEN_HOST: 服务器监听的地址。
• PBW_LISTEN_PORT: 服务器监听的端口。
• TZ: 服务器时区配置。

确保正确配置这些环境变量，以便应用能够正确运行。

pgbackweb 🐘 Effortless PostgreSQL backups with a user-friendly web interface! 🌐💾 项目地址: https://gitcode.com/gh_mirrors/pg/pgbackweb