Commits

Josh VanderLinden committed 0b7694a

More documentation

Comments (0)

Files changed (2)

 # Maintainer: Josh VanderLinden <arch@cloudlery.com>
 pkgname=autotunnel
 pkgver=0.3.2
-pkgrel=1
+pkgrel=2
 pkgdesc="Easily create tunnels, reverse tunnels, and socks proxies"
 arch=('any')
 url="http://www.codekoala.com/"
 
 One interesting option offered by ``autotunnel`` is that of profiles. You may
 have multiple profiles of tunnels, each to different systems with different
-settings.  All profiles should be saved in `/etc/autotunnel.d` as `.conf`
-files. For example, the default profile is `/etc/autotunnel.d/default.conf`.
+settings.  All profiles should be saved in ``/etc/autotunnel.d`` as ``.conf``
+files. For example, the default profile is ``/etc/autotunnel.d/default.conf``.
 
 There are two ways to call ``autotunnel``:
 
 =======
 
 [-k]                Kill the specified profile. If the profile is omitted, the
-                    default profile will be kill.
+                    default profile will be killed.
 [profile]           The name of the profile to launch. If omitted, the default
                     profile will be used.
 
-If you're using multiple profiles, be sure to update the `AUTOSSH_PORT` value
+If you're using multiple profiles, be sure to update the ``AUTOSSH_PORT`` value
 in each profile so there's no conflict. This is the port that is used to
 determine if a profile is already running or not. If two profiles have the same
-`AUTOSSH_PORT`, only one of the two profiles may be running at one time.
+``AUTOSSH_PORT``, only one of the two profiles may be running at one time.
 
 Start Tunnels Automatically At Boot
 ===================================
 It's very important that you setup pre-shared key (PSK) authentication between
 your local system and the remote systems you plan to establish tunnels with if
 you want the tunnels to activate at boot time. You'll want to setup PSK
-authentication for your local `root` user to the remote system(s).
+authentication for your local ``root`` user to the remote system(s).
 Alternatively, you may edit the ``systemd`` unit files or ``supervisord``
 configuration files to launch the tunnels as a user of your choice.
 
 
     ssh-copy-id remote_user@remote_host
 
-Obviously, replace `remote_user` and `remote_host` with the appropriate
-information. Then enter the password for `remote_user` on `remote_host`. If all
-went well, you should now be able to SSH into `remote_host` as `remote_user`
-without entering a password. If not, Google is your friend.
+Obviously, replace ``remote_user`` and ``remote_host`` with the appropriate
+information. Then enter the password for ``remote_user`` on ``remote_host``. If
+all went well, you should now be able to SSH into ``remote_host`` as
+``remote_user`` without entering a password. If not, Google is your friend.
 
 systemd
 -------
 -----------
 
 If you're using ``supervisord``, you should be able to just copy or symlink the
-default configuration to your `/etc/supervisor.d` directory::
+default configuration to your ``/etc/supervisor.d`` directory::
 
     cp /etc/autotunnel.d/autotunnel.ini /etc/supervisor.d/
 
 
 There are a lot of neat things you can do with tunnels. I will leave it up to
 you to Google the more advanced things, but I would just like to mention
-something. You may have noticed that all of the above examples have `localhost`
-in them. This is not absolutely necessary--you can be the hostname or IP of
-another system on the network.
+something. You may have noticed that all of the above examples have
+``localhost`` in them. This is not absolutely necessary--you can be the
+hostname or IP of another system on the network.
 
 For example, say I have 3 PCs. PC A is my machine at work. PC B is my laptop at
 home. PC C is my desktop at home. My home router is configured to forward all
 connection. This is great because the traffic is encrypted, and it allows you
 to bypass things like stupid corporate Internet filters.
 
-To establish a SOCKS proxy, configure your profile's `SOCKS_PORT` to something
-greater than 0.
+To establish a SOCKS proxy, configure your profile's ``SOCKS_PORT`` to
+something greater than 0. After that, it's just a matter of configuring your
+computer or browser to use the SOCKS proxy. Each WM and browser will have its
+own configuration. Another Google assignment for you!