Opened 7 years ago

Closed 5 years ago

#370 closed Bug / Defect (fixed)

ifconfig syntax change insufficiently documented

Reported by: kcodyjr Owned by:
Priority: major Milestone: release 2.3.7
Component: Documentation Version: OpenVPN 2.3.2 (Community Ed)
Severity: Not set (select this one, unless your'e a OpenVPN developer) Keywords:
Cc:

Description

I just tried switching from net30 to subnet, and got a "/11" subnet instead of "/22" on the client side. It took someone on #openvpn to look at the config file to figure out what was happening.

Fact is, the --ifconfig syntax changed from <ip> <peer> to <ip> <mask>.

I thoroughly reread the manpage. It's hinted that subnet is "like" tap mode, but nowhere does it come out and mention the syntax changes accordingly. It's evident in the expansion of the --server directive, but I had to be looking to see that.

Please add suitable verbiage to the --ifconfig and --topology subnet sections to prevent this confusion in the future.

Change History (9)

comment:1 Changed 7 years ago by JoshC

Agreed. The description especially for --ifconfig in the manpage needs to clarify the "rn" argument in tun+subnet better. As it reads now, it sounds like only tap uses a subnet here, but the subnet topology requires one to.

comment:2 Changed 7 years ago by Gert Döring

Milestone: release 2.3.2

Can one of you send a patch, please? I agree that it should be cleaned up, and I'm happy to review and integrate, but I'm too busy right now to think up some sufficiently clear language myself.

comment:3 Changed 6 years ago by Gert Döring

Patch, anyone?

comment:4 Changed 6 years ago by Gert Döring

Milestone: release 2.3.2release 2.3.4

specifically: if I can get a patch today or tomorrow, it goes into 2.3.4. Otherwise, 2.3.5 it is.

comment:5 Changed 6 years ago by Gert Döring

Milestone: release 2.3.4release 2.3.5

comment:6 Changed 6 years ago by Samuli Seppänen

Milestone: release 2.3.5release 2.3.6

Changing milestone to 2.3.6. Patches are most welcome.

comment:7 Changed 6 years ago by Gert Döring

Milestone: release 2.3.6release 2.3.7

comment:8 Changed 5 years ago by Gert Döring

Yeah, this is how Open Source works at it's best. Complain about things, but not help fixing...

So, what do you think about the following addition to openvpn(8):

http://article.gmane.org/gmane.network.openvpn.devel/9616

comment:9 Changed 5 years ago by Gert Döring

Resolution: fixed
Status: newclosed

Patch has been applied to the master and release/2.3 branch.

commit 3a840739e43acc5ea15814be08debb9dbb7ba67c (master)
commit 3a840739e43acc5ea15814be08debb9dbb7ba67c (release/2.3)

Author: Gert Doering
Date: Tue Apr 28 12:20:19 2015 +0200

explain effect of --topology subnet on --ifconfig

Note: See TracTickets for help on using tickets.