SearXNG 项目教程

SearXNG 项目教程

项目地址:https://gitcode.com/gh_mirrors/se/searxng

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

SearXNG 是一个开源的元搜索引擎项目，其目录结构如下：

searxng/
├── docs/
├── searx/
│   ├── static/
│   ├── templates/
│   ├── __init__.py
│   ├── settings.yml
│   ├── search.py
│   └── ...
├── tests/
├── utils/
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
├── setup.py
└── ...

目录结构介绍

• docs/: 包含项目的文档文件。
• searx/: 核心代码目录，包含静态文件、模板、配置文件和主要功能模块。
  • static/: 静态文件目录，如 CSS、JavaScript 文件。
  • templates/: 模板文件目录，包含 HTML 模板。
  • __init__.py: 初始化文件。
  • settings.yml: 配置文件。
  • search.py: 搜索功能的主要实现文件。
• tests/: 测试代码目录。
• utils/: 工具模块目录。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• requirements.txt: 项目依赖文件。
• setup.py: 安装脚本。

2. 项目的启动文件介绍

SearXNG 项目的启动文件是 searx/webapp.py。这个文件负责启动 Web 服务器并加载 SearXNG 应用。

启动文件介绍

• webapp.py: 主要包含以下内容：
  • 导入必要的模块和配置。
  • 初始化应用实例。
  • 配置路由和视图函数。
  • 启动 Web 服务器。

启动 SearXNG 的命令如下：

python searx/webapp.py

3. 项目的配置文件介绍

SearXNG 的配置文件是 searx/settings.yml。这个文件包含了项目的所有配置选项，如搜索引擎列表、语言设置、安全配置等。

配置文件介绍

• settings.yml: 主要包含以下内容：
  • general: 通用设置，如实例名称、语言、主题等。
  • engines: 搜索引擎配置，包括启用哪些搜索引擎、权重设置等。
  • server: 服务器配置，如监听地址、端口、SSL 设置等。
  • outgoing: 出站请求配置，如代理设置、超时设置等。
  • brand: 品牌设置，如 logo、favicon 等。
  • ui: 用户界面设置，如搜索框提示、结果显示设置等。

配置文件示例：

general:
  instance_name: "My SearXNG"
  languages: ["en", "zh"]
  theme: "oscar"

engines:
  - name: "google"
    engine: "google"
    shortcut: "g"
    timeout: 5.0

server:
  port: 8888
  bind_address: "0.0.0.0"
  secret_key: "your_secret_key"

outgoing:
  pool_connections: 100
  pool_maxsize: 100
  max_retries: 3

brand:
  logo: "searxng.png"
  favicon: "favicon.ico"

ui:
  search_on_category_select: true
  autocomplete: "google"

通过修改 settings.yml 文件，可以定制 SearXNG 的行为和外观。

searxng SearXNG 是一个免费的互联网元搜索引擎，它聚合了来自不同搜索服务和数据库的结果。用户不会被追踪或建立档案。 项目地址: https://gitcode.com/gh_mirrors/se/searxng