Skip to content

Commit 5ae4bf8

Browse files
author
László Vaskó
committed
README: adding some usage instructions
1 parent ce99319 commit 5ae4bf8

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

+29
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,31 @@
11
# openconnect-sso
22
Wrapper script for OpenConnect supporting Azure AD (SAMLv2) authentication
3+
4+
## TL; DR
5+
```bash
6+
$ pip install openconnect-sso-$VERSION.whl
7+
$ openconnect-sso --server vpn.server.com/group
8+
```
9+
10+
## Configuration
11+
If you want to save credentials and get them automatically
12+
injected in the web browser:
13+
```bash
14+
$ openconnect-sso --server vpn.server.com/group --user [email protected]
15+
Password ([email protected]):
16+
[info ] Authenticating to VPN endpoint ...
17+
```
18+
19+
User credentials are automatically saved to the users login keyring (if available).
20+
21+
If you already have Cisco Anyconnect set-up, then `--server` argument is optional.
22+
Also, the last used `--server` address is saved between sessions so there is no need
23+
to always type in the same arguments:
24+
25+
```bash
26+
$ openconnect-sso
27+
[info ] Authenticating to VPN endpoint ...
28+
```
29+
30+
Configuration is saved in `$XDG_CONFIG_HOME/openconnect-sso/config.toml`. On typical
31+
Linux installations it is located under `$HOME/.configopenconnect-sso/config.toml`

0 commit comments

Comments
 (0)