/headerText.html

HyperNews Setup

Before filling out this form, skim through it, and then read the instructions on submitting at the end. Also, you should carefully read the installation instructions starting on the HyperNews source page. You may use the source.html page that comes with the distribution you have but the latest version will generally be more up to date. Also see the HyperNews Bugs page for any changes you may have to make.

This form is for setting up or changing the configuration options that control how HyperNews version 1.9.9 operates at this site: (www78.pair.com). All the configuration options are stored in a file called hnrc that is used by all the other HyperNews scripts. The first time you visit this setup form (or use another setup method, described next), the hnrc file will not exist, and default values will be given for all options. After the file is created, the next time you visit this form (unless you use your browser Back button to revisit it), the values that are found in the hnrc file are used.

Instead of using this form, you can run setup.pl in the .scripts directory. Run it once to create the hnrc file with default values, edit that file, and then run setup.pl again. A couple more options are available if you manually edit the hnrc file. After editing the file, you can either use this form or the command line. One other option is that you can use the short form, which is a simpler version of this form. But read the documentation in this form in any case.

Both setup-form.pl and setup.pl look for hnrc in the HyperNews directory called $hnbin/Admin, currently "/usr/home/lawson/public_html/cgi-bin/HyperNews/Admin". For compatibility with old versions of HyperNews, we also check $hnbin and $hnbin/.scripts. (These variables that reference directories are always computed from the URL used to access each script so you do not need to set them.)

An hnrc file has been found in /usr/home/lawson/public_html/cgi-bin/HyperNews/Admin.

Each time you submit this setup form, the hnrc file will be changed in "/usr/home/lawson/public_html/cgi-bin/HyperNews/Admin". The old version of this file will be moved to hnrc-old. If an error occurs, you can back up to this form (which will still have the values you used) to correct the problem and resubmit.

It is possible to install HyperNews multiple times at the same site, each time with different options. In fact, the .scripts directories of each may be linked to a single copy, but you must use the appropriate URL to access this form, and be sure to fill in the $hnGroup field below. You may also want to define separate document directories for each installation and protect them against direct http access except by administrators. All installations may share the same set of users and passwords, and a different group of users may be given access to each.

When filling in values for the following options, as a convenience, you can use the values of previously defined options (in the order presented in this list) just by using the variable name for the option. For example, $http is used several times below. Another variable that is available is $hndocs, which is the directory where the HyperNews forums and messages are stored, currently "/usr/www/users/lawson/frontier/hn".


HyperNews URLs

$http is the URL prefix for your server; it is used in several other places below to generate URLs for documents and scripts. It can be a fixed value such as http://www.hypernews.org or a computed value using "$ENV{SERVER_NAME}" (which is "www78.pair.com" for you) and $ENV{SERVER_PORT} (which is 80). Do not include a trailing "/".


HyperNews Documents Directory

$hndocs is the full path to the directory where your HyperNews forums and messages are stored. For each forum, a subdirectory will be created in $hndocs to store message headers. Message bodies will be stored there too (except when a URL is provided as the message body).

$hndocs may be the same as the httpd root document directory, or some subdirectory. If you use a subdirectory of the document root such as "hn", which is recommended, be sure the name is not the same as the name of the directory where the HyperNews scripts are stored or you and your server will be confused. Actually, $hndocs doesn't need to be accessible to the http server, just to the HyperNews scripts. But if you make it inaccessible to the server, make sure the icons are still accessible (see $hnicons below).

The user running your HyperNews programs is "lawson". This user must be able to write in the $hndocs directory. (Alternatively, the directory could be group writable by the group the user is in, "users"). You should create this directory yourself being sure to set the correct access mode. HyperNews will try to do it when needed but it will only succeed if the parent directory is also writable.

HyperNews documents directory full path ($hndocs):

When a user looks up a HyperNews URL that no longer exists, or perhaps they typed it in wrong, they will be referred to another document. $hnRootDoc is the document that is referenced if nothing else can be found. This could be your top level list of HyperNews pages, for example. You may specify this URL as either a HyperNews path relative to $hndocs (starting with a '/'), or as any URL.

Root Document ($hnRootDoc):


Formatting Options

Header and footer text are included at the top and bottom of each forum and message. These may be overridden for each forum. This could be used to include a standard message or image map, for example. You could wrap everything in a table, but you can't use this option to wrap with frames.

Alternatively, the header or footer text can be a simple http URL, or a file name, in which case the document it refers to is fetched, relative URLs fixed. A file name should start with '/' and it will be used as if relative to the $hndocs directory, not your file system root. (A relative path would be relative to each forum it is used in.)

