summaryrefslogtreecommitdiff
path: root/library/README.md
blob: 43a1d318cf77e71ca4373e24a40227483e8a8f39 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# Custom Modules
## Table of Contents
  - [Description](#description)
  - [Protocols](#protocols)
      - [ocserv.py](#ocserv.py)
	  - [xray.py](#xray.py)
      - [sshvpn.py](#sshvpn.py)
      - [hysteria.py](#hysteria.py)

## Description
Custom modules for user management for different protcols. Each module takes a list of users as input, writes to configuration or password file, returns a list of usernames and passwords that are printed at the end of playbook run. 

 ## Protocols
### xray.py
Description: User management module for xray (vless, vmess, trojan)
Input Parameters:
- users - all_users + vless_users/vmess_users/trojan_users
- protocol - vless/vmess/trojan

### ocserv.py
Description: User management module for ocserv
Input Parameters:
- users - all_users + ocserv_users

### hysteria.py
Description: User management module for hysteria
Input Parameters:
- users - all_users + hysteria_users

### sshvpn.py
Description: User management module for sshvpn
Input Parameters:
- users - all_users + sshvpn_users