Nginx/Docker Config Error? Ultimate Tip to Locate JSON/YAML Syntax Errors in One Second

Configuration Files: An Ops Nightmare

"I only changed one line of config, why is the service down?"
This is a moment of despair that every operations engineer has experienced.

Whether it's Nginx's nginx.conf, Kubernetes' YAML resource manifest, or Docker's daemon.json, their requirements for format are almost pathological:

• JSON: No trailing commas allowed, and quotes must be double quotes.
• YAML: Indentation must be spaces, not Tabs, and a single wrong level of indentation can break everything.

Typical "Crash" Scenes

JSON's "Trailing Comma"

{
  "log-driver": "json-file",
  "log-opts": {
    "max-size": "10m",  <-- This is fine
  },                    <-- Fatal error! JSON does not allow a comma after the last element
}

If you write this into daemon.json, the Docker service will fail to start, and the error message is often vague.

YAML's "Indentation Trap"

services:
  web:
    image: nginx
   ports:      <-- One space missing
     - "80:80"

The naked eye can hardly see the difference, but the parser will think ports does not belong to web, causing the port mapping to fail.

How to Solve it Elegantly?

1. Don't use Notepad, use an IDE

If you are still using Windows Notepad or vim (without plugins) to change configs, you are really making it hard for yourself.
Modern editors like VS Code have built-in syntax checking.

2. Command Line Validation Tools

• JSON: Use jq

  cat config.json | jq .
  

  If there's an error, it will report it with the exact line number.

• YAML: Use yq or python

  python3 -c 'import yaml,sys;yaml.safe_load(sys.stdin)' < config.yaml
  

3. Online Visual Validation (Recommended)

When you don't have an environment at hand or need to quickly format a messy JSON, online tools are the most efficient.

Our JSON Formatter and Validator provides the following features:

• 🚨 Real-time Error Correction: Precisely points out which line and column have problems.
• 🎨 Automatic Beautification: One-click to expand compressed single-line JSON into a beautiful indented format.
• 🌳 Tree View: Supports clicking to collapse levels, making it easy to view the structure of large configuration files.

Don't let a punctuation mark ruin your weekend. Before modifying the config next time, run it through the JSON Formatter Tool first.