Header Text ($headerText):

Footer Text ($footerText):

$global_body_tag is used to define the body tag at the beginning of the HTML body when displaying forums and messages. You could use this to give every page a background color or image. It defaults to a normal <BODY>.

Global Body Tag ($global_body_tag):

(Also see $startMsgBodyTag and $endMsgBodyTag in the hnrc file.)

$globalDefaultOutlineDepth is the maximum number of levels of messages to display when viewing the message outline on any page. It may be overridden on each forum. Use "-1" for All.

Default depth of the outline display ($globalDefaultOutlineDepth):


Icons

The icons directory ($hnicons) contains the icons used to show the kind of message. The mapping between kinds of messages and icons is in $hnicons/icons-table, the default value of which is copied from /usr/home/lawson/public_html/cgi-bin/HyperNews/.scripts/icons-table-dist - you should edit that to your liking before submitting or edit the actual table after that.

Icons directory full path ($hnicons):

Full URL for the same directory as $hnicons ($hniconsURL):

You only need to copy icons from the distribution once each time you install a new version of HyperNews, or not at all if you don't plan to use the distributed icons.

Copy Icons to $hnicons.
NO


Directory and File Modes

These variables specify the access mode bits for creating directories and files. Be sure to include a leading '0'. To have directory user (or group) ownership transferred to files, use e.g. $hndirmode = 04775; (or 02775 for group).

Directory Creation Mode ($hndirmode):

File Creation Mode ($hnfilemode):


People and Passwords

Administrators for HyperNews are given special powers beyond what normal members are permitted. Administrotors are defined only during the setup process, partly for added security. @hnAdmin is the list of administrators for this HyperNews installation. If you manually edit @hnAdmin in hnrc, be sure to run setup again.

In addition to this list of administrators for all HyperNews data, each forum has an administrator (i.e. the owner) whose scope is limited to that forum and all messages under it. Only the Group administrators have administrative powers for the membership and reset password functions.

Each administrator in the list (comma or whitespace separated) should be a User ID (which may be an email address, if you allow it). Parens and quotes should not be used. E.g. liberte@hypernews.org, rmelo@hypernews.org. The first entry in the list will be given in error messages for users who need help.

HyperNews Administrators (@hnAdmin):


$hnPeople is the directory to store membership information files for each member (including administrators), one file for each member. The directory will also have one subdirectory per group.

People Directory ($hnPeople):

$hnPassword is the full path to the password file. This is usually $hnPeople/.htpasswd, but this can be shared with another installation of HyperNews. In cannot be a password file managed by some other process outside of HyperNews, however.

Password File Full Path ($hnPassword):

$hnGroup is the name of the group of members who have access to documents via this particular installation of HyperNews. Each installation of HyperNews may now have a different group of users but all can share the same password file and personal info for each user. Group specific files are in the directory $hnPeople$hnGroup.

You can leave $hnGroup empty and then HyperNews will behave identically with earlier versions. You must do this the first time to set up the "root" installation, but you can later define subgroups as well. If you want to specify a group name, the format is a path relative to $hnPeople. E.g. NCSA/SDG. Note that this is not a file system path; it is a path relative to the $hnPeople directory. The members of this group will be stored in the directory named by $hnPeople$hnGroup. There should be no spaces in the group name.

Warning: You must install the "root" installation with no group (i.e. leave it blank) the first time! But for multiple installations, if you forget to include the group name when you had intended to set up a group, you will very likely mess up your root installation.

Group Name ($hnGroup):

There are several fairly complex reasons to rebuild your $hnPassword file and $hnGroup files. You may not need to do it at all, and you should only need to do this once per installation when you finally install the new version of HyperNews. Passwords and group info are maintained redundantly thereafter in the membership information, the $hnPassword file, and the group specific files. If you specify an $hnGroup above, then only the group file will be rebuilt. If you select the $externalSecurity option in the hnrc file, the password file is never changed or used.

Rebuild $hnPassword and $hnGroup files.
NO


Security Options

HyperNews makes use of the authentication mechanism of NCSA's httpd, Apache, and other servers. Making use of this server authentication mechanism permits the server to request authentication of users automatically, and browsers pop up a dialog asking the user for their user ID and password the first time. All this is accomplished by putting the restricted scripts in a directory that has an access restriction file.

