mirror of
https://github.com/XTLS/Xray-docs-next.git
synced 2025-01-20 17:51:40 +03:00
d20c42f63e
* Updated HTTPUpgrade docs. * Root config object and transport configs. * WTF happened to the English docs * Fuck this. * Reality done. * WebSocket * Minor correction.
81 lines
2.3 KiB
Markdown
81 lines
2.3 KiB
Markdown
---
|
|
title: Configurations
|
|
lang: en-US
|
|
---
|
|
|
|
> **This section will tell you all the details of Xray configuration. By mastering these contents, Xray will unleash its full power in your hands.**
|
|
|
|
## Overview
|
|
|
|
The configuration file of Xray is in JSON format, and the configuration format for the client and server is the same, except for the actual configuration content. It takes the following form:
|
|
|
|
```json
|
|
{
|
|
"log": {},
|
|
"api": {},
|
|
"dns": {},
|
|
"routing": {},
|
|
"policy": {},
|
|
"inbounds": [],
|
|
"outbounds": [],
|
|
"transport": {},
|
|
"stats": {},
|
|
"reverse": {},
|
|
"fakedns": {},
|
|
"metrics": {}
|
|
}
|
|
```
|
|
|
|
::: warning
|
|
If you are new to Xray, you can first click to view [configuration and running in the Quick Start guide](../document/install.md), to learn the most basic configuration method, and then refer to the contents of this section to master all the configuration methods of Xray.
|
|
:::
|
|
|
|
## Basic Configuration Modules
|
|
|
|
> log:[LogObject](./log.md)
|
|
|
|
Log configurations, controlling how Xray emits logs.
|
|
|
|
> api:[ApiObject](./api.md)
|
|
|
|
Configures how Xray provides API interfaces for calling remotely.
|
|
|
|
> dns: [DnsObject](./dns.md)
|
|
|
|
Configures the built-in DNS server. System DNS will be used if not configured.
|
|
|
|
> routing: [RoutingObject](./routing.md)
|
|
|
|
Configures routing. Specify rules to route connections through different outbounds.
|
|
|
|
> policy: [PolicyObject](./policy.md)
|
|
|
|
Local policy configurations, specifying different user levels and corresponding policies.
|
|
|
|
> inbounds: \[ [InboundObject](./inbound.md) \]
|
|
|
|
An array of inbound connection configurations.
|
|
|
|
> outbounds: \[ [OutboundObject](./outbound.md) \]
|
|
|
|
An array of outbound connection configurations.
|
|
|
|
> transport: [TransportObject](./transport.md)
|
|
|
|
Configures how Xray establishes and uses network connections to other servers.
|
|
|
|
> stats: [StatsObject](./stats.md)
|
|
|
|
Configures traffic statistics.
|
|
|
|
> reverse: [ReverseObject](./reverse.md)
|
|
|
|
Configures the built-in reverse proxy. You can forward server traffic to the client, effectively achieving reverse proxying.
|
|
|
|
> fakedns: [FakeDnsObject](./fakedns.md)
|
|
|
|
FakeDNS configuration. Can be used with a transparent proxy to obtain the actual domains.
|
|
|
|
> metrics: [metricsObject](./metrics.md)
|
|
|
|
Metrics configuration. A more straightforward (and hopefully better) way to export metrics. |