HT Manager 2.3
| ||||||||||||||||||||
|
||||||||||||||
|
||||||||||||||
 |
||||||||||||||
- Disclaimer
- Introduction
- Requirements
- Configuration
- Installation
- Quick Start Guide
- Administration Function Bar
- Protecting a directory
- Retaining protection on a directory
- Removing protection from a directory
- Deleting protection of a directory
- Granting Users access to a directory
- Removing a User's access from a directory
- Changing a User's credentials
Please read the Perl Services Licensing Agreement
By downloading, purchasing, acquiring and/or implementing any PerlServices software, you agree to be bound by the terms and conditions of the distribution policy.
To Top
Introduction
Thank you for choosing HT Manager. HT Manager allows you to control, manipulate and modify all Basic Authentication files on your server. HT Manager even includes some simple one step operations not normally available in basic authentication managers. These include temporary suspension and re-enabling of protection on a directory.
To Top
Requirements
HT Manager must be used on a UNIX/Linux type server running Apache with Perl 5 or later.
To Top
Configuration
Path To Perl
All CGI programs written in Perl must start with a line that tells the web server where to look for the Perl interpreter. This means the very first line of each of the .cgi or .pl files MUST be the path to Perl. Here are some examples of common paths to Perl:
Installation
To install this program, you must have an FTP client and be familiar with how to use it's basic functions. If your not sure how to achieve any of the stated functions or commands with your FTP client, please refer to our tutorial on installation and on using FTP clients at:
Quick Start Guide
Once you have installed the program according to the directions above, you are ready to go. There is nothing else that you have to do to begin protecting directories.
Remember, however, this program will only manage the protection of directories that you add through the program's interface. It will not manage directories previously protected by other means/programs. If you have protected directories whose protection you wish to maintain, then please read the section below on retaining protection on a directory.
To Top
Administration Function Bar
After logging into the administration program, the top portion of the screen will contain the above administration function bar. Use this to navigate the various options and functions.
To Top
Log in
Whenever you wish to use the HT Manager administration program, you must first sign into the program. Enter the full URL to the mht_admin.cgi script in the address line of your browser.
Enter your user name and password and click the button. At any time, you can change your password. After logging in, click the "Change Password" link at the top of the page. You will be taken to the form that allows you to change your password. Enter your current user name and password then enter your new user name and password. You will be required to enter the new password twice.
To Top
Directories
When you log into the administration section, you will be presented with the current list of HT Managed Directories. This screen can also be reached at any time you are signed into the program by clicking "Directories" on the function bar.
This screen will list all directories that are currently protected or un-protected and provide the necessary links to manage these directories. This screen also contains the form you will use to add protection to a new directory. In fact, most functions you will want to perform on a directory are available from this screen.
To Top
Change Password
You can change your administrative password at any time by clicking "Change pass" on the top row of the function bar. To change your password, you need to enter five pieces of information on the Change Password screen. First, you must enter your current user name and password. This information is validated against current values just to make sure someone doesn't change the information if you walk away from your terminal.
Next, enter your new user name and then enter your new password. You will have to enter your new password twice. When you click the button, the program will change your user name and password to the new settings. You will then be logged out of the program and you will have to sign back in again.
Additionally, the program ships with a second, default Administrative User as a precaution. The default Username and Password for this second Administrative User are :
Username: 222222
Password: 222222
While logged in as either the Administrative User set up during installation or as the second, default Administrative User, clicking "Change pass" will update the credentials for the current active User.
To Top
Exit
Whenever you are done working with the program or are going to be stepping away from your desk, we strongly urge you to log out by clicking the "Log out" link at the top of the page. Even if your working from home and stepping away from the desk, exit the program. A curious six year old or a cat walking across the keyboard can wreak untold havoc for even the most careful Users.
To Top
Protecting a directory
To protect a directory, from the "Directories" screen, beneath the "HT Managed Directories" list:
Once a directory has been protected, only the Users with access to the directory will be able to access it.
To Top
Retaining protection on a directory
If you have a directory protected prior to installing this program, maintaining that protection is easy. First, FTP into the protected directory. There will be a file in there named .htaccess. Download that file and open it in your text editor. In it, you will see the path to the .htpasswd file that contains all usernames and encrypted passwords with access to the directory. FTP to the directory specified and then download the .htpasswd file. If there is no path and it just says, .htpasswd, this indicates the .htpasswd is in the same directory as the .htaccess file.
Depending on your server and FTP client, you may not be able to see the .htaccess and .htpasswd files as they are considered hidden files. If you have Telnet access, Telnet will display these files for you.
If you're unable to do this, contact us for assistance. We will perform the addition and retention of protection on a directory for nominal fee per directory.
To Top
Removing protection from a directory
To remove protection from a directory protected by HT Manager, from the "Directories" page, simply click the "Un-Protect" link. This will open up the directory to all Users/Visitors to your website. The directory's record will remain in the HT Managed Directories list so you can quickly re-protect it if necessary.
To Top
Deleting protection of a directory
Clicking the "Delete" link in the HT Managed Directories list will take you to a new screen where you can select exactly what you want deleted. The options presented are :
Delete all Users
Retain Admin Users
Delete Manage HT Record
Delete all Files
Delete Directory and all of it's files and sub-directories.
At least one selection must be made. In addition to the selection made, the files associated with the protection of that directory (.htaccess and .htpasswd) are also deleted.
To Top
Granting Users access to a directory
Click "Directories" on the function bar. From the resulting list of protected directories, click on the "User" link for the directory you want to add a User to. Enter an email address, username and password into the form and click "Add new".
If you enter a username that is already in the list of Users for the selected directory, the Username/password pair will be rejected and you will be prompted to enter an alternate username. Only unique usernames are accepted. Passwords can be duplicated provided the username does not already exist.
To Top
Removing a User's access from a directory
Click "Directories" on the function bar. From the resulting list of protected directories, click on the "User" link for the directory you want to remove a User from. On the resulting page, click the "Delete" link beside the User you wish to delete. The following page will ask you to confirm the User deletion. Once confirmed the User will no longer have access to the selected directory.
To Top
Changing a User's credentials
Click "Directories" on the function bar. From the resulting list of protected directories, click on the "User" link for the directory you want to remove a User from. On the resulting page, click the desired Username in the Alphabetical list of current Users.
Enter the User's new details and click the "Edit profile" button. The User's credentials have now be updated.
Note, you can not change only the username.
To Top
By downloading, purchasing, acquiring and/or implementing any PerlServices software, you agree to be bound by the terms and conditions of the distribution policy.
To Top
Introduction
Thank you for choosing HT Manager. HT Manager allows you to control, manipulate and modify all Basic Authentication files on your server. HT Manager even includes some simple one step operations not normally available in basic authentication managers. These include temporary suspension and re-enabling of protection on a directory.
To Top
Requirements
HT Manager must be used on a UNIX/Linux type server running Apache with Perl 5 or later.
To Top
Configuration
Path To Perl
All CGI programs written in Perl must start with a line that tells the web server where to look for the Perl interpreter. This means the very first line of each of the .cgi or .pl files MUST be the path to Perl. Here are some examples of common paths to Perl:
#!/usr/bin/perl
#!/usr/bin/perl5
#!/usr/lib/perl
#!/usr/local/bin/perl
This program was shipped with a default path of: #!/usr/bin/perl
On most servers, this should be all that is required. You do not have to set any variables.
This program uses our advanced set-up routine, which will resolve paths, create directories and set permissions on data directories. If the program encounters a problem during the set-up process, you will be given specific directions on what to do. If the instructions given don't allow you to successfully install the program or you are not comfortable following the instructions, contact us through the Perl Services Support
To Top
Installation
To install this program, you must have an FTP client and be familiar with how to use it's basic functions. If your not sure how to achieve any of the stated functions or commands with your FTP client, please refer to our tutorial on installation and on using FTP clients at:
http://www.perlservices.net/perlfaqs/index.html
Having set the path to Perl, it's time to install the program.
Installation steps:
1. Open your FTP client and connect to your web space.
2. In your cgi-bin create a sub-directory with any legal name that you want (i.e. "uploads").
3. CHMOD this sub-directory to 755 (rwx-rx-rx).
4. Change into this sub-directory with your FTP client.
5. Making sure your FTP client is set to transfer in ASCII mode and not binary mode, transfer all files into the newly created sub-directory.
6. CHMOD all files to 755 (rwx-rx-rx).
7. Launch your web browser and in the address line of the browser, type the full URL to the htm_setup.cgi script:
i.e. http://www.foo.com/cgi-bin/htmanager/htm_setup.cgi
8. You should now see a set-up screen asking you to enter a User Name and Password. If you see this screen, it means the program has been configured correctly. Enter your new User Name and Password. Enter the Password a second time in the space provided. Submit the form.
Once you have received the screen that says "Set-up Successful" your program is installed, configured and ready to run. The first thing you should do is log into the admin program and click on "Settings".
To Top
Quick Start Guide
Once you have installed the program according to the directions above, you are ready to go. There is nothing else that you have to do to begin protecting directories.
Remember, however, this program will only manage the protection of directories that you add through the program's interface. It will not manage directories previously protected by other means/programs. If you have protected directories whose protection you wish to maintain, then please read the section below on retaining protection on a directory.
To Top
Administration Function Bar
After logging into the administration program, the top portion of the screen will contain the above administration function bar. Use this to navigate the various options and functions.
To Top
Log in
Whenever you wish to use the HT Manager administration program, you must first sign into the program. Enter the full URL to the mht_admin.cgi script in the address line of your browser.
Enter your user name and password and click the button. At any time, you can change your password. After logging in, click the "Change Password" link at the top of the page. You will be taken to the form that allows you to change your password. Enter your current user name and password then enter your new user name and password. You will be required to enter the new password twice.
To Top
Directories
When you log into the administration section, you will be presented with the current list of HT Managed Directories. This screen can also be reached at any time you are signed into the program by clicking "Directories" on the function bar.
This screen will list all directories that are currently protected or un-protected and provide the necessary links to manage these directories. This screen also contains the form you will use to add protection to a new directory. In fact, most functions you will want to perform on a directory are available from this screen.
To Top
Change Password
You can change your administrative password at any time by clicking "Change pass" on the top row of the function bar. To change your password, you need to enter five pieces of information on the Change Password screen. First, you must enter your current user name and password. This information is validated against current values just to make sure someone doesn't change the information if you walk away from your terminal.
Next, enter your new user name and then enter your new password. You will have to enter your new password twice. When you click the button, the program will change your user name and password to the new settings. You will then be logged out of the program and you will have to sign back in again.
Additionally, the program ships with a second, default Administrative User as a precaution. The default Username and Password for this second Administrative User are :
Username: 222222
Password: 222222
While logged in as either the Administrative User set up during installation or as the second, default Administrative User, clicking "Change pass" will update the credentials for the current active User.
To Top
Exit
Whenever you are done working with the program or are going to be stepping away from your desk, we strongly urge you to log out by clicking the "Log out" link at the top of the page. Even if your working from home and stepping away from the desk, exit the program. A curious six year old or a cat walking across the keyboard can wreak untold havoc for even the most careful Users.
To Top
Protecting a directory
To protect a directory, from the "Directories" screen, beneath the "HT Managed Directories" list:
- select or type in the absolute path to the desired directory
- enter any Reference name for this directory
- enter the relative path to the Error document
- select whether or not either or the Administrative User will have access to the protected directory
- click the Add Protection button.
- the Reference name also appears as the "Realm" on the Dialogue box in most browsers.
- the relative path to the Error document, must begin with a slash, as in: / which is a synonym for your website domain. A file named "unauthorised.html" shipped with this program is a regular HTML file you can edit to suit your website's look. You can upload it to any directory on your server, but it must match the path entered in the Error document field. It is the file displayed should a User enter incorrect credentials (username/password) while attempting to gain access to a protected directory. If you upload this file to the same directory your home page resides in, then the Error document's value should be : /unauthorised.html
- unless an index.html file already exists in the protected directory, HT Manager will auto-create one inside the protected directory. You can edit or delete this file via FTP if it's not required. When Users successfully log into the protected directory, unless you're directing them to a specific file with in it (e.g. /protected/filename.html) most servers will look for an index.html file by default. If this does not exist, the User will see an error page.
Once a directory has been protected, only the Users with access to the directory will be able to access it.
To Top
Retaining protection on a directory
If you have a directory protected prior to installing this program, maintaining that protection is easy. First, FTP into the protected directory. There will be a file in there named .htaccess. Download that file and open it in your text editor. In it, you will see the path to the .htpasswd file that contains all usernames and encrypted passwords with access to the directory. FTP to the directory specified and then download the .htpasswd file. If there is no path and it just says, .htpasswd, this indicates the .htpasswd is in the same directory as the .htaccess file.
Depending on your server and FTP client, you may not be able to see the .htaccess and .htpasswd files as they are considered hidden files. If you have Telnet access, Telnet will display these files for you.
If you're unable to do this, contact us for assistance. We will perform the addition and retention of protection on a directory for nominal fee per directory.
To Top
Removing protection from a directory
To remove protection from a directory protected by HT Manager, from the "Directories" page, simply click the "Un-Protect" link. This will open up the directory to all Users/Visitors to your website. The directory's record will remain in the HT Managed Directories list so you can quickly re-protect it if necessary.
To Top
Deleting protection of a directory
Clicking the "Delete" link in the HT Managed Directories list will take you to a new screen where you can select exactly what you want deleted. The options presented are :
Delete all Users
Retain Admin Users
Delete Manage HT Record
Delete all Files
Delete Directory and all of it's files and sub-directories.
At least one selection must be made. In addition to the selection made, the files associated with the protection of that directory (.htaccess and .htpasswd) are also deleted.
To Top
Granting Users access to a directory
Click "Directories" on the function bar. From the resulting list of protected directories, click on the "User" link for the directory you want to add a User to. Enter an email address, username and password into the form and click "Add new".
If you enter a username that is already in the list of Users for the selected directory, the Username/password pair will be rejected and you will be prompted to enter an alternate username. Only unique usernames are accepted. Passwords can be duplicated provided the username does not already exist.
To Top
Removing a User's access from a directory
Click "Directories" on the function bar. From the resulting list of protected directories, click on the "User" link for the directory you want to remove a User from. On the resulting page, click the "Delete" link beside the User you wish to delete. The following page will ask you to confirm the User deletion. Once confirmed the User will no longer have access to the selected directory.
To Top
Changing a User's credentials
Click "Directories" on the function bar. From the resulting list of protected directories, click on the "User" link for the directory you want to remove a User from. On the resulting page, click the desired Username in the Alphabetical list of current Users.
Enter the User's new details and click the "Edit profile" button. The User's credentials have now be updated.
Note, you can not change only the username.
To Top