mod_env.html revision 2eaf662cbc81e823e8d9aeb8d54e69e63032493e
2d453384452f29ab46f29c0163a830492f936512Till Mossakowski<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
c3d42e13d2a7c3749229498658aec34e7e4fd0a0Christian Maeder "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
c3d42e13d2a7c3749229498658aec34e7e4fd0a0Christian Maeder
2d453384452f29ab46f29c0163a830492f936512Till Mossakowski<html xmlns="http://www.w3.org/1999/xhtml">
6034a40f7444be44812edc9819de3b184220e4cbChristian Maeder <head>
97018cf5fa25b494adffd7e9b4e87320dae6bf47Christian Maeder <meta name="generator" content="HTML Tidy, see www.w3.org" />
2d453384452f29ab46f29c0163a830492f936512Till Mossakowski
c3d42e13d2a7c3749229498658aec34e7e4fd0a0Christian Maeder <title>Apache module mod_env</title>
2d453384452f29ab46f29c0163a830492f936512Till Mossakowski </head>
c673000621dd506e5fc7babf8ca6303b7fcefc14Christian Maeder <!-- Background white, links blue (unvisited), navy (visited), red (active) -->
2d453384452f29ab46f29c0163a830492f936512Till Mossakowski
f3a94a197960e548ecd6520bb768cb0d547457bbChristian Maeder <body bgcolor="#FFFFFF" text="#000000" link="#0000FF"
2d453384452f29ab46f29c0163a830492f936512Till Mossakowski vlink="#000080" alink="#FF0000">
2d453384452f29ab46f29c0163a830492f936512Till Mossakowski <!--#include virtual="header.html" -->
2f65d931e866162d39d09c43021a55314040b377Christian Maeder
613bf0ed7d98a961755408ead328687ec17f74fdChristian Maeder <h1 align="CENTER">Apache module mod_env</h1>
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder <p>This module provides for modifying the environment which is
036037a4510ea63a81a4829ad0c11ef39b2391b0Christian Maeder passed to CGI scripts and SSI pages.</p>
613bf0ed7d98a961755408ead328687ec17f74fdChristian Maeder
2d453384452f29ab46f29c0163a830492f936512Till Mossakowski <p><a href="module-dict.html#Status"
2f65d931e866162d39d09c43021a55314040b377Christian Maeder rel="Help"><strong>Status:</strong></a> Base<br />
d5ef5a29a89fa5548f81fcd49fcf0ffda69d45b0Christian Maeder <a href="module-dict.html#SourceFile"
e562f4e0579bf7dd11f2b77f24ef94cd0dd78319Christian Maeder rel="Help"><strong>Source File:</strong></a> mod_env.c<br />
e42eddbc69dd31f7cd696e38f82acad678831cb7Jian Chun Wang <a href="module-dict.html#ModuleIdentifier"
036037a4510ea63a81a4829ad0c11ef39b2391b0Christian Maeder rel="Help"><strong>Module Identifier:</strong></a>
ad270004874ce1d0697fb30d7309f180553bb315Christian Maeder env_module<br />
39982c927a6052fe2ebd13d4c03b2fcbae0d2f0cJian Chun Wang <a href="module-dict.html#Compatibility"
47d6bc7bc9a708427f96be8d805f712697ad3d9eChristian Maeder rel="Help"><strong>Compatibility:</strong></a> Available in
a3acfb955e4427cde9094615b8a62623a441f8c7Christian Maeder Apache 1.1 and later.</p>
62dd3cd58cda003c32ac69ff12dc82b0a6f5d9d3Christian Maeder
62dd3cd58cda003c32ac69ff12dc82b0a6f5d9d3Christian Maeder <h2>Summary</h2>
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder
807d5fddaa5dd8924321c73400fcf875a9ed9a9cChristian Maeder <p>This module allows for control of the environment that will
c4ba3e20a432419afff01558e425e00be42871d8Christian Maeder be provided to CGI scripts and SSI pages. Environment variables
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder may be passed from the shell which invoked the httpd process.
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder Alternatively, environment variables may be set or unset within
62b04256f84128edd94c0575757332f84450bd69Christian Maeder the configuration process.</p>
62b04256f84128edd94c0575757332f84450bd69Christian Maeder
99c923311eab71a85f1dcc4785d349609c828da4Christian Maeder <p>For additional information, we provide a document on <a
e42eddbc69dd31f7cd696e38f82acad678831cb7Jian Chun Wang href="/env.html">Environment Variables in Apache</a>.</p>
807d5fddaa5dd8924321c73400fcf875a9ed9a9cChristian Maeder
807d5fddaa5dd8924321c73400fcf875a9ed9a9cChristian Maeder <h2>Directives</h2>
807d5fddaa5dd8924321c73400fcf875a9ed9a9cChristian Maeder
e42eddbc69dd31f7cd696e38f82acad678831cb7Jian Chun Wang <ul>
e42eddbc69dd31f7cd696e38f82acad678831cb7Jian Chun Wang <li><a href="#passenv">PassEnv</a></li>
c4ba3e20a432419afff01558e425e00be42871d8Christian Maeder
99c923311eab71a85f1dcc4785d349609c828da4Christian Maeder <li><a href="#setenv">SetEnv</a></li>
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder
c4ba3e20a432419afff01558e425e00be42871d8Christian Maeder <li><a href="#unsetenv">UnsetEnv</a></li>
c4ba3e20a432419afff01558e425e00be42871d8Christian Maeder </ul>
8171fdc5e142d2e0e5b4af8172a5ed10e0daa827Christian Maeder <hr />
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder <h2><a id="passenv" name="passenv">PassEnv</a> directive</h2>
135bcb7f65991146c103e5e7599adbc49fe7359dChristian Maeder <a href="directive-dict.html#Syntax"
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder rel="Help"><strong>Syntax:</strong></a> PassEnv
ca3a4317b88adee116c04c6b08458b5690d83209Christian Maeder <em>env-variable</em> [<em>env-variable</em>] ...<br />
d12de70436e416b477af9ae1bf6989f57488bf92Christian Maeder <a href="directive-dict.html#Context"
e42eddbc69dd31f7cd696e38f82acad678831cb7Jian Chun Wang rel="Help"><strong>Context:</strong></a> server config, virtual
e42eddbc69dd31f7cd696e38f82acad678831cb7Jian Chun Wang host<br />
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder <a href="directive-dict.html#Status"
e42eddbc69dd31f7cd696e38f82acad678831cb7Jian Chun Wang rel="Help"><strong>Status:</strong></a> Base<br />
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder <a href="directive-dict.html#Module"
cbac0a99fd23a43b4e94d30e58ebf93a6af6caa0Christian Maeder rel="Help"><strong>Module:</strong></a> mod_env<br />
135bcb7f65991146c103e5e7599adbc49fe7359dChristian Maeder <a href="directive-dict.html#Compatibility"
c3d42e13d2a7c3749229498658aec34e7e4fd0a0Christian Maeder rel="Help"><strong>Compatibility:</strong></a> PassEnv is only
c3d42e13d2a7c3749229498658aec34e7e4fd0a0Christian Maeder available in Apache 1.1 and later.
cbac0a99fd23a43b4e94d30e58ebf93a6af6caa0Christian Maeder
cbac0a99fd23a43b4e94d30e58ebf93a6af6caa0Christian Maeder <p>Specifies one or more environment variables to pass to CGI
c4ba3e20a432419afff01558e425e00be42871d8Christian Maeder scripts and SSI pages from the environment of the shell which
135bcb7f65991146c103e5e7599adbc49fe7359dChristian Maeder invoked the httpd process. Example:</p>
86b6d1603911445e12768984ed6d20dc090795f8Paolo Torrini<pre>
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder PassEnv LD_LIBRARY_PATH
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder</pre>
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder <hr />
d12de70436e416b477af9ae1bf6989f57488bf92Christian Maeder
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder <h2><a id="setenv" name="setenv">SetEnv</a> directive</h2>
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder <a href="directive-dict.html#Syntax"
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder rel="Help"><strong>Syntax:</strong></a> SetEnv <em>env-variable
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder value</em><br />
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder <a href="directive-dict.html#Context"
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder rel="Help"><strong>Context:</strong></a> server config, virtual
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder host<br />
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder <a href="directive-dict.html#Status"
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder rel="Help"><strong>Status:</strong></a> Base<br />
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder <a href="directive-dict.html#Module"
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder rel="Help"><strong>Module:</strong></a> mod_env<br />
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder <a href="directive-dict.html#Compatibility"
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder rel="Help"><strong>Compatibility:</strong></a> SetEnv is only
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder available in Apache 1.1 and later.
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder <p>Sets an environment variable, which is then passed on to CGI
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder scripts and SSI pages. Example:</p>
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder<pre>
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder SetEnv SPECIAL_PATH /foo/bin
b6a54d7292d7a3713000847334de4316d105f40fChristian Maeder</pre>
3b8ed4c60cde6b3fc00836e7814262c4377e8648Paolo Torrini <hr />
1c8c2ec97ff7dee8381aca53f0fca99c01f7b32fSonja Gröning
7f6b97541fdee30d62a0a3cfa58173212a6cd002Christian Maeder <h2><a id="unsetenv" name="unsetenv">UnsetEnv</a>
7f6b97541fdee30d62a0a3cfa58173212a6cd002Christian Maeder directive</h2>
7f6b97541fdee30d62a0a3cfa58173212a6cd002Christian Maeder <a href="directive-dict.html#Syntax"
62dd3cd58cda003c32ac69ff12dc82b0a6f5d9d3Christian Maeder rel="Help"><strong>Syntax:</strong></a> UnsetEnv
62dd3cd58cda003c32ac69ff12dc82b0a6f5d9d3Christian Maeder <em>env-variable</em> [<em>env-variable</em>] ...<br />
4eed11f3c47a94e8908e15a0af70370ad35b3586Paolo Torrini <a href="directive-dict.html#Context"
62dd3cd58cda003c32ac69ff12dc82b0a6f5d9d3Christian Maeder rel="Help"><strong>Context:</strong></a> server config, virtual
2f65d931e866162d39d09c43021a55314040b377Christian Maeder host<br />
2f65d931e866162d39d09c43021a55314040b377Christian Maeder <a href="directive-dict.html#Status"
e42eddbc69dd31f7cd696e38f82acad678831cb7Jian Chun Wang rel="Help"><strong>Status:</strong></a> Base<br />
4eed11f3c47a94e8908e15a0af70370ad35b3586Paolo Torrini <a href="directive-dict.html#Module"
89c8609b3606fdb621eb8f987b88dc3813b5bbd5Christian Maeder rel="Help"><strong>Module:</strong></a> mod_env<br />
4eed11f3c47a94e8908e15a0af70370ad35b3586Paolo Torrini <a href="directive-dict.html#Compatibility"
bb027d3cacbd83dfec98beb38001f105e4918557Christian Maeder rel="Help"><strong>Compatibility:</strong></a> UnsetEnv is only
bb027d3cacbd83dfec98beb38001f105e4918557Christian Maeder available in Apache 1.1 and later.
bb027d3cacbd83dfec98beb38001f105e4918557Christian Maeder
99c923311eab71a85f1dcc4785d349609c828da4Christian Maeder <p>Removes one or more environment variables from those passed
99c923311eab71a85f1dcc4785d349609c828da4Christian Maeder on to CGI scripts and SSI pages. Example:</p>
99c923311eab71a85f1dcc4785d349609c828da4Christian Maeder<pre>
613bf0ed7d98a961755408ead328687ec17f74fdChristian Maeder UnsetEnv LD_LIBRARY_PATH
613bf0ed7d98a961755408ead328687ec17f74fdChristian Maeder</pre>
613bf0ed7d98a961755408ead328687ec17f74fdChristian Maeder <!--#include virtual="footer.html" -->
62dd3cd58cda003c32ac69ff12dc82b0a6f5d9d3Christian Maeder </body>
613bf0ed7d98a961755408ead328687ec17f74fdChristian Maeder</html>
62dd3cd58cda003c32ac69ff12dc82b0a6f5d9d3Christian Maeder
613bf0ed7d98a961755408ead328687ec17f74fdChristian Maeder