Bitcoin Node Manager 使用教程

1. 项目目录结构及介绍

Bitcoin Node Manager（BNM）项目的目录结构如下：

bitcoin-node-manager/
├── .github/              # GitHub 工作流程文件夹
│   └── workflows/
├── assets/               # 静态资源文件夹，包含 CSS、JS 文件等
├── data/                 # 存储数据文件夹，包括规则、日志和节点信息
├── src/                  # 源代码文件夹
│   ├── Config.php        # 配置文件
│   ├── Config.sample.php # 配置文件样本
│   ├── index.php         # 入口文件
│   └── views/            # 视图文件夹
├── .gitattributes
├── .gitignore
├── CHANGELOG.md          # 更改日志
├── LICENSE               # 开源协议文件
├── README.md             # 项目说明文件
├── composer.json         # PHP 依赖文件
├── docker-compose.yml    # Docker 配置文件
└── login.html            # 登录页面

• .github/: 包含 GitHub Actions 工作流程文件。
• assets/: 存储静态资源，如样式表和脚本文件。
• data/: 存储项目运行时生成的数据，如规则、日志和节点信息。
• src/: 源代码文件夹，包括配置文件、入口文件和视图。
  • Config.php: 项目的主要配置文件。
  • Config.sample.php: 配置文件的示例，用于创建自定义配置文件时参考。
  • index.php: 项目的入口点，用户通过这个文件访问和管理节点。
  • views/: 包含项目页面模板的文件夹。
• .gitattributes: 指定如何处理不同文件类型的 Git 属性。
• .gitignore: 指定 Git 应该忽略的文件和目录。
• CHANGELOG.md: 记录了项目的所有重大更新和更改。
• LICENSE: 项目使用的开源协议，本项目采用 MIT 协议。
• README.md: 提供了项目的基本信息和使用说明。
• composer.json: 定义了项目的 PHP 依赖。
• docker-compose.yml: 定义了使用 Docker 部署项目时的服务配置。
• login.html: 项目的登录页面。

2. 项目的启动文件介绍

项目的启动文件是 index.php。当用户访问 BNM 项目时，这个文件会被加载。它负责初始化应用程序并加载必要的资源和库。以下是一个简化的 index.php 文件内容：

<?php
// 引入自动加载文件
require __DIR__ . '/vendor/autoload.php';

// 引入配置文件
$config = require __DIR__ . '/src/Config.php';

// 初始化应用程序
$app = new \Slim\App($config);

// 加载路由和中间件
require __DIR__ . '/src/routes.php';
require __DIR__ . '/src/middleware.php';

// 运行应用程序
$app->run();

3. 项目的配置文件介绍

项目的配置文件是 Config.php，它存储了项目的所有配置信息，如数据库连接、Bitcoin Core RPC 凭据和 BNM 密码等。以下是 Config.php 文件的基本结构：

<?php

return [
    'settings' => [
        'displayErrorDetails' => true, // 是否显示错误信息
        'addContentLengthHeader' => false, // 是否添加内容长度头
        // 其他设置...
    ],
    'dependencies' => [
        // 定义服务容器依赖
    ],
    'bitcoin' => [
        'rpc' => [
            'username' => 'your_rpc_username', // Bitcoin Core RPC 用户名
            'password' => 'your_rpc_password', // Bitcoin Core RPC 密码
            'host' => 'localhost',             // Bitcoin Core RPC 地址
            'port' => '8332',                   // Bitcoin Core RPC 端口
        ],
    ],
    'bnm' => [
        'password' => 'your_bnm_password', // BNM 管理密码
        // 其他 BNM 配置...
    ],
    // 其他配置...
];

在部署项目前，需要将 Config.sample.php 复制为 Config.php 并填写实际的配置信息。务必保护此文件，不要将其暴露在公共可访问的地方。