Skip to content

Commit 7883eb5

Browse files
committed
minor: Update README for slot parameter
1 parent b04ae5e commit 7883eb5

File tree

3 files changed

+9
-5
lines changed

3 files changed

+9
-5
lines changed

.circleci/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
version: 2
1+
version: 2.1
22
jobs:
33
create_builder:
44
machine: true

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
.idea/
2+
.vscode/
3+
24
vendor/
3-
docker-hub-login.sh
45

56
/yubi-oath-vpn
67

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,15 @@ Simply insert your Yubikey to an USB-slot and connect to your 2FA-VPN.
44

55
## Usage
66
Windows (experimental, see below)
7-
`yubi-oath-vpn /connection=<OpenVPN configuration name>`
7+
`yubi-oath-vpn /connection=<OpenVPN configuration name> [/slot=user@example.com]`
88

99
Linux
10-
`yubi-oath-vpn --connection=<connection name>`
10+
`yubi-oath-vpn --connection=<connection name> [--slot=user@example.com]`
1111

1212
Will start the program and connect as soon as the Yubikey is inserted (and not already connected)
1313

14+
If the `slot` argument is omitted, the first slot is used.
15+
1416
### Autostart Startmenu entry (Windows)
1517

1618
* Extract all files to a single directory in you User directory
@@ -55,8 +57,9 @@ Example:
5557

5658
## Background
5759
We use Yubikeys for two factor authentication against our VPN.
58-
We have a Bash script with similar functionality, but the tools (ykman, yubioath) keep changing and dbus-monitor was behaving differently depending on distro.
60+
We have a Bash script with similar functionality, but the tools (ykman, yubioath) keep changing and dbus-monitor was behaving differently depending on Linux distribution.
5961

6062
## Disclaimer
6163
Only tested against one Yubikey 4 and one Yubikey 5 version.
6264
It's my first go project. Expect bugs and low code quality.
65+
That being said it's in active use for several years on different systems and seems to work just fine.

0 commit comments

Comments
 (0)