mod_admin_web/README.wiki
changeset 1786 29f3d6b7ad16
equal deleted inserted replaced
1785:12ac88940fe3 1786:29f3d6b7ad16
       
     1 #summary Web administration interface
       
     2 #labels Stage-Beta
       
     3 = Introduction =
       
     4 
       
     5 This module provides a basic web administration interface.
       
     6 It currently gives you access to Ad-Hoc commands on any virtual host or component that you are set as an administrator for in the Prosody config file. It also provides a live list of all S2S and C2S connections.
       
     7 
       
     8 = Installation =
       
     9 
       
    10   # Copy the admin_web directory into a directory Prosody will check for plugins. (cf. [http://prosody.im/doc/installing_modules Installing modules])
       
    11   # Execute the contained get_deps.sh script from within the admin_web directory. (Requires wget, tar, and a basic shell)
       
    12 
       
    13 = Configuration Details =
       
    14 
       
    15 "admin_web" needs to be added to the modules_enabled table of the host you want to load this module on.
       
    16 
       
    17 By default the interface will then be reachable under `http://example.com:5280/admin`, or `https://example.com:5281/admin`.
       
    18 
       
    19 The module will automatically enable two other modules if they aren't already: mod_bosh (used to connect to the server from the web), and mod_admin_adhoc (which provides admin commands over XMPP).
       
    20 
       
    21 {{{
       
    22 VirtualHost "example.com"
       
    23    modules_enabled = {
       
    24        .....
       
    25        "admin_web";
       
    26        .....
       
    27    }
       
    28 }}}
       
    29 
       
    30 = Compatibility =
       
    31 ||trunk||Works||
       
    32 ||0.9||Works||
       
    33 ||<= 0.8||Not supported||