Module Expr Str ImportFrom alias alias alias ImportFrom alias ImportFrom alias alias alias alias alias ImportFrom alias identifier ImportFrom alias alias ImportFrom alias ImportFrom alias ImportFrom alias identifier FunctionDef arguments args defaults body Expr Str Assign NameStore Call NameLoad If CompareEq NameLoad Str body Expr Call NameLoad orelse Raise Call NameLoad keyword ListLoad Str decorator_list FunctionDef arguments args defaults body ImportFrom alias identifier Expr Call NameLoad Str Expr Call NameLoad Str decorator_list FunctionDef arguments args NameParam defaults body Expr Str Expr Call NameLoad NameLoad Expr Call NameLoad Str decorator_list FunctionDef arguments args NameParam defaults body Expr Str Expr Call NameLoad NameLoad Expr Call NameLoad Str decorator_list FunctionDef arguments args NameParam defaults body Expr Str Expr Call NameLoad NameLoad Expr Call NameLoad Str decorator_list FunctionDef arguments args NameParam defaults body Expr Str Expr Call NameLoad NameLoad Expr Call NameLoad Str decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam defaults NameLoad NameLoad NameLoad NameLoad kwarg body Expr Str Expr Call NameLoad Assign NameStore Call NameLoad NameLoad Assign NameStore Dict Str Num Expr Call AttributeLoad NameLoad attr NameLoad Assign SubscriptStore NameLoad Index Str NameLoad Expr Call NameLoad NameLoad NameLoad NameLoad NameLoad keyword NameLoad If NameLoad body Expr Call NameLoad NameLoad orelse Expr Call NameLoad NameLoad If NameLoad body With Call NameLoad Call NameLoad Str Str keyword NameLoad body If AttributeLoad Call NameLoad Str attr body Expr Call NameLoad NameLoad Assign NameStore Call NameLoad BinOpMod Str Call NameLoad Expr Call NameLoad NameLoad Expr Call NameLoad Str decorator_list Assign NameStore NameLoad Assign NameStore NameLoad Assign NameStore ListLoad Str Str Str Str Str Str
N/A N/A 
Apache
======

This module provides high-level tools for installing and configuring
the `Apache HTTP Server <http://httpd.apache.org/>`_.

 fabric.api abort hide settings fabric.colors red fabtools.apache disable_module enable_module disable_site enable_site _site_config_path fabtools.service reload reload_service fabtools.system UnsupportedFamily distrib_family fabtools.utils run_as_root fabtools.require.files template_file fabtools.require.service started require_started server N/A N/A N/A N/A N/A 
    Require the Apache HTTP server to be installed and running.

    ::

        from fabtools import require

        require.apache.server()

     N/A family N/A distrib_family N/A N/A family debian N/A N/A N/A _server_debian N/A N/A N/A UnsupportedFamily supported N/A debian N/A _server_debian N/A N/A N/A N/A fabtools.require.deb package require_deb_package N/A N/A require_deb_package apache2 N/A N/A require_started apache2 N/A module_enabled N/A N/A module N/A N/A N/A 
    Require an Apache module to be enabled.

    This will cause Apache to reload its configuration.

    ::

        from fabtools import require

        require.apache.module_enabled('rewrite')

     N/A N/A enable_module module N/A N/A reload_service apache2 N/A module_disabled N/A N/A module N/A N/A N/A 
    Require an Apache module to be disabled.

    This will cause Apache to reload its configuration.

    ::

        from fabtools import require

        require.apache.module_disabled('rewrite')

     N/A N/A disable_module module N/A N/A reload_service apache2 N/A site_enabled N/A N/A config N/A N/A N/A 
    Require an Apache site to be enabled.

    This will cause Apache to reload its configuration.

    ::

        from fabtools import require

        require.apache.site_enabled('mysite')

     N/A N/A enable_site config N/A N/A reload_service apache2 N/A site_disabled N/A N/A config N/A N/A N/A 
    Require an Apache site to be disabled.

    This will cause Apache to reload its configuration.

    ::

        from fabtools import require

        require.apache.site_disabled('default')

     N/A N/A disable_site config N/A N/A reload_service apache2 N/A site N/A N/A site_name template_contents template_source enabled check_config N/A None None True True kwargs N/A N/A 
    Require an Apache site.

    You must provide a template for the site configuration, either as a
    string (*template_contents*) or as the path to a local template
    file (*template_source*).

    ::

        from fabtools import require

        CONFIG_TPL = '''
        <VirtualHost *:%(port)s>
            ServerName %(hostname})s

            DocumentRoot %(document_root)s

            <Directory %(document_root)s>
                Options Indexes FollowSymLinks MultiViews

                AllowOverride All

                Order allow,deny
                allow from all
            </Directory>
        </VirtualHost>
        '''

        require.apache.site(
            'example.com',
            template_contents=CONFIG_TPL,
            port=80,
            hostname='www.example.com',
            document_root='/var/www/mysite',
        )

    .. seealso:: :py:func:`fabtools.require.files.template_file`
     N/A N/A server N/A config_path N/A _site_config_path site_name N/A context N/A port 80 N/A N/A N/A context update kwargs N/A N/A context N/A config_name site_name N/A N/A template_file config_path template_contents template_source context use_sudo True N/A enabled N/A N/A N/A enable_site site_name N/A N/A N/A disable_site site_name N/A check_config N/A N/A N/A settings N/A hide running warnings warn_only True N/A N/A N/A N/A run_as_root apache2ctl configtest failed N/A N/A N/A disable_site site_name N/A message N/A red N/A Error in %(site_name)s apache site config (disabling for safety) N/A locals N/A N/A abort message N/A N/A reload_service apache2 N/A N/A enabled site_enabled N/A disabled site_disabled N/A __all__ N/A server module_enabled module_disabled site_enabled site_disabled site