| <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>webapp-config</title><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article"><div class="titlepage"><div><div><h2 class="title"><a name="idm46609246861888"></a>webapp-config</h2></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">Stuart</span> <span class="surname">Herbert</span></h3><div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:[email protected]">[email protected]</a>></code></p></div><div class="address"><p><code class="email"><<a class="email" href="mailto:[email protected]">[email protected]</a>></code></p></div></div></div><div class="author"><h3 class="author"><span class="firstname">Renat</span> <span class="surname">Lumpau</span></h3><div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:[email protected]">[email protected]</a>></code></p></div></div></div><div class="author"><h3 class="author"><span class="firstname">Gunnar</span> <span class="surname">Wrobel</span></h3><div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:[email protected]">[email protected]</a>></code></p></div></div></div><div class="author"><h3 class="author"><span class="firstname">Devan</span> <span class="surname">Franchini</span></h3><div class="affiliation"><div class="address"><p><code class="email"><<a class="email" href="mailto:[email protected]">[email protected]</a>></code></p></div></div></div></div></div><div><p class="copyright">Copyright © 2003-2015 Stuart Herbert, Renat Lumpau, Gunnar Wrobel, Devan Franchini</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="section"><a href="#idm46609246912784">Reference</a></span></dt><dd><dl><dt><span class="refentrytitle"><a href="#idm46609246912112">webapp-config</a></span><span class="refpurpose"> — Configuration file for the <span class="citerefentry"><span class="refentrytitle">webapp-config</span>(8)</span> tool</span></dt></dl></dd></dl></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idm46609246912784"></a>Reference</h2></div></div></div><div class="refentry"><a name="idm46609246912112"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>webapp-config — Configuration file for the <span class="citerefentry"><span class="refentrytitle">webapp-config</span>(8)</span> tool</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">/etc/vhosts/webapp-config</code> </p></div></div><div class="refsect1"><a name="idm46609243155792"></a><h2>Description</h2><p><code class="filename">/etc/vhosts/webapp-config</code> contains the default settings for the <span class="citerefentry"><span class="refentrytitle">webapp-config</span>(8)</span> installer tool.</p></div><div class="refsect1"><a name="idm46609243153152"></a><h2>Settings</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term">vhost_root</span></dt><dd><p>Directory which holds the <code class="filename">htdocs</code> directory for your website.</p><p>By default, all websites are <code class="filename">/var/www/<em class="replaceable"><code>fqdn</code></em></code>, where <em class="replaceable"><code>fqdn</code></em> is the full hostname of the website (e.g. www.gentoo.org). If you are putting your websites somewhere else, you must update vhost_root to suit.</p><p>You can use the value of <strong class="userinput"><code>vhost_hostname</code></strong> in your definition of <strong class="userinput"><code>vhost_root</code></strong>.</p></dd><dt><span class="term">vhost_hostname</span></dt><dd><p>Default value when <span class="command"><strong>webapp-config</strong></span>'s <code class="option">-h</code> switch hasn't been used.</p><p>By default, this is set to the full hostname of your computer. If this hasn't been set correctly, then this is set to <strong class="userinput"><code>localhost</code></strong> instead.</p></dd><dt><span class="term">vhost_subdomain_{1,2,3...}</span></dt><dd><p>The value of <strong class="userinput"><code>vhost_hostname</code></strong> | |
| is splitted at each dot and the resulting domain name | |
| parts are stored in sequentially | |
| numbered <strong class="userinput"><code>vhost_subdomain_N</code></strong> | |
| variables (e.g. <strong class="userinput"><code>www.test.org</code></strong> | |
| results | |
| in <strong class="userinput"><code>vhost_subdomain_1</code></strong>=org, <strong class="userinput"><code>vhost_subdomain_2</code></strong>=test, | |
| etc.). | |
| </p><p> | |
| You may not set these variables yourself since they | |
| are generated internally | |
| by <span class="command"><strong>webapp-config</strong></span>. But you can use | |
| them within the configuration file. So if you want to | |
| have fine grained control over the location the web | |
| applications get installed, you can | |
| set <strong class="userinput"><code>vhost_root</code></strong>="/var/www/${vhost_subdomain_1}/${vhost_subdomain_2}/${vhost_subdomain_3}" | |
| </p></dd><dt><span class="term">vhost_server</span></dt><dd><p>Default value when <span class="command"><strong>webapp-config</strong></span>'s <code class="option">-s</code> switch hasn't been used.</p><p>By default, this is set to <strong class="userinput"><code>apache</code></strong>, which is the webserver that most people use.</p></dd><dt><span class="term">vhost_server_uid</span></dt><dd><p>Overiding parameter for the server-dependant hardcoded uid which specifies the user to own all files and directories that are server-owned.</p><p>Warning: <span class="command"><strong>webapp-config</strong></span>'s <code class="option">-s</code> switch does not overide this parameter.</p><p>By default, this is disabled.</p><p>This can be <span class="emphasis"><em>either</em></span> the name of a user or their numerical user id.</p></dd><dt><span class="term">vhost_server_gid</span></dt><dd><p>Overiding parameter for the server-dependant hardcoded gid which specifies the group to own all files and directories that are server-owned.</p><p>Warning: <span class="command"><strong>webapp-config</strong></span>'s <code class="option">-s</code> switch does not overide this parameter.</p><p>By default, this is disabled.</p><p>This can be <span class="emphasis"><em>either</em></span> the name of a group or their numerical group id.</p></dd><dt><span class="term">vhost_config_uid</span></dt><dd><p>Default value when <span class="command"><strong>webapp-config</strong></span>'s <code class="option">-u</code> switch hasn't been used.</p><p>By default, this is set to the username of the user who is running <span class="command"><strong>webapp-config</strong></span>. At the time of writing, <span class="command"><strong>webapp-config</strong></span> only works for the <strong class="userinput"><code>root</code></strong> user, because only the <strong class="userinput"><code>root</code></strong> user is allowed to change the ownership of files and directories on disk.</p><p>This can be <span class="emphasis"><em>either</em></span> the name of a user or their numerical user id.</p></dd><dt><span class="term">vhost_config_gid</span></dt><dd><p>Default value when <span class="command"><strong>webapp-config</strong></span>'s <code class="option">-g</code> switch hasn't been used.</p><p>By default, this is set to the primary group of the user who is running <span class="command"><strong>webapp-config</strong></span>.</p><p>This can be <span class="emphasis"><em>either</em></span> the name of a group or their numerical group id.</p></dd><dt><span class="term">vhost_config_virtual_files</span></dt><dd><p>Default value when <span class="command"><strong>webapp-config</strong></span>'s <code class="option">--virtual-files</code> switch hasn't been used.</p><p>By default, files which can be shared are hardlinked in. The <em class="glossterm">virtual install</em> does not get a local copy of the file, which normally prevents the web server or non-root users from editing the file.</p></dd><dt><span class="term">vhost_default_uid</span></dt><dd><p>Default user to own all files and directories that aren't server-owned or config-owned.</p></dd><dt><span class="term">vhost_default_gid</span></dt><dd><p>Default group to own all files and directories that aren't server-owned or config-owned.</p></dd><dt><span class="term">vhost_htdocs_insecure, </span><span class="term">vhost_htdocs_secure</span></dt><dd><p>Default values for the basename of the DocumentRoot.</p><p><span class="command"><strong>webapp-config</strong></span> installs into <code class="filename">vhost_root/vhost_htdocs_insecure</code> by default. If you use the <code class="option">--secure</code> switch, <span class="command"><strong>webapp-config</strong></span> installs into <code class="filename">vhost_root/vhost_htdocs_secure</code> instead.</p></dd><dt><span class="term">vhost_perms_serverowned_dir, </span><span class="term">vhost_perms_serverowned_file</span></dt><dd><p>Default filesystem permissions for directories and files that are installed as 'server-owned'.</p></dd><dt><span class="term">vhost_perms_configowned_dir, </span><span class="term">vhost_perms_configowned_file</span></dt><dd><p>Default filesystem permissions for directories and files that are installed as 'config-owned'.</p></dd><dt><span class="term">vhost_perms_defaultowned_dir</span></dt><dd><p>Default filesystem permissions for directories that are installed as 'default-owned'. Note that it is not possible to install files that are 'default-owned'.</p></dd><dt><span class="term">vhost_perms_virtual_dir, </span><span class="term">vhost_perms_virtual_file</span></dt><dd><p>Default filesystem permissions for directories and files that are installed as 'virtual'.</p></dd><dt><span class="term">vhost_perms_installdir</span></dt><dd><p>Default filesystem permissions for the directory that <span class="command"><strong>webapp-config</strong></span> installs the package into.</p></dd></dl></div></div><div class="refsect1"><a name="idm46609242071616"></a><h2>See Also</h2><p><span class="citerefentry"><span class="refentrytitle">webapp.eclass</span>(5)</span>, <span class="citerefentry"><span class="refentrytitle">webapp-config</span>(8)</span></p><p><span class="command"><strong>webapp-config</strong></span> is based on the design for an installer for web-based applications first defined in <a class="ulink" href="http://www.gentoo.org/proj/en/glep/glep-0011.html" target="_top">GLEP #11</a> for the Gentoo Linux project.</p></div></div></div></div></body></html> |