Introduction

sing-box uses JSON for configuration files.

Structure

json

{
  "$schema": "https://sing-box.sagernet.org/schema.json",
  "log": {},
  "dns": {},
  "ntp": {},
  "certificate": {},
  "certificate_providers": [],
  "http_clients": [],
  "network_namespaces": [],
  "endpoints": [],
  "inbounds": [],
  "outbounds": [],
  "route": {},
  "services": [],
  "experimental": {}
}

Fields

Key	Format
`$schema`	JSON Schema
`log`	Log
`dns`	DNS
`ntp`	NTP
`certificate`	Certificate
`certificate_providers`	Certificate Provider
`http_clients`	HTTP Client
`network_namespaces`	Network Namespace
`endpoints`	Endpoint
`inbounds`	Inbound
`outbounds`	Outbound
`route`	Route
`services`	Service
`experimental`	Experimental

Check

bash

sing-box check

Format

bash

sing-box format -w -c config.json -D config_directory

Merge

bash

sing-box merge output.json -c config.json -D config_directory