NAME OpenResty - General-purpose web service platform for web applications VERSION This document describes OpenResty 0.3.17 released on July 18, 2008. DESCRIPTION This module implements the server-side OpenResty web service protocol. It provides scriptable and extensible web services for both server-side and client-side (pure AJAX) web applications. Currently this module can serve as a public web interface to a distributive or desktop PostgreSQL database system. In particular, it provides roles, models, views, actions, captchas, the minisql language, and many more to the web users. "Another framework?" No, no, no, not all! OpenResty is *not* a web application framework like Jifty or Catalyst. Rather, it is * A REST wrapper for relational databases * A web runtime for 100% JavaScript web sites and other RIAs. * A "meta web site" supporting other sites via web services. * A handy personal or company database which can be accessed from anywhere on the web. * A (sort of) competitor for the Facebook Data Store API. We're already running an instance of the OpenResty server on our Yahoo! China's production machines: And there're several (pure-client-side) web sites alreadying taking advantage of the services: OpenResty's admin site agentzh's blog and EEEE Works' blog Yisou BBS This library is still in pre-alpha stage and the API is still in flux. We're just following the "release early, releaes often" guideline. So please check back often ;) See OpenResty::Spec::Overview for more detailed information. OpenResty::CheatSheet also provides a good enough summary for the REST interface. You'll find my slides for the D2 conference interesting as well: There're also a few interesting discussions about OpenResty on my blog site: "OpenResty versus Google App Engine" "Google's crawlers captured OpenResty's API!" "Video for my D2 talk about OpenResty and its nifty apps" "Client-side web site DIY" (Chinese) "OpenResty 平台相关资料" (Chinese) INSTALLATION Please see OpenResty::Spec::Installation for details :) SOURCE TREE STRUCTURE bin/ contains some command-line utilities, among which the openresty is the most important one. lib/ contains all the server code, mostly Perl. haskell/ contains the RestyScript compiler for OpenResty written in Haskell. Support for both OpenResty Views and Actions is provided. See haskell/README for more details. font/ contains the font file (*.ttf) for captcha generation. etc/ contains the config files, openresty.conf and site_openresty.conf. The latter one takes precedence over the former. grammar/ contains Parse::Yapp grammar files for the old OpenResty View (or minisql) compiler. t/ contains the test suite. demo/ contains a bunch of OpenResty demo apps. inc/ generated by Module::Install for CPAN building system. SOURCE CONTROL For the very latest version of this module, check out the source from the SVN repos below: There is anonymous access to all. If you'd like a commit bit, please let us know. :) TODO For the project's TODO list, please check out BUGS There must be some serious bugs lurking somewhere given the current status of the implementation and test suite. Please report bugs or send wish-list to . AUTHORS Agent Zhang (agentzh) "" chaoslawful (王晓哲) "" Lei Yonghua (leiyh) Laser Henry (laser) "" Yu Ting (yuting) "" For a complete list of the contributors, please see . License and Copyright Copyright (c) 2007, 2008 by Yahoo! China EEEE Works, Alibaba Inc. This module is free software; you can redistribute it and/or modify it under the Artistic License 2.0. A copy of this license can be obtained from THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. SEE ALSO OpenResty::Spec::Overview, openresty, OpenResty::Spec::REST_cn, OpenResty::CheatSheet, WWW::OpenResty, WWW::OpenResty::Simple.