Files
frp-panel/docs/en/all-configs.md
2025-05-25 11:06:08 +00:00

5.8 KiB
Raw Blame History

Configuration Reference

Advanced frp Tunnel Configuration

This panel fully supports frps original JSON configuration format. Simply paste your configuration JSON into the Server/Client Advanced Mode editor and save. For detailed usage, see the frp documentation.

Startup Configuration Files

The application loads configuration in the following order:

  1. .env in the working directory
  2. /etc/frpp/.env

Environment Variable Reference

Documentation may be somewhat outdated…

For the complete and latest configuration reference, see: settings.go

Type Environment Variable Default Description
string APP_SECRET Application secret used to encrypt communication between Client, Server, and Master
string APP_GLOBAL_SECRET frp-panel Global secret used to generate keys. Keep this value secure.
int APP_COOKIE_AGE 86400 Cookie lifetime in seconds (default: 1 day)
string APP_COOKIE_NAME frp-panel-cookie Cookie name
string APP_COOKIE_PATH / Cookie path
string APP_COOKIE_DOMAIN Cookie domain
bool APP_COOKIE_SECURE false Whether the cookie is marked Secure
bool APP_COOKIE_HTTP_ONLY true Whether the cookie is HTTP-only
bool APP_ENABLE_REGISTER false Enable user registration. Only the first user can register (administrator).
int MASTER_API_PORT 9000 Master API port
string MASTER_API_HOST Master API host (can be behind a reverse proxy or CDN)
string MASTER_API_SCHEME http Master API scheme (for client command generation; HTTPS must be handled via reverse proxy)
int MASTER_CACHE_SIZE 10 Cache size in MB
string MASTER_RPC_HOST 127.0.0.1 Master RPC host or public IP
int MASTER_RPC_PORT 9001 Master RPC port
bool MASTER_COMPATIBLE_MODE false Compatibility mode for official frp clients
string MASTER_INTERNAL_FRP_SERVER_HOST Host for Masters built-in frps instance (for client connections)
int MASTER_INTERNAL_FRP_SERVER_PORT 9002 Port for Masters built-in frps instance (for client connections)
string MASTER_INTERNAL_FRP_AUTH_SERVER_HOST 127.0.0.1 Host for Masters built-in frps authentication service
int MASTER_INTERNAL_FRP_AUTH_SERVER_PORT 8999 Port for Masters built-in frps authentication service
string MASTER_INTERNAL_FRP_AUTH_SERVER_PATH /auth Path for Masters built-in frps authentication service
int SERVER_API_PORT 8999 Server API port
string DB_TYPE sqlite3 Database type (e.g., mysql, postgres, sqlite3)
string DB_DSN data.db Database DSN. For sqlite3, this is a file path (default in working directory). For other databases, use DSN.
string CLIENT_ID Client ID
string CLIENT_SECRET Client secret