开源项目 PiPass/blockpage 使用教程

开源项目 PiPass/blockpage 使用教程

blockpageA temporary unblock solution and blockpage for your Pi-Hole system项目地址:https://gitcode.com/gh_mirrors/bl/blockpage

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

PiPass/blockpage 项目的目录结构如下：

blockpage/
├── README.md
├── blockpage.py
├── config.yaml
├── templates/
│   └── blockpage.html
└── static/
    └── style.css

目录介绍

• README.md: 项目说明文件，包含项目的基本信息和使用说明。
• blockpage.py: 项目的启动文件，负责处理请求和显示阻止页面。
• config.yaml: 项目的配置文件，包含项目的各种配置选项。
• templates/: 存放模板文件的目录，包含阻止页面的 HTML 模板。
• static/: 存放静态文件的目录，包含阻止页面的 CSS 样式文件。

2. 项目的启动文件介绍

blockpage.py 是项目的启动文件，主要负责处理 HTTP 请求并显示阻止页面。以下是该文件的主要功能和代码结构：

from flask import Flask, render_template
import yaml

app = Flask(__name__)

# 加载配置文件
with open('config.yaml', 'r') as f:
    config = yaml.safe_load(f)

@app.route('/')
def index():
    return render_template('blockpage.html', config=config)

if __name__ == '__main__':
    app.run(host='0.0.0.0', port=config['port'])

主要功能

• 使用 Flask 框架创建一个 Web 应用。
• 从 config.yaml 文件中加载配置信息。
• 定义一个路由 /，当访问根路径时，渲染 templates/blockpage.html 模板并传递配置信息。
• 根据配置文件中的端口信息启动 Web 服务器。

3. 项目的配置文件介绍

config.yaml 是项目的配置文件，包含项目的各种配置选项。以下是一个示例配置文件的内容：

port: 8080
title: "PiPass Block Page"
message: "This site has been blocked by PiPass."

配置项介绍

• port: 指定 Web 服务器监听的端口号。
• title: 阻止页面的标题。
• message: 阻止页面的提示信息。

通过修改 config.yaml 文件中的配置项，可以自定义阻止页面的显示内容和行为。

---

以上是 PiPass/blockpage 项目的使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。

blockpageA temporary unblock solution and blockpage for your Pi-Hole system项目地址:https://gitcode.com/gh_mirrors/bl/blockpage