lukacu / docker-frpc

Docker container for automatically configuring FRP proxy client using docker-gen.

Docker container for automatically configuring FRP client using docker-gen.

Environment configuration:

• FRPC_SERVER_ADDRESS - connect to FRP server address, defaults to 127.0.0.1
• FRPC_SERVER_PORT - connect to FRP server port, defaults to 7000
• FRPC_AUTH_TOKEN - token for authentication with the server, defaults to "abcdefghi"
• FRPC_MAX_PORTS - max ports per client, defaults to unlimited
• FRPC_POOL_COUNT - how many connections to open in advance, defaults to 5
• FRPC_TCP_MUX - TCP multiplexing, defaults to true
• FRPC_PREFIX - prefix used when naming connections
• FRPC_NETWORK - which docker network to scan (the FRP client container should also be on this network)
• FRPC_LOGFILE - where to log status (log disabled if not set)
• FRPC_LOG_LEVEL - level of logging, defaults to "warn"
• FRPC_LOG_DAYS - log for how many days, defaults to 5 days
• FRPC_ADMIN_ADDRESS - (optional) admin server address, defaults to 127.0.0.1
• FRPC_ADMIN_PORT - (optional) admin server port, defaults to 7400
• FRPC_ADMIN_USER - (optional) admin server user credentials, if not set admin access is not established
• FRPC_ADMIN_PWD - (optional) admin server password credentials, if not set admin access is not established

The container should be configured to have a read-only connection to the Docker process socket. It listens for changes in other containers and will reconfigure the FRP client if changes occur.

The container will detect containers that have the label frp.enabled set to "true". It will then scan through their published ports and look for ports that are configured using labels. The frp.<port> label should be set to "tcp", "http" or "stcp" to indicate the type of connection.

For HTTP connections the follwing configuration can be set:

• frp.<port>.http.subdomain - a subdomain to use (the super-domain is set in FRP server configuration)
• frp.<port>.http.domains - custom domains to use, comma separated
• frp.<port>.http.locations - locations to use, comma separated
• frp.<port>.http.rewrite - rewrite Host when sending request to the proxied server
• frp.<port>.http.username - username for Basic HTTP authentication
• frp.<port>.http.password - password for Basic HTTP authentication

For STCP (secret TCP) connections, the following configuration must be set:

• frp.<port>.secret - sets the pre-shared secred key required for connecting another client to the service.

Additionally, health check on ports can be disabled using:

• frp.<port>.health_check=false - disables port health check if no service is present at the port during the docker startup

Optionally, email notification of the assigned ports can be actived (using LinkNotification plugin on FRP server) by setting:

• frp.notify_email - set to email that will recieve notification of the assigned ports