perl/thrasherbird.pl

   1 #!/usr/bin/env perl
   2 # (leave that line in there)
   3
   4 # This is the Thrasher Bird configuration file. It is also the Perl
   5 # script that actually starts up Thrasher Bird. If that intimidates
   6 # you, just treat this as any other configuration file: Follow the
   7 # comments (after the # symbols), and ignore everything after the
   8 # #### THRASHER BIRD PROGRAM comment.
   9
  10 # To configure Thrasher Bird, you need to specify three things:
  11 # * The "Backend", which is what Thrasher Bird will use to store
  12 #   the data it generates.
  13 # * The "Protocol", which tells it which supported protocol will
  14 #   be exposed by the component.
  15 # * Connection information about the XMPP Server to connect to.
  16 #   You will need to consult your server's documentation about
  17 #   how to set up the server to receive connections.
  18
  19 ########
  20 ## BACKEND
  21 ########
  22
  23 # (Perl gurus: Anything in the Thrasher::Backend::* namespace may be
  24 # used here; specify the module without Thrasher::Backend:: in it.)
  25
  26 # Uncomment the backend you wish to use, configure as appropriate.
  27 # Backend names are case-sensitive.
  28
  29 ## The "Test" backend; can be used to test the system, but won't
  30 #  permanently store any data!
  31 # $backend = Test;
  32 # $backend_configuration = {};
  33
  34 #######
  35 ## PROTOCOL
  36 #######
  37
  38 # (Perl gurus: This is like the Backend, except under the
  39 # Thrasher::Protocol:: namespace.)
  40
  41 # Uncomment the protocol you wish to use, configure as appropriate.
  42 # Backend names are case-sensitive.
  43
  44 ## The "Test" protocol does very little for you.
  45 #
  46 # $protocol = Test;
  47 # my $protocol_configuration = {};
  48
  49 #######
  50 ## CONNECTION INFO
  51 #######
  52
  53 # You need to tell Thrasher Bird how to connect to your server.
  54
  55 # Leave the apostrophes around the ip or domain here.
  56 # This is the "local server".
  57 $server_ip = '127.0.0.1';
  58
  59 # Server port: The port the server is expecting the transport to use.
  60 $server_port = 5556;
  61
  62 # Secret: The shared secret that the server is expecting. If you're
  63 # not familiar with Perl string rules, stick to letters and numbers
  64 # only.
  65 $server_secret = 'secret';
  66
  67 # Component name base; this will be composed together with the name
  68 # of the protocol to determine the component name. If you don't know
  69 # what this means, leave it be. If you want to share the transport
  70 # with people off your server, though, it needs to be routable,
  71 # which means you should set this as the domain name of your server.
  72 $component_name_base = 'localhost';
  73
  74 #######
  75 ## PLUGINS
  76 #######
  77
  78 my $plugins = [];
  79
  80 # ProxyFileTransfer (currently must be used with a Purple protocol)
  81 # enables file transfers to and from contacts on the transport.
  82 # push(@{$plugins}, 'Thrasher::Plugin::ProxyFileTransfer');
  83
  84
  85 #### THRASHER BIRD PROGRAM
  86 # If you are just configuring the program, ignore everything after
  87 # this.
  88
  89 use Thrasher;
  90 # Perl Gurus: This function call is all you need to start Thrasher
  91 # Bird. This configuration file is unneccessary if you want
  92 # to obtain these values some other way. (We do at Barracuda
  93 # Networks.)
  94 Thrasher::start($backend, $protocol, $server_ip, $server_port,
  95                 $server_secret, $backend_configuration,
  96                 $protocol_configuration, $component_name_base,
  97                 $plugins,
  98                );