bit_kitchen.frpc

ansible-role-frp

This role helps you install and set up the frp client or server on Windows, Linux, or OpenWrt.

To use this role, run:

ansible-galaxy install bit_kitchen.frpc
ansible-galaxy install bit_kitchen.frps

Requirements

No special requirements.

Role Variables

frpc

Variable	Required/Optional	Default	Comment
frpc_version	Optional	(undefined)	Version of frp release. Defaults to the latest version.
frpc_config_name	Optional	(undefined)	Name for the frpc config file and service.
frpc_config_file	Optional	(undefined)	Local config file to copy to the remote. If given, other options won't be used for frpc config.
frpc_server_addr	Optional	`127.0.0.1`	Address of the frp server.
frpc_server_port	Optional	`7000`	Port for the frp server.
frpc_token	Optional	(undefined)	Token for authentication if needed on the server.
frpc_http_proxy	Optional	(undefined)	Proxy for connections to the frp server and other network tasks.

frps

Variable	Required/Optional	Default	Comment
frps_version	Optional	(undefined)	Version of frp release. Defaults to the latest version.
frps_config_name	Optional	(undefined)	Name for the frps config file and service.
frps_config_file	Optional	(undefined)	Local config file to copy to the remote. If given, other options won't be used for frps config.
frps_bind_addr	Optional	`0.0.0.0`	Address to bind for frps, defaults to listen on all interfaces.
frps_bind_port	Optional	`7000`	Port to bind for the frps.
frps_token	Optional	(undefined)	Token for authentication.

Dependencies

bit_kitchen.nssm: (Required for Windows only) needed for creating services on Windows.
gekmihesg.openwrt: (Required for OpenWrt only) necessary for OpenWrt support without Python.
kewlfft.aur: (Required for Arch Linux only) required for AUR support.

Example Playbook

Install and configure frp using defaults

- hosts: servers
  roles:
  - bit_kitchen.frps

- hosts: clients
  roles:
  - bit_kitchen.frpc

Install and configure frp using existing config files

- hosts: servers
  roles:
  - role: bit_kitchen.frps
    frps_config_file: /path/to/my/frps.ini

- hosts: clients
  roles:
  - role: bit_kitchen.frpc
    frpc_config_file: /path/to/my/frpc.ini

Install and configure frp using variables

- hosts: servers
  roles:
  - role: bit_kitchen.frps
    frps_bind_port: 7000
    frps_token: MySecretToken

- hosts: clients
  roles:
  - role: bit_kitchen.frpc
    frpc_server_addr: frp.example.com
    frpc_token: MySecretToken

Install and configure two instances of frp

- hosts: servers
  roles:
  - role: bit_kitchen.frps
    frps_config_name: server1
    frps_config_file: /path/to/my/frps-1.ini

  - role: bit_kitchen.frps
    frps_config_name: server2
    frps_config_file: /path/to/my/frps-2.ini

- hosts: clients
  roles:
  - role: bit_kitchen.frpc
    frpc_config_name: client1
    frpc_config_file: /path/to/my/frpc-1.ini

  - role: bit_kitchen.frpc
    frpc_config_name: client2
    frpc_config_file: /path/to/my/frpc-2.ini

License

MIT

Author Information

bit.kitchen

Informazioni sul progetto

Install and configure frp on Windows, Linux or OpenWrt

role frp frpc frps

Installa

ansible-galaxy install bit_kitchen.frpc

GitHub repository

1 stelle

1 fork

0 problemi aperti

Licenza

Unknown

Download

124

Proprietario

bit-kitchen