Skip to content

Introduction

serenity uses JSON for configuration files.

Structure

{
  "log": {},
  "listen": "",
  "tls": {},
  "cache_file": "",
  "outbounds": [],
  "subscriptions": [],
  "templates": [],
  "profiles": [],
  "users": []
}

Fields

log

Log configuration, see Log.

listen

Required

Listen address.

tls

TLS configuration, see TLS.

cache_file

Cache file path.

cache.db will be used if empty.

outbounds

List of Outbound, can be referenced in Profile.

For chained outbounds, use an array of outbounds as an item, and the first outbound will be the entry.

subscriptions

List of Subscription, can be referenced in Profile.

templates

Required

List of Template, can be referenced in Profile.

profiles

Required

List of Profile, can be referenced in User.

users

Required

List of User.

Check

serenity check

Format

serenity format -w -c config.json -D config_directory