Views
- State: published
Fserv
Current features:
- Low CPU usage.
- A full-featured queue for when download slots are full.
- Listing of all available files. (Sent to users as a text file with configurable MOTD)
- Search (simple filename text match).
- Bandwidth limiting (so that you don't choke your network).
- For bots behind routers, the ability to specify the host ip as well as a port range to use for DCC transfers (see below).
- Fancy statistics, and timeleft estimation for files in the queue.
Setup:
- Load the plugin (@load Fserv)
- Set the share directory (@config plugins.fserv.sharedir /path/to/share/directory)
Note: If you have symlinks in the share directory, the bot will follow them.
- Look at other configuration variables (@config list plugins.fserv, @config help plugins.fserv.optionname)
Basic usage:
- Get list of files: @fserv list
- Search files: @fserv search searchterm (you can also use '@fserv find', it does the same thing)
- Get a file: @fserv get Path/To/File.txt (just enter what list or search gives you)
Other commands:
- View the current sends: @fserv viewsends (file sizes are kept vague so that you can't guess what other people are getting)
- See whos waiting for files if the send slots are full: @fserv viewqueue
- Get information about your spots in the queue: @fserv myqueue
- Remove one of your queued requests: @fserv leavequeue <num>
..Where num is the number of the queue slot. (See myqueue for the numbers)
- Refresh the send list, in case there's one that's somehow gotten 'stuck': @fserv refresh
This command is primarily for updating the bandwidth limit for current sends. If you change the bandwidth limit value, you can use this command to *immediately* apply that value to current sends. Otherwise, you can just wait until it updates normally when any user enters or leaves a send slot.
If your bot is behind a firewall or router:
- @config plugins.fserv.svrhost <your external hostname or ip>
- @config plugins.fserv.portrange 9000 9100
Other notes:
- There are many settings available in the plugins.Fserv config section. Use @config list plugins.fserv to see a list of options, and use @config help plugins.fserv.option to see what an option does.
- If a file has []'s in it, you need to use quotes around the filename to keep Supybot from "interpreting" it for you when using the "get" command. Example: @fserv get "filename[5].txt"
To disable this behavior, do this: @config commands.nested.brackets ""
- If you specify a port range, make sure you give it plenty of ports (perhaps multiply your download slots by 5, just in case). If a user is supposed to be getting a file but there arent any ports available, they get pushed back to the front of the queue until hopefully a port opens up, but still, it's not like ports are a limited resource. You have 65000 of them. An extra 20-30 cant hurt.
Latest release
Beta3 — Bugfix release