README

   1 Copyright (C) 2007-2010 Olivier Ramonat
   2 See the end of the file for license conditions.
   3
   4 Gwiad is a framework for building a Web Server with dynamic plugin loading
   5 based on AWS.
   6
   7 It provides a simple interface to build plugins in Ada. When a
   8 plugin is placed in Gwiad plugin directory it is automatically
   9 loaded. Gwiad plugins are divided into two categories :
  10
  11  - Web applications that register dispatchers such as virtual host
  12    dispatchers or regexp dispatchers.
  13  - Services provider that can be used by all websites plugins.
  14
  15 Plugins can be added at run time. They only need to be put in the plugins directory.
  16 If a plugin fails to load it is automatically disabled.
  17
  18 Gwiad provides a simple web administration tool to disable a running
  19 plugin. A current limitation makes it impossible to completely remove the
  20 plugin. To update a plugin to a new version you'll need to restart Gwiad.
  21
  22 Gwiad comes with a simple server named argwiad.
  23
  24 The file INSTALL in this directory says how to build and install Gwiad.
  25
  26 There are several subdirectories:
  27
  28 'admin'             holds the admin interface for services and websites
  29
  30 'argwiad'           holds a simple webserver
  31
  32 'argwiadctl'        controller for argwiad
  33
  34 'config'            holds projects file for system wide installation and
  35                     some scripts
  36
  37 'doc'               gwiad's user guide
  38
  39 'dynamic_libraries' holds the dynamic library manager
  40
  41 'example'           holds the hello world plugins
  42
  43 'gwiad'             gwiad kernel package
  44
  45 'plugins'           holds the services and website managers used by all
  46                     gwiad plugins
  47
  48 'templates'         holds Gwiad default page
  49
  50 'web'               holds the dispatchers (virtual hosts,
  51                     prefix urls, ...)
  52
  53
  54 Gwiad is free software; you can redistribute it and/or modify
  55 it under the terms of the GNU General Public License as published by
  56 the Free Software Foundation; either version 2 of the License, or
  57 (at your option) any later version.
  58
  59 Gwiad is distributed in the hope that it will be useful,
  60 but WITHOUT ANY WARRANTY; without even the implied warranty of
  61 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  62 GNU General Public License for more details.
  63
  64 You should have received a copy of the GNU General Public License along
  65 with this program; if not, write to the Free Software Foundation, Inc.,
  66 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.