The ogconfig tool can greatly aid you in configuring OneGate more quickly, depending on whether you prefer working manually in the filesystem or with configuration utilities.

This tool is a text-based, menu-driven application that assists you in configuring OneGate. For files that do not exist comments of the relevant type (coniguration-style or HTML-style, depending on the file in question) are inserted at the beginning before you are launched into the editor of your choice. These comments detail what should go in the file, and in what format, if the format is specific. These comments should help with the editing process, and reduce the frequency with which you might ordinarily have to check the online documentation. For pre-existing configuration files, no additional comments are added.

Another nice enhancement is the syntax checking. After you finish editing each file, your syntax is checked, and you are notified exactly which line contains any error. If multiple lines contain errors, you are directed towards the first problematic line.

Some things of note about the tool:

• You must set the environment variable EDITOR to a valid executable in order to use this program. Said editor must be able to take the file to be edited as its first argument. Under *nix systems, just about any editor will meet this criterion, and your environment quite possibly already has this variable set. If not, you will need to set it. For Windows users, you may set this to any editor that meets that prerequisite. I personally prefer gvim, although notepad works well too.

• For the User Authentication section of the tool, the external program htpasswd is used, and should be present within your path. If the program cannot be executed, you will receive an error message, but the program will continue onwards. In this event, you are responsible for generating the password file contents manually. The program does come with many web server distributions, so I consider it ubiquitous enough to rely upon its presence.

• Windows users will not be able to use the symbolic link functionality for the User Authentication section of the tool. You will receive errors about not being able to do this, if you attempt it, but the program will continue onwards.

It is our hope that this tool reduces the frustration some people feel over manually configuring applications at the system level. Given a proper environment, you can configure everything about OneGate with this tool with relative ease.

For *nix platforms, log in as or su to the user under which onegate should be running, before using this tool.