OpenVPN howto documentation typos - sudo/no sudo, wrong dirs

Bug #571347 reported by GavinC
10
This bug affects 2 people
Affects Status Importance Assigned to Milestone
ubuntu-docs (Ubuntu)
Fix Released
Undecided
Adam Sommer

Bug Description

Binary package hint: ubuntu-docs

in this page:
https://help.ubuntu.com/9.10/serverguide/C/openvpn.html

There are several (of what appear to be) errors.

it reads:
"sudo mkdir /etc/openvpn/easy-rsa/
sudo cp -r /usr/share/doc/openvpn/examples/easy-rsa/2.0/ /etc/openvpn/"

This makes a directory "2.0" inside the /etc/openvpn directory. Yet, below, the docs then say:
"Next, edit /etc/openvpn/easy-rsa/vars adjusting the following to your environment:"

There is no file to edit, because that file has been created in /etc/openvpn/2.0/vars, not in /etc/openvpn/easy-rsa/vars as suggested.

Further, the guide states:
" Enter the following to create the server certificates:

cd /etc/openvpn/easy-rsa/easy-rsa
source vars
./clean-all
"

Unfortunately, even after you move the "2.0" directory contents into the "easy-rsa" directory and edit the vars file, because this instruction doesn't tell you to be either doing these actions via sudo or root, you get a perms error:
"gavin@funkay:/etc/openvpn/easy-rsa$ ./clean-all
mkdir: cannot create directory `/etc/openvpn/easy-rsa/keys': Permission denied"

So, becoming root, it is possible to create the server cert.

Revision history for this message
GavinC (gavin-cowie) wrote :

More issues on this doc:
Doc reads:

"The VPN client will also need a certificate to authenticate itself to the server. To create the certificate, enter the following in a terminal:

cd /etc/openvpn/easy-rsa/
source vars
./pkitool hostname"

That's fine, and running it (as root again, see issue above) works.

But then the docs say:

" Copy the following files to the client:

    * /etc/openvpn/easy-rsa/hostname.ovpn
 "
and several others.

Those files are actually located in /etc/openvpn/easy-rsa/keys/

G

Revision history for this message
Adam Sommer (asommer) wrote :

Hello,

Thanks for reporting this bug, and helping make Ubuntu better.

The OpenVPN section has been updated for Ubuntu 10.04, can you test the development version found here: http://doc.ubuntu.com/ubuntu/serverguide/C/openvpn.html and see if the issues are resolved?

Thanks again.

Changed in ubuntu-docs (Ubuntu):
status: New → Triaged
assignee: nobody → Adam Sommer (asommer)
tags: added: serverguide
removed: misleading root sudo typo
Revision history for this message
GavinC (gavin-cowie) wrote :

Oh. Yeah, that update is good.

Thanks!

Maybe change link at https://help.ubuntu.com/community/OpenVPN to new updated version.

Revision history for this message
Adam Sommer (asommer) wrote :

Great, thanks for testing.

We can update the like in the wiki once Lucid is out and the website is updated. Usually the website is updated within a week or two of release.

Changed in ubuntu-docs (Ubuntu):
status: Triaged → Fix Committed
milestone: none → ubuntu-10.04
status: Fix Committed → Fix Released
Revision history for this message
pete (ubuntubugs-5-pete-l) wrote :

> Maybe change link at ....

It's probably worth promoting the fixed documentation to
https://help.ubuntu.com/9.10/serverguide/C/openvpn.html
as well, since this is entitled "Official Documentation"

BTW, it would be nice to qualify the instruction that says to "Copy the following files to the client: "
and say where on the client they should be copied - or if the location doesn't matter, just to note that, too.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.