If the server authentication mechanism is different for your server, you could either turn off all security (which is probably unwise), or attempt to use the "manual", form-based authentication mechanism by setting the following option. This is not guaranteed to work in all cases, however, so check it out if you need it. In any event, manual security is not used to restrict reading of messages - only commands (such as changing subscription or deletion) that have side effects.

Use form-based authentication ($manualSecurity).
NO - use server authentication.


Each of the commands or operations described in the following sections are controlled by a configuration variable. There are four possible values for each variable:

0. No One
The command is disabled. Actually, administrators will still be able to do it, but no URL will be advertised.

1. Anyone
Anyone can do it without authentication. But in most cases with this setting, if the user affected by an operation is a member, only that member may do it.

2. Members Only
Authentication is required. Administrators are members too. In other words, non-members cannot do it.

3. Administrators Only
A special check is done after authentication to see if the member is an administrator.

Users can become members via the edit-member.pl script, but even that script may be restricted. Group administrators are only created by adding to the @hnAdmin list above. Group administrators may always perform any function. In addition, the owner of a forum is an administrator for the forum and all messages (this does not apply to the membership and reset password functions).


Registering New Users

Who can register someone as a new member of this HyperNews group? For all settings of this variable, once registered, only authenticated members may change membership information about themselves, except that Group administrators may always change anyone's information.
Disable Registering.
Anyone may register themselves.
Only members may register new members.
Only administrators may register new members. Once registered, members may edit their own membership info.

Resetting Passwords

Who may reset the password of a member?

The main purpose of allowing passwords to be reset is to deal with the situation where a user has forgotten their password. To avoid bothering administrators to reset passwords, the option is available here for anyone, or members only, to reset the password of any member. The new password is not displayed - it is only emailed, in the clear, to the person whose password has been reset. Email is not particularly secure, so you may wish to allow only administrators to reset passwords. Of course, email must be enabled for this to work - see Notification below.

As a precaution, no one, not even another authenticated administrator, may reset an administrator password, no matter what the reset option is. Instead, you have to change the password explicitly on the membership form.

Note that if you allow anyone to register themselves, then you should probably not allow members to reset passwords unless you are very trusting.

Disable Resetting.
No authentication required to reset member passwords.
Only members may reset member passwords.
Only administrators may reset member passwords.

Forum Creation

Who may create new forums or overwrite existing ones? The owner may be specified as different from the creator. The owner of a forum has administrative powers over just that forum and all its messages.

If a forum is owned by a member, only that member, or an administrator may update the forum.

Disable Forum Creation.
Anyone may create new forums without authentication.
Only members may create new forums.
Only administrators may create new forums.

Reading Forums and Messages

Who may read forums and messages?

If set to 2, all the other security variables are effectively set to level 2 or greater. (This may change in the future.)

Disable Reading.
Anyone may read without authentication.
Only members may read.
Only administrators may read - how boring - this is disabled for now.

Adding Messages

Who may add a message?
Disable Adding Messages.
Anyone may add new messages without authentication.
Only members may add messages.
Only administrators may add new messages.

Notification

Who may subscribe themselves to be notified by email of new messages? Once subscribed, only the user may unsubscribe if they are a member.

Disable Email Notification.
Anyone can change his/her own notification information. Anyone can change non-members notification information.
Only members can change their own notification information.
Only administrators may change notification information.


Deleting Messages

Who may delete a message? Forums may not be deleted (except via command line).

Disable Deleting Messages
Anyone may delete non-member or their own messages.
Only members may delete their own messages.
Only administrators may delete any messages.

Moving Messages

Who may move or copy messages? Moving also deletes the source messages, but leaves a placeholder. The ownership of replies to a message are not checked, but are left intact. Forums may not be moved (yet).

Disable Moving Messages.
Anyone may move non-member messagess. Members may move their own.
Only members may move their own messages.
Only administrators may move messages.

Submitting

When you submit this form, the values you entered will be checked for several constraints, and then several things will be updated. $hnlib ("/usr/home/lawson/public_html/cgi-bin/HyperNews/.scripts") must be writable by the server process when you submit in order for some of these things to be updated. Also $hnbin ("/usr/home/lawson/public_html/cgi-bin/HyperNews"), $hnbin/securedir, and $hnbin/Admin (if they already exist) must be writable. As a precaution, Be sure to make them unwritable after you submit. If you want to avoid making these directories writable by the server process, instead run setup.pl directly from a command line.

If you have set up HyperNews previously, you need to enter your Admin User ID and Password here.

Admin User ID:

Password:

/footerText.html