# &adminguide;

## Overview

This module provides an HTTP transport layer implementation for &osips;'s Management Interface.

## To-do

Features to be added in the future:

- possibility to authenticate connections.

## Dependencies

### &osips; Modules

The following modules must be loaded before this module:

- httpd module.

## Exported Parameters

### `mi_http_root`(string)

Specifies the root path for mi http requests. The link to the mi web interface must be constructed using the following patern: http://[opensips_IP]:[opensips_mi_port]/[mi_http_root]

The default value is "mi".

#### Set `mi_http_root` parameter

    ...
    modparam("mi_http", "mi_http_root", "opensips_mi")
    ...

### `mi_http_method`(integer)

Specifies the HTTP request method to be used:

- 0 - use GET HTTP request

- 1 - use POST HTTP request

The default value is 0.

#### Set `mi_http_method` parameter

    ...
    modparam("mi_http", "mi_http_method", 1)
    ...

## Exported Functions

No function exported to be used from configuration file.

## Known issues

Commands with large responses (like ul_dump) will fail if the configured size of the httpd buffer is to small (or if there isn't enough pkg memory configured).

Future realeases of the httpd and mi_httpd modules will address this issue.