redis.master

• host (类型：字符串，允许：主机名，IPv4，IPv6，默认：localhost）— 目标主Redis主机
• port (类型：整数，允许：TCP端口，默认：6379）— 目标主Redis TCP端口
• password (类型：字符串，允许：密码值，默认：无) — 主Redis密码（如果没有密码，不要设置此键）

[redis.rescue]

• host (类型：字符串，允许：主机名，IPv4，IPv6，默认：localhost）— 只读救援Redis主机
• port (类型：整数，允许：TCP端口，默认：6379）— 只读救援Redis TCP端口
• password (类型：字符串，允许：密码值，默认：无) — 只读救援Redis密码（如果没有密码，不要设置此键）

初始化GeoIP

由于Constellation在其仓库中没有分发GeoIP数据库，您在第一次运行Constellation之前需要从MaxMind获取它（否则Constellation将拒绝启动）。

执行提供的脚本

./scripts/init_geoip.sh --许可证密钥=YOUR_GEOLITE2_LICENSE_KEY

YOUR_GEOLITE2_LICENSE_KEY应替换为有效的GeoLite2许可证密钥。请遵循MaxMind提供的说明以获取许可证密钥。

请注意，一旦Constellation从您手动初始化的GeoIP数据库启动，它将通过在后台自动检查和应用更新来保持数据库的最新状态。数据库初始化是一次性操作。请确保您的许可证密钥也设置在配置中的GeoIP更新URL。

运行Constellation

Constellation可以这样运行

./constellation -c/path/to/config.cfg

测试Constellation

运行后，可以在本地网络中对Constellation进行DNS查询（使用默认配置）

dig subdomain.中继.crisp.聊天@::1

请注意，可以使用dig实用工具通过@修饰符指向特定服务器，这里使用IPv6 localhost: ::1。

🛰 HTTP REST API

Constellation HTTP REST API监听配置文件config.cfg中的http.inet接口。您可以使用它来满足您的管理和监控需求。

如果您想轻松地尝试API，一个最新的Paw文件包含所有API路由和示例请求。在此处下载适用于您的Mac的Paw应用程序（Paw是开发者用来测试他们API的工具）。

1. DNS记录管理

要检查、读取、插入、修改和删除DNS记录，您可以使用zone API资源。

API概述

端点URL

HTTPhttp://constellation.local:8080/zone/<zone_name>/record/<record_name>/<record_type>/

其中

• zone_name：区域名称（即基础域名），例如：relay.crisp.chat
• record_name：要读取或修改的记录名称（即子域名或基础域名），例如：client.@ 对于 client.relay.crisp.chat FQDN，或 @ 对于 relay.crisp.chat FQDN
• record_type：要读取或修改 record_name 的 DNS 记录类型；可以是：a、aaaa、cname、mx、txt、caa 或 ptr（如果您需要其他记录类型支持，请提交问题）

请求头

• 添加一个带有 Authorization 的请求头，使用 Basic 认证，密码为您的配置 http.record_token。

Geo-DNS 区域

如果您想使用 Geo-DNS 功能向最近的服务器提供记录，您将需要通过 API 设置 regions，其中

• 美洲

  • nnam：北美北部
  • snam：北美南部
  • nsam：南美北部
  • ssam：南美南部

• 欧洲

  • weu：西欧
  • ceu：中欧
  • eeu：东欧
  • ru：俄罗斯

• 中东

  • me：中东

• 非洲

  • naf：北非
  • maf：中非
  • saf：南非

• 亚洲

  • in：印度
  • seas：东南亚
  • neas：东北亚

• 大洋洲

  • oc：大洋洲

Geo-DNS 黑洞

如果您想使用 Geo-DNS 功能针对被阻止的国家返回空的 DNS 响应，您将需要通过 API 设置 blackhole，为一个黑名单 ISO-3166 Alpha-2 国家代码 列表（例如，FR 代表法国）。

健康检查的救援记录

如果您正在对区域域使用健康检查，您可能需要指定救援记录，在所有常规记录（标准和 Geo-DNS）都被视为无效的情况下，这些记录将被提供给 DNS 客户端。您可以在 API 中设置 rescue 属性以确保在默认服务器失败的情况下，只有故障转移服务器被提供并连接。

如果您没有设置任何 rescue 记录；在所有常规记录都被报告为无效的情况下，DNS 客户端将收到一个空的响应。因此，您仍然应该提供备用记录。

CNAME 层叠

CNAME记录可以方便地在单个DNS条目中集中记录值，并在多个DNS CNAME条目中重复使用。然而，它也有一些限制，例如，按照DNS RFC规定，它不能与同一子域上的其他记录共享。在域根目录下设置CNAME也是非法的。此外，CNAME需要DNS解析器执行第二次解析步骤来解析平面值（例如，A、AAAA、TXT等记录），这并不高效，因为它增加了用户通过CNAME解析域名时的额外延迟。

如果遇到DNS RFC中CNAME记录类型的边缘情况，CNAME扁平化可以帮助您。它允许Constellation解析实际平面值，并立即提供服务，而不是返回实际的CNAME。可以通过在API中将flatten属性设置为true来为记录启用CNAME扁平化。默认情况下，不执行CNAME扁平化。

一个专门的Constellation线程管理之前扁平化的CNAME值，并随着它们在远程DNS服务器上的更改而更新它们。此外，如果缓存的扁平化CNAME长时间未使用，则将其从缓存中删除。请注意，为了尽快响应用户，如果启用扁平化的CNAME值尚未在缓存中，则Constellation将以CNAME的形式回答，并将延迟扁平化命令委托给扁平化管理线程，以避免减慢对请求用户的初始响应。一旦扁平化管理线程完成其工作，进一步的DNS查询到CNAME将使用扁平化的值回答（例如，它将返回平面A记录值，而不是CNAME值）。

请注意，flatten选项仅适用于具有CNAME值的记录。如果在例如A记录类型上启用了扁平化，则flatten属性将没有任何效果。

API路由

检查DNS记录是否存在

HTTP HEADhttp://constellation.local:8080/zone/<zone_name>/record/<record_name>/<record_type>/

示例请求

HEAD /zone/relay.crisp.chat/record/@/a HTTP/1.1
Authorization: Basic OlJFUExBQ0VfVEhJU19XSVRIX0FfU0VDUkVUX0tFWQ==

示例响应

HTTP/1.1 200 OK

获取DNS记录

HTTP GEThttp://constellation.local:8080/zone/<zone_name>/record/<record_name>/<record_type>/

示例请求

GET /zone/relay.crisp.chat/record/@/a HTTP/1.1
Authorization: Basic OlJFUExBQ0VfVEhJU19XSVRIX0FfU0VDUkVUX0tFWQ==

示例响应

HTTP/1.1 200 OK
Content-Type: application/json

{"type":"a","name":"@","ttl":600,"blackhole": null,"regions": null,"values":["159.89.97.13","46.101.18.133"]}

写入DNS记录（或覆盖现有记录）

HTTP PUThttp://constellation.local:8080/zone/<zone_name>/record/<record_name>/<record_type>/

示例请求（标准）

PUT /zone/relay.crisp.chat/record/@/a HTTP/1.1
Authorization: Basic OlJFUExBQ0VfVEhJU19XSVRIX0FfU0VDUkVUX0tFWQ==
Content-Type: application/json; charset=utf-8

{"values":["159.89.97.13","46.101.18.133"],"ttl":600}

示例请求（地理DNS）

PUT /zone/relay.crisp.chat/record/@/cname HTTP/1.1
Authorization: Basic OlJFUExBQ0VfVEhJU19XSVRIX0FfU0VDUkVUX0tFWQ==
Content-Type: application/json; charset=utf-8

{"regions":{"nnam":["client.nnam.geo.relay.crisp.net"],"snam":["client.snam.geo.relay.crisp.net"],"nsam":["client.nsam.geo.relay.crisp.net"],"ssam":["client.ssam.geo.relay.crisp.net"],"weu":["client.weu.geo.relay.crisp.net"],"ceu":["client.ceu.geo.relay.crisp.net"],"eeu":["client.eeu.geo.relay.crisp.net"],"ru":["client.ru.geo.relay.crisp.net"],"me":["client.me.geo.relay.crisp.net"],"naf":["client.naf.geo.relay.crisp.net"],"maf":["client.maf.geo.relay.crisp.net"],"saf":["client.saf.geo.relay.crisp.net"],"in":["client.in.geo.relay.crisp.net"],"seas":["client.seas.geo.relay.crisp.net"],"neas":["client.neas.geo.relay.crisp.net"],"oc":["client.oc.geo.relay.crisp.net"]},"values":["client.default.geo.relay.crisp.net"],"ttl":600}

示例请求（健康检查）

PUT /zone/relay.crisp.chat/record/@/a HTTP/1.1
Authorization: Basic OlJFUExBQ0VfVEhJU19XSVRIX0FfU0VDUkVUX0tFWQ==
Content-Type: application/json; charset=utf-8

{"values":["159.89.97.13","46.101.18.133"],"rescue":["139.59.174.13"],"ttl":60}

示例响应

HTTP/1.1 200 OK

示例请求（CNAME扁平化）

PUT /zone/relay.crisp.chat/record/@/cname HTTP/1.1
Authorization: Basic OlJFUExBQ0VfVEhJU19XSVRIX0FfU0VDUkVUX0tFWQ==
Content-Type: application/json; charset=utf-8

{"values":["alias.crisp.net"],"flatten":true,"ttl":60}

示例响应

HTTP/1.1 200 OK

删除DNS记录

HTTP DELETEhttp://constellation.local:8080/zone/<zone_name>/record/<record_name>/<record_type>/

示例请求

DELETE /zone/relay.crisp.chat/record/@/a HTTP/1.1
Authorization: Basic OlJFUExBQ0VfVEhJU19XSVRIX0FfU0VDUkVUX0tFWQ==

示例响应

HTTP/1.1 200 OK

2. 服务器使用情况指标检索

要获取服务器使用情况指标（例如，哪些国家的DNS请求），您可以使用metrics API资源。

API概述

端点URL

HTTPhttp://constellation.local:8080/zone/<zone_name>/metrics/<metrics_timespan>/<metrics_category>/<metrics_type>

其中

• zone_name：区域名称（即基础域名），例如：relay.crisp.chat
• metrics_timespan：返回指标的时长（可以是：1m、5m或15m），代表：过去'n分钟'的指标
• metrics_category：指标类别（可以是：query或answer）
• metrics_type：类别中的指标类型（如果类别是query，则为types或origins，如果类别是answer，则为codes）

请求头

• 添加一个带有 Authorization 的请求头，使用 Basic 认证，密码为您的配置 http.record_token。

API路由

获取指标

HTTP GEThttp://constellation.local:8080/zone/<zone_name>/metrics/<metrics_timespan>/<metrics_category>/<metrics_type>/

示例请求

GET /zone/relay.crisp.chat/metrics/5m/query/origins HTTP/1.1
Authorization: Basic OlJFUExBQ0VfVEhJU19XSVRIX0FfU0VDUkVUX0tFWQ==

示例响应

HTTP/1.1 200 OK
Content-Type: application/json

{"fr":1203,"us":899,"lv":23,"gb":10,"other":2}

🔥 报告漏洞

如果您在Constellation中发现漏洞，您非常欢迎通过发送加密电子邮件到[email protected]直接向@valeriansaliou报告。请不要在公共GitHub问题中报告漏洞，因为恶意人员可能会利用这些漏洞针对运行未打补丁的Constellation实例的生产服务器。

⚠️ 您必须使用 @valeriansaliou GPG 公钥加密您的电子邮件：🔑valeriansaliou.gpg.pub.asc。