Manual:$wgServer

From MediaWiki.org

Jump to: navigation, search
General Settings: $wgServer
The base URL of the server.
Introduced in version: pre 1.1.0
Removed in version: still in use
Allowed Values: URL prefix (protocol, host, optional port; no path portion)
Default Value: (dynamically created)

Other settings: Alphabetical | By Function


[edit] Details

The base URL of the server, including protocol and without the trailing slash. (eg, "http://www.mediawiki.org")

This is used when producing fully-qualified URLs pointing to the wiki, for instance:

  • HTTP redirects on edit and to canonical URL spellings
  • print footer
  • links to articles from RSS/Atom feeds
  • and more!

The default value is calculated automatically (though it can be overridden). See below for details.

Some web servers end up returning silly defaults or internal names which aren't what you want; for instance the ServerName directive in Apache's httpd.conf may not be set or detected properly by the system, leaving you with an unexpected 'localhost'. It's recommended to configure the web server properly, but you can also override the setting manually in LocalSettings.php.

An override can also be useful for certain shared hosting or proxying configurations.

[edit] See Also

Contents


[edit] History

[edit] Before 1.2.0

Caclulated by calling getenv( "SERVER_NAME" );.

[edit] 1.2.0

Switched to using PHP $_SERVER[] array instead of getenv(). Automatically work out port number.

$wgServer           = "http://" . $_SERVER["SERVER_NAME"];
if( $_SERVER["SERVER_PORT"] != 80 ) $wgServer .= ":" . $_SERVER["SERVER_PORT"];

[edit] 1.3.0

Added code to dynamically work out protocol. Used a sensible default when running from the command line.

# check if server use https: 
$wgProto = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') ? 'https' : 'http';
 
if ( @$wgCommandLineMode ) {
        $wgServer = $wgProto.'://localhost';
} else {
        $wgServer           = $wgProto.'://' . $_SERVER['SERVER_NAME'];
        if( $_SERVER['SERVER_PORT'] != 80 ) $wgServer .= ":" . $_SERVER['SERVER_PORT'];
}
unset($wgProto);

[edit] 1.3.8

Fills in more details from the $_SERVER[] array.

if( isset( $_SERVER['SERVER_NAME'] ) ) {
        $wgServerName = $_SERVER['SERVER_NAME'];
} elseif( isset( $_SERVER['HOSTNAME'] ) ) {
        $wgServerName = $_SERVER['HOSTNAME'];
} else {
        # FIXME: Fall back on... something else?
        $wgServerName = 'localhost';
}
 
# check if server use https:
$wgProto = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') ? 'https' : 'http';
 
$wgServer = $wgProto.'://' . $wgServerName;
if( isset( $_SERVER['SERVER_PORT'] ) && $_SERVER['SERVER_PORT'] != 80 ) {
        $wgServer .= ":" . $_SERVER['SERVER_PORT'];
}
unset($wgProto);

[edit] 1.5.0

Adds some extra alternatives for $wgServerName for if the earlier tests fail, and checks whether the HTTPS protocol is on the default port before modifying it.

if( isset( $_SERVER['SERVER_NAME'] ) ) {
        $wgServerName = $_SERVER['SERVER_NAME'];
} elseif( isset( $_SERVER['HOSTNAME'] ) ) {
        $wgServerName = $_SERVER['HOSTNAME'];
} elseif( isset( $_SERVER['HTTP_HOST'] ) ) {
        $wgServerName = $_SERVER['HTTP_HOST'];
} elseif( isset( $_SERVER['SERVER_ADDR'] ) ) {
        $wgServerName = $_SERVER['SERVER_ADDR'];
} else {
        $wgServerName = 'localhost';
}
 
# check if server use https:
$wgProto = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') ? 'https' : 'http';
 
$wgServer = $wgProto.'://' . $wgServerName;
# If the port is a non-standard one, add it to the URL
if(    isset( $_SERVER['SERVER_PORT'] )
    && (    ( $wgProto == 'http' && $_SERVER['SERVER_PORT'] != 80 )
         || ( $wgProto == 'https' && $_SERVER['SERVER_PORT'] != 443 ) ) ) {
 
        $wgServer .= ":" . $_SERVER['SERVER_PORT'];
}
unset($wgProto);

[edit] 1.7.0

The only change is that the port is not appended to the server name if it already contains a colon.

/** URL of the server. It will be automatically built including https mode */
$wgServer = '';
 
if( isset( $_SERVER['SERVER_NAME'] ) ) {
        $wgServerName = $_SERVER['SERVER_NAME'];
} elseif( isset( $_SERVER['HOSTNAME'] ) ) {
        $wgServerName = $_SERVER['HOSTNAME'];
} elseif( isset( $_SERVER['HTTP_HOST'] ) ) {
        $wgServerName = $_SERVER['HTTP_HOST'];
} elseif( isset( $_SERVER['SERVER_ADDR'] ) ) {
        $wgServerName = $_SERVER['SERVER_ADDR'];
} else {
        $wgServerName = 'localhost';
}
 
# check if server use https:
$wgProto = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') ? 'https' : 'http';
 
$wgServer = $wgProto.'://' . $wgServerName;
# If the port is a non-standard one, add it to the URL
if(    isset( $_SERVER['SERVER_PORT'] )
    && !strpos( $wgServerName, ':' )
    && (    ( $wgProto == 'http' && $_SERVER['SERVER_PORT'] != 80 )
         || ( $wgProto == 'https' && $_SERVER['SERVER_PORT'] != 443 ) ) ) {
 
        $wgServer .= ":" . $_SERVER['SERVER_PORT'];
Languages Languages: 

English  • Français  • 日本語  • Русский
Retrieved from "http://www.mediawiki.org/wiki/Manual:%24wgServer"
Personal tools