Difference between revisions of "API:bin/generate apacheconf"

From EPrints Documentation
Jump to: navigation, search
(Created page with '<!-- Pod2Wiki=_preamble_ This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' com…')
 
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
<!-- Pod2Wiki=_preamble_  
 
<!-- Pod2Wiki=_preamble_  
 
This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
 
This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
−
  -->{{API}}{{Pod2Wiki}}{{API:Source|file=bin/generate_apacheconf.pm|package_name=bin/generate_apacheconf}}[[Category:API|bin/generate_apacheconf]]<div><!-- Edit below this comment -->
+
  -->{{API}}{{Pod2Wiki}}{{API:Source|file=bin/generate_apacheconf|package_name=bin/generate_apacheconf}}[[Category:API|BIN/GENERATE_APACHECONF]][[Category:API:bin/generate_apacheconf|BIN/GENERATE_APACHECONF]][[Category:API:bin/generate_apacheconf|BIN/GENERATE_APACHECONF]]<div><!-- Edit below this comment -->
  
  
Line 8: Line 8:
 
'''generate_apacheconf''' - Create the apache config files needed for EPrints
 
'''generate_apacheconf''' - Create the apache config files needed for EPrints
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
</div>
 
 
<!-- Pod2Wiki=head_synopsis -->
 
<!-- Pod2Wiki=head_synopsis -->
 
==SYNOPSIS==
 
==SYNOPSIS==
−
'''generate_apacheconf''' ['''options''']  
+
'''generate_apacheconf''' ['''options'''] [<em>repository_id</em>]
 +
 
 +
'''generate_apacheconf''' --replace [repoid]
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
</div>
 
 
<!-- Pod2Wiki=head_description -->
 
<!-- Pod2Wiki=head_description -->
 
==DESCRIPTION==
 
==DESCRIPTION==
−
This script generates the apache config files which will be used by EPrints. In the simple case all you need to do is run this script then add a line to your main apache configuration file - often, but not always, '''/usr/local/apache/conf/httpd.conf'''
+
This script generates the config files to include in your Apache configuration.
−
 
 
−
Include /opt/eprints3/cfg/apache.conf
 
−
 
 
−
Or elsewhere if you installed EPrints somewhere other than /opt/eprints3. This file then uses the "Include" directive to include all relevant apache config files from this EPrints installation.
 
  
−
By default the virtualhost directives are
+
If you have changed a repository's configuration (hostname/port/path) you can update the configuration for that repository with:
  
−
VirtualHost *
+
<pre> generate_apacheconf --replace [repoid]</pre>
−
 
 
−
But the * can be changed to something different by editing the <tt>virtualhost</tt> option in SystemSettings.pm
 
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
</div>
+
<!-- Pod2Wiki=head_adding_to_apache_configuration -->
−
<!-- Pod2Wiki=head_arguments -->
+
===Adding to Apache Configuration===
−
==ARGUMENTS==
+
To enable EPrints you must add the following line to your main Apache configuration file (<em>/etc/httpd/conf/httpd.conf</em>):
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
  
 +
<pre> Include /opt/eprints3/cfg/apache.conf</pre>
  
−
<!-- Pod2Wiki= -->
+
To enable secure (HTTPS) you must add the following line to your SSL VirtualHost:
−
</div>
 
−
<!-- Pod2Wiki=head_options -->
 
−
==OPTIONS==
 
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
−
 
 
−
 
 
−
<!-- Pod2Wiki= -->
 
−
</div>
 
−
<!-- Pod2Wiki=item_b_help -->
 
−
==='''--help'''===
 
  
−
Print a brief help message and exit.
+
<pre> Include /opt/eprints3/cfg/apache_ssl.conf</pre>
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
</div>
+
<!-- Pod2Wiki=head_arguments -->
−
<!-- Pod2Wiki=item_b_man -->
+
==ARGUMENTS==
−
==='''--man'''===
+
* repository_id
 +
: Optionally update the given repository's apache configuration only. Will only replace an existing configuration file with the --replace option.
  
−
Print the full manual page and then exit.
 
−
 
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
</div>
+
<!-- Pod2Wiki=head_options -->
−
<!-- Pod2Wiki=item_b_quiet -->
+
==OPTIONS==
−
==='''--quiet'''===
+
* '''--replace'''
−
 
+
: Replace existing configuration files, overwriting any changes made.
−
Be vewwy vewwy quiet. This option will supress all output unless an error occurs.
 
−
 
 
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
  
 +
* '''--system'''
 +
: Update the system configuration file, overwriting any changes made.
  
−
<!-- Pod2Wiki= -->
+
* '''--help'''
−
</div>
+
: Print a brief help message and exit.
−
<!-- Pod2Wiki=item_b_verbose -->
 
−
==='''--verbose'''===
 
−
 
 
−
Explain in detail what is going on. May be repeated for greater effect.
 
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* '''--man'''
−
<span style='display:none'>User Comments</span>
+
: Print the full manual page and then exit.
−
<!-- Edit below this comment -->
 
  
 +
* '''--quiet'''
 +
: Be vewwy vewwy quiet. This option will supress all output unless an error occurs.
  
−
<!-- Pod2Wiki= -->
+
* '''--verbose'''
−
</div>
+
: Explain in detail what is going on. May be repeated for greater effect.
−
<!-- Pod2Wiki=item_b_version -->
 
−
==='''--version'''===
 
  
−
Output version information and exit.
+
* '''--version'''
 +
: Output version information and exit.
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
</div>
 
 
<!-- Pod2Wiki=head_files -->
 
<!-- Pod2Wiki=head_files -->
 
==FILES==
 
==FILES==
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* '''EPRINTS/cfg/apache.conf'''
−
<span style='display:none'>User Comments</span>
+
: Loads the EPrints environment and repository-specific configuration files.
−
<!-- Edit below this comment -->
 
−
 
 
  
−
<!-- Pod2Wiki= -->
+
* '''EPRINTS/cfg/apache_ssl.conf'''
−
</div>
+
: Loads the repository-specific SSL configuration files.
−
<!-- Pod2Wiki=item_b_eprints_cfg_apache_conf -->
 
−
==='''EPRINTS/cfg/apache.conf'''===
 
  
−
This file is not updated if it already exists, so you can add system-wide apache configuration directives here. By default it just includes the two other system wide files: auto-apache-includes.conf and auto-apache.conf
+
* '''EPRINTS/cfg/apache/[repoid].conf'''
 +
: A &lt;VirtualHost&gt; that responds to the configured hostname and port of the repository.
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* '''EPRINTS/cfg/apache_ssl/[repoid].conf'''
−
<span style='display:none'>User Comments</span>
+
: A &lt;Location&gt; that responds to the configured https_root of the repository.
−
<!-- Edit below this comment -->
 
  
 +
* '''EPRINTS/archives/[repoid]/cfg.d/10_base.pl'''
 +
: Default location for host and path directives used to build the Apache configuration files.
  
−
<!-- Pod2Wiki= -->
+
<pre></pre>
−
</div>
 
−
<!-- Pod2Wiki=item_b_eprints_cfg_auto_apache_includes_conf -->
 
−
==='''EPRINTS/cfg/auto-apache-includes.conf'''===
 
  
−
This file is updated with Include lines to each of the repository specific apache config files. This file should not be edited by hand,
 
−
 
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
</div>
+
<!-- Pod2Wiki=head_copyright -->
−
<!-- Pod2Wiki=item_b_eprints_cfg_auto_apache_conf -->
+
==COPYRIGHT==
−
==='''EPRINTS/cfg/auto-apache.conf'''===
+
Copyright 2000-2011 University of Southampton.
  
−
This file contains the system wide apache directives required by EPrints. This file should not be edited by hand.
+
This file is part of EPrints http://www.eprints.org/.
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
  
 +
EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  
−
<!-- Pod2Wiki= -->
+
You should have received a copy of the GNU General Public License along with EPrints.  If not, see http://www.gnu.org/licenses/.
−
</div>
 
−
<!-- Pod2Wiki=item_b_eprints_archives_archivedir_cfg_apache_conf -->
 
−
==='''EPRINTS/archives/ARCHIVEDIR/cfg/apache.conf'''===
 
  
−
This file is not updated if it already exists, so you can add repository-specific apache configuration directives here. By default it just includes the automatically generated repository specific file: auto-apache.conf
 
−
 
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
</div>
+
<!-- Pod2Wiki=_postamble_ -->
−
<!-- Pod2Wiki=item_b_eprints_archives_archivedir_var_auto_apache_conf -->
 
−
==='''EPRINTS/archives/ARCHIVEDIR/var/auto-apache.conf'''===
 
−
 
 
−
This file contains all the configuration directives needed for an repository. This is where the bulk of the configuration appears, the clever stuff, if you will. This file should not be edited by hand.
 
−
 
 
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
−
 
−
 
−
<!-- Pod2Wiki= -->
 
−
</div>
 
−
<!-- Pod2Wiki=item_b_eprints_archives_archivedir_var_auto_secure_conf -->
 
−
==='''EPRINTS/archives/ARCHIVEDIR/var/auto-secure.conf'''===
 
−
 
−
Only created if the repository has a securehost configured. This file contains all the configuration options that need to be included into the secure server virtualhost.
 
−
 
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
−
 
−
 
−
<!-- Pod2Wiki= -->
 
−
</div>
 
−
<!-- Pod2Wiki=item_b_eprints_archives_archivedir_cfg_apachevhost_conf -->
 
−
==='''EPRINTS/archives/ARCHIVEDIR/cfg/apachevhost.conf'''===
 
−
 
−
This file is not updated if it already exists, it is included into the virutalhost in auto-apache.conf so that you can a couple of additional directives if you need to. For example, redirects or additional log directives.
 
−
 
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
−
 
−
 
−
<!-- Pod2Wiki= -->
 
−
</div>
 
−
<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->
 

Latest revision as of 09:57, 22 January 2013

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects

API: Core API

Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki


NAME

generate_apacheconf - Create the apache config files needed for EPrints


SYNOPSIS

generate_apacheconf [options] [repository_id]

generate_apacheconf --replace [repoid]


DESCRIPTION

This script generates the config files to include in your Apache configuration.

If you have changed a repository's configuration (hostname/port/path) you can update the configuration for that repository with: 

 generate_apacheconf --replace [repoid]


Adding to Apache Configuration

To enable EPrints you must add the following line to your main Apache configuration file (/etc/httpd/conf/httpd.conf): 

 Include /opt/eprints3/cfg/apache.conf

To enable secure (HTTPS) you must add the following line to your SSL VirtualHost: 

 Include /opt/eprints3/cfg/apache_ssl.conf


ARGUMENTS

  • repository_id
Optionally update the given repository's apache configuration only. Will only replace an existing configuration file with the --replace option.


OPTIONS

  • --replace
Replace existing configuration files, overwriting any changes made.
  • --system
Update the system configuration file, overwriting any changes made.
  • --help
Print a brief help message and exit.
  • --man
Print the full manual page and then exit.
  • --quiet
Be vewwy vewwy quiet. This option will supress all output unless an error occurs.
  • --verbose
Explain in detail what is going on. May be repeated for greater effect.
  • --version
Output version information and exit.


FILES

  • EPRINTS/cfg/apache.conf
Loads the EPrints environment and repository-specific configuration files.
  • EPRINTS/cfg/apache_ssl.conf
Loads the repository-specific SSL configuration files.
  • EPRINTS/cfg/apache/[repoid].conf
A <VirtualHost> that responds to the configured hostname and port of the repository.
  • EPRINTS/cfg/apache_ssl/[repoid].conf
A <Location> that responds to the configured https_root of the repository.
  • EPRINTS/archives/[repoid]/cfg.d/10_base.pl
Default location for host and path directives used to build the Apache configuration files.







COPYRIGHT


Copyright 2000-2011 University of Southampton.

This file is part of EPrints http://www.eprints.org/.

EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with EPrints.  If not, see http://www.gnu.org/licenses/.














					

						Retrieved from ‘https://wiki.eprints.org/w/index.php?title=API:bin/generate_apacheconf&oldid=10722’