Skip to main content
DeepLX can be configured using command-line flags when starting the application. Flags take precedence over environment variables.

​
Server Configuration

​
-ip
string
default:"0.0.0.0"
Set the IP address to bind to. Short form: -iExample:
./deeplx -ip 127.0.0.1
# or using short form
./deeplx -i 127.0.0.1
Use 0.0.0.0 to listen on all interfaces, or 127.0.0.1 to only accept local connections.
​
-port
integer
default:"1188"
Set the port to listen on. Short form: -pExample:
./deeplx -port 8080
# or using short form
./deeplx -p 8080

​
Authentication

​
-token
string
default:""
Set the access token for the /translate endpoints. When configured, all API requests must include this token for authentication.Example:
./deeplx -token "your-secret-token"
The token can be provided by clients via query parameter ?token=xxx or Authorization header. See Authentication for details.
​
-s
string
default:""
Set the dl-session cookie for the /v1/translate Pro endpoint. This flag has no long form.Example:
./deeplx -s "your-dl-session-cookie"
This must be from a DeepL Pro account. Free account sessions (containing a .) will be rejected.

​
Network Configuration

​
-proxy
string
default:""
Set the proxy URL for HTTP requests to DeepL.Example:
# HTTP proxy
./deeplx -proxy "http://proxy.example.com:8080"

# HTTPS proxy
./deeplx -proxy "https://proxy.example.com:8080"

# SOCKS5 proxy
./deeplx -proxy "socks5://proxy.example.com:1080"

​
Complete Examples

# Start DeepLX with custom port
./deeplx -port 8080

​
Flag Precedence

Command-line flags take precedence over environment variables. If both are set, the flag value will be used.
Example: 
# Environment variable sets PORT=1188
export PORT=1188

# Flag overrides it to 8080
./deeplx -port 8080

# Server will listen on port 8080

​
Available Short Forms

Long FormShort FormPurpose
-ip-iIP address to bind
-port-pPort to listen on
N/A-sDL session cookie
The -token and -proxy flags do not have short forms.

Build docs developers (and LLMs) love

Get started for freeTalk to us