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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
# `pgagroal-admin` user guide
`pgagroal-admin` is a command line interface to manage users known
to the [**pgagroal**](https://github.com/pgagroal/pgagroal) connection pooler.
The executable accepts a set of options, as well as a command to execute.
If no command is provided, the program will show the help screen.
The `pgagroal-admin` utility has the following synopsis:
```
pgagroal-admin [ OPTIONS ] [ COMMAND ]
```
## Options
Available options are the following ones:
```
-f, --file FILE Set the path to a user file
-U, --user USER Set the user name
-P, --password PASSWORD Set the password for the user
-g, --generate Generate a password
-l, --length Password length
-V, --version Display version information
-?, --help Display help
```
Options can be specified either in short or long form, in any position of the command line.
The `-f` option is mandatory for every operation that involves user management. If no
user file is specified, `pgagroal-admin` will silently use the default one (`pgagroal_users.conf`).
The password can be passed using the environment variable `PGAGROAL_PASSWORD` instead of `-P`, however the command line argument will have precedence.
## Commands
### user
The `user` command allows the management of the users known to the connection pooler.
The command accepts the following subcommands:
- `add` to add a new user to the system;
- `del` to remove an existing user from the system;
- `edit` to change the credentials of an existing user;
- `ls` to list all known users within the system.
The command will edit the `pgagroal_users.conf` file or any file specified by means of the `-f` option flag.
Unless the command is run with the `-U` and/or `-P` flags, the execution will be interactive.
Examples:
``` shell
pgagroal-admin user add -U simon -P secret
pgagroal-admin user del -U simon
```
## master-key
The `master-key` command allows the definition of a password to protect the vault of the users,
that is the "container" for users' credentials.
## Deprecated commands
The following commands have been deprecated and will be removed
in later releases of [**pgagroal**](https://github.com/pgagroal/pgagroal).
For each command, this is the corresponding current mapping
to the working command:
- `add-user` is now `user add`;
- `remove-user` is now `user del`;
- `update-user` is now `user edit`;
- `list-users` is now `user ls`.
Whenever you use a deprecated command, the `pgagroal-admin` will print on standard error a warning message.
If you don't want to get any warning about deprecated commands, you
can redirect the `stderr` to `/dev/null` or any other location with:
```
pgagroal-admin user-add -U luca -P strongPassword 2>/dev/null
```
## Shell completion
There is a minimal shell completion support for `pgagroal-admin`.
See the [CLI Tools documentation](https://github.com/pgagroal/pgagroal/blob/master/doc/manual/en/13-cli-tools.md#shell-completions) for more details.
|
