ホスティング レンタルサーバ レンタルサーバー

u n d e r c u t ' s   p u b l i c   d o m a i n
Page Last Updated 03/13/2002

Back to undercut's homepage
WebFServe
日本語 · articles · fansubs · Nandub_OnePass · WebFServe · MS-MPEG4 · download · email

Administrators Guide
Version 2

Quick Start

Here are the steps to get up and running quickly.

  1. Download WebFServe archive. Extract to a directory you want to install to.
  2. Copy 3 ini files from mIRC_Files folder to your mIRC folder.
  3. Start mIRC. Type /wfserve_listen in Status Window.
  4. Execute run.bat.
  5. Go to the administration URL displayed in a new window in mIRC.
  6. Configure the Drive Options, set Target Speed (under General Options) to your available upload speed, and set Serving Ad option under Display Options. Rest can be left at default. Click Save Config button.
  7. Type /adtimer_start in a channel you want to advertise on. Type /adtimer_stop to stop the annoucements.

Installation

Requirements

  • Windows OS
  • mIRC 5.91

Installation Instruction

Download the WebFServe archive and extract to any directory. Create a shortcut to run.bat if desired.

Copy aliases.ini, script.ini, and popup.ini in mIRC_Files directory to your mIRC directory. Or you can copy & paste the code from aliases.txt, script.txt, and popup.txt to the Aliases, Remote, and Popup sections in mIRC, respectively. You should be able to use any other 3rd party scripts along with it as long as there're no identifier/variable conflicts.

Running

Once you've installed the files, you're ready to startup WebFServe and configure it using web administration interface. You do not need to be connected to IRC to configure your WebFServe.

  1. Start mIRC.
  2. Type /wfserve_listen in the mIRC's status window.
  3. Start WebFServe by running run.bat

You should see a new window in mIRC and some messages that WebFServe has successfully started, and it should show the URL to the administration section. Go there to configure your WebFServe. To get started quickly, configure these items:

  • Drive Options
  • Target Speed (General Options)
  • Serving Ad (Display Options)

Rest should work well at default for most people. Come back to it and customize further once you get the feel of how it works.

If you wish the web server to use different port than 8080, edit the run.bat and change the port number.

Testing

Once you've configured WebFServe, you're ready to test it. To test your WebFServe, you must be logged on to a IRC server and be in a channel. (create your own test channel)

Type //echo $adtext. This will show the current announcement text. Double click on the link to go to your WebFServe site. It should resolve your nickname and you should be able to queue files. You cannot test it by going to 127.0.0.1 since it requires your real IP address that mIRC resolves through the IRC server. Though that is a good test to see what happens if unknown user comes in.

Putting into production

Here are the items you would want to configure to put your WebFServe into production:

By default, it replies to any !list command with the annoucement text when WebFServe is running and Queue option is enabled. If you need to disable it, change on *:TEXT:!list line with on 10:TEXT:!list in remote.

To make periodic annoucement in a channel, type /adtimer_start in the channel window. You can type /adtimer_stop to terminate the timer. You can customize the frequency by editing the /adtimer_start identifier in the Aliases. Annoucements are only made when WebFServe is running and Queue option is enabled.

There are a number of ways to go offline:

  • Close WebFServe then close mIRC. Next time you start WebFServe, all of the old sends which were in progress will be treated as failed sends and be requeued as needed, and you'll still have all of the old queues. This is good if you need to go offline right away.

  • Close WebFServe, wait until current DCC sends complete, then close mIRC. Next time you start WebFServe, you'll resume from the old queue. This is a graceful way of going offline without interrupting current sends.

  • Set server_active configuration item to 0 and restart the WebFServe (press Ctrl+c). This will disable any new queuing, but will send out any remaining queues. After all queues get sent, you can close WebFServe and mIRC. This is a good way of clearing your queue.

User Levels

WebFServe supports User Level based priority queuing and banning. User levels are managed by mIRC. You can assign users to a level using the popup menu script included.

When removing a user, you may get one message that user was not found, and one message indicating that user has been removed. This is normal as it tries to remove users by nick and then by hostname. If you get two messages that user was not found, then it does mean that user was not found in users list and nothing was removed.

User level that is not a number will be defaulted to user level 1.

Note that with the included popup script, removing a user and setting a user's level to 1 is a different thing. When setting a user's level to 1, the user is assigned to a group _wfs_normal, which gets defaulted to 1. This allows OPs and voiced users to be assinged to level 1 when needed.

When WebFServe looks up user's level, it does so with the command $level(nickname!@hostname). Note the absense of user which generally comes after !. This mean when adding users, you should use mask type 2, 4, 7, or 9. The popup menu add users with mask type 2 (*!*@host) for banning (levels -1, 0, and 1) and type 7 (nick!*@host) when giving access (levels 2 and higher).

More Customization Tips

header.htm, footer.htm, welcome.htm, index.htm, and noaccess.htm

It is very simple to customize the look of your WebFServe with a little knowledge in HTML. header.htm and footer.htm gets inserted at the top and bottom of each page, and welcome.htm is inserted below the header.htm when a user first logs on to your WebFServe. You can place index.htm file in a directory, and it will be displayed at the top when a user browse that directory.

You can update the welcome.htm and index.htm files anytime. header.htm and footer.htm are only read at startup time.

noaccess.htm file is shown when an unknown or users without sufficient user level tries to access the site if configuration is set to display it.

WebFServe's web server does not support serving any files directly. (for security and bandwidth) However, you can still use graphics in your HTML by pointing them to external web host.

In all files, you can insert special comment tags to insert an item from the configuration file (wfserve.ini) by <!--$config{ItemName}-->. And you can also insert the visiters nickname, user level, and hostname by inserting <!--$nick-->, <!--$level-->, and <!--$host-->. Also your nickname can be inserted by <!--$config{me}-->.

Default header.htm contains 2 CSS classes that are used to format the table items, which are tableheads and tablecells classes. You can customize this to change the default formatting sitewide. All other classes can be customized or removed all together.


Copyright © 2000-2003 Undercut.org. All rights reserved.
Managed by Site Compiler