| 1 | ============================================================================== |
|---|
| 2 | 2007/06/01 Release of version 0.4.0 of runpugs/Web::Terminal |
|---|
| 3 | ============================================================================== |
|---|
| 4 | |
|---|
| 5 | NAME |
|---|
| 6 | runpugs: a web terminal for interactive pugs |
|---|
| 7 | Web::Terminal: library for building a web terminal for interactive shells |
|---|
| 8 | |
|---|
| 9 | INSTALLATION |
|---|
| 10 | |
|---|
| 11 | * To install, copy all folders to your web root |
|---|
| 12 | (e.g. ~/apache on feather, or /var/www elsewhere) |
|---|
| 13 | Rename html folder if required (e.g. htdocs -> html or public_html) |
|---|
| 14 | |
|---|
| 15 | * make sure that you installed the following CPAN modules: |
|---|
| 16 | Carp::Assert |
|---|
| 17 | YAML::Syck |
|---|
| 18 | Proc::Daemon |
|---|
| 19 | Moose |
|---|
| 20 | Net::Telnet |
|---|
| 21 | IO::Pty |
|---|
| 22 | Config::General |
|---|
| 23 | Perl6::Say |
|---|
| 24 | JSON |
|---|
| 25 | |
|---|
| 26 | * create a $HOME/.webtermrc configuration file (start from the webtermrc file in the repository) |
|---|
| 27 | * make sure that you change the following settings |
|---|
| 28 | rel_root (Release pugs) |
|---|
| 29 | dev_root (Development pugs) |
|---|
| 30 | root (web root) |
|---|
| 31 | port (default 2059; any free TCP port is OK) |
|---|
| 32 | server (bin/termserv.pl) |
|---|
| 33 | |
|---|
| 34 | * Start the terminal server script (bin/termserv.pl) |
|---|
| 35 | |
|---|
| 36 | * To run, simply point your browser to /runpugs/ |
|---|
| 37 | |
|---|
| 38 | * Use scripts to start/stop/restart apache on feather and |
|---|
| 39 | maintain latest runpugs |
|---|
| 40 | |
|---|
| 41 | DESCRIPTION |
|---|
| 42 | runpugs has two main components: |
|---|
| 43 | -a mod_perl script (/perl/runpugs.pl) which uses an html template |
|---|
| 44 | (/data/runpugs_async.html). The latter calls the runpugs.css stylesheet from |
|---|
| 45 | /htdocs/runpugs.css. The script is called from /htdocs/runpugs/index.html |
|---|
| 46 | -a server (/bin/termserv.pl) which handles the interactive pugs sessions and communicates with |
|---|
| 47 | the mod_perl script. The pugs sessions stay alive for some time (currently 10') if |
|---|
| 48 | left inactive. |
|---|
| 49 | |
|---|
| 50 | This version has some AJAX goodness and runs under mod_perl. |
|---|
| 51 | The entrypoint is /htdocs/runpugs/index.html, which calls /perl/runpugs.pl |
|---|
| 52 | |
|---|
| 53 | The underlying library, Web/Terminal, can in principle be used for any |
|---|
| 54 | interactive shell, not just pugs. So we could have runpython :-) |
|---|
| 55 | See the POD for more info. |
|---|
| 56 | |
|---|
| 57 | 'scripts' directory has some perl/shell scripts that are being used |
|---|
| 58 | to run/maintain runpugs on a feather.perl6.nl account. Those has been |
|---|
| 59 | written originally by wim. |
|---|
| 60 | |
|---|
| 61 | AUTHOR |
|---|
| 62 | Wim Vanderbauwhede (wim.vanderbauwhede@gmail.com) |
|---|
| 63 | Ahmad M. Zawawi (ahmad.zawawi@gmail.com) |
|---|
| 64 | |
|---|
| 65 | COPYRIGHT |
|---|
| 66 | Copyright (c) 2006, Wim Vanderbauwhede. All Rights Reserved. This module is |
|---|
| 67 | free software. It may be used, redistributed and/or modified under the |
|---|
| 68 | terms of the Perl Artistic License (see |
|---|
| 69 | http://www.perl.com/perl/misc/Artistic.html) |
|---|
| 70 | |
|---|
| 71 | |
|---|
| 72 | ============================================================================== |
|---|
| 73 | CHANGES IN VERSION 0.4.0 |
|---|
| 74 | -Better session management |
|---|
| 75 | -use Moose for Session objects |
|---|
| 76 | -More generic (Settings.pm uses Config::General) |
|---|
| 77 | |
|---|
| 78 | CHANGES IN VERSION 0.3.0 |
|---|
| 79 | -Uses AJAX for persistent interface and mod_perl for speed |
|---|
| 80 | -Sessions are preloaded for fast startup |
|---|
| 81 | -The user interface behaves much more like a terminal. |
|---|
| 82 | |
|---|
| 83 | CHANGES IN VERSION 0.2.0 |
|---|
| 84 | -Web/Terminal replaces the original WebTerminal modules. This |
|---|
| 85 | implementation is much more generic and configurable. |
|---|
| 86 | -The user interface is much improved, esp. in the unstable version. |
|---|
| 87 | |
|---|
| 88 | ============================================================================== |
|---|
| 89 | |
|---|
| 90 | AVAILABILITY |
|---|
| 91 | Pugs Subversion repository, misc/runpugs |
|---|
| 92 | |
|---|
| 93 | ============================================================================== |
|---|
