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

From EPrints Documentation
Jump to: navigation, search
 
(2 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]][[Category:API:bin/generate_apacheconf|BIN/GENERATE_APACHECONF]][[Category:API:bin/generate_apacheconf|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==
Line 21: Line 18:
 
'''generate_apacheconf''' --replace [repoid]
 
'''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==
Line 34: Line 28:
 
If you have changed a repository's configuration (hostname/port/path) you can update the configuration for that repository with:
 
If you have changed a repository's configuration (hostname/port/path) you can update the configuration for that repository with:
  
generate_apacheconf --replace [repoid]
+
<pre> generate_apacheconf --replace [repoid]</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_adding_to_apache_configuration -->
 
<!-- Pod2Wiki=head_adding_to_apache_configuration -->
 
===Adding to Apache Configuration===
 
===Adding to Apache Configuration===
 
To enable EPrints you must add the following line to your main Apache configuration file (<em>/etc/httpd/conf/httpd.conf</em>):
 
To enable EPrints you must add the following line to your main Apache configuration file (<em>/etc/httpd/conf/httpd.conf</em>):
  
Include /opt/eprints3/cfg/apache.conf
+
<pre> Include /opt/eprints3/cfg/apache.conf</pre>
 
+
 
 
To enable secure (HTTPS) you must add the following line to your SSL VirtualHost:
 
To enable secure (HTTPS) you must add the following line to your SSL VirtualHost:
  
Include /opt/eprints3/cfg/apache_ssl.conf
+
<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=head_arguments -->
 
==ARGUMENTS==
 
==ARGUMENTS==
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* repository_id
<span style='display:none'>User Comments</span>
+
: Optionally update the given repository's apache configuration only. Will only replace an existing configuration file with the --replace option.
<!-- Edit below this comment -->
+
 
+
 
+
<!-- Pod2Wiki= -->
+
</div>
+
<!-- Pod2Wiki=item_repository_id -->
+
===repository_id===
+
 
+
Optionally update the given repository's apache configuration only. Will only replace an existing configuration file with the --replace option.
+
  
<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=head_options -->
 
==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%; '>
+
* '''--replace'''
<span style='display:none'>User Comments</span>
+
: Replace existing configuration files, overwriting any changes made.
<!-- 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_replace -->
+
==='''--replace'''===
+
  
Replace existing configuration files, overwriting any changes made.
+
* '''--man'''
 +
: 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%; '>
+
* '''--quiet'''
<span style='display:none'>User Comments</span>
+
: Be vewwy vewwy quiet. This option will supress all output unless an error occurs.
<!-- Edit below this comment -->
+
  
 +
* '''--verbose'''
 +
: Explain in detail what is going on. May be repeated for greater effect.
  
<!-- Pod2Wiki= -->
+
* '''--version'''
</div>
+
: Output version information and exit.
<!-- Pod2Wiki=item_b_system -->
+
==='''--system'''===
+
 
+
Update the system configuration file, overwriting any changes made.
+
  
<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=item_b_help -->
 
==='''--help'''===
 
 
Print a brief help message 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 -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_b_man -->
 
==='''--man'''===
 
 
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 -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_b_quiet -->
 
==='''--quiet'''===
 
 
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 -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- 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%; '>
 
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_b_version -->
 
==='''--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 -->
 
 
 
<!-- 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 -->
+
  
 +
* '''EPRINTS/cfg/apache_ssl.conf'''
 +
: Loads the repository-specific SSL configuration files.
  
<!-- Pod2Wiki= -->
+
* '''EPRINTS/cfg/apache/[repoid].conf'''
</div>
+
: A &lt;VirtualHost&gt; that responds to the configured hostname and port of the repository.
<!-- Pod2Wiki=item_b_eprints_cfg_apache_conf -->
+
==='''EPRINTS/cfg/apache.conf'''===
+
  
Loads the EPrints environment and repository-specific configuration files.
+
* '''EPRINTS/cfg/apache_ssl/[repoid].conf'''
 +
: A &lt;Location&gt; that responds to the configured https_root 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/archives/[repoid]/cfg.d/10_base.pl'''
<span style='display:none'>User Comments</span>
+
: Default location for host and path directives used to build the Apache configuration files.
<!-- Edit below this comment -->
+
  
 +
<pre></pre>
  
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_b_eprints_cfg_apache_ssl_conf -->
 
==='''EPRINTS/cfg/apache_ssl.conf'''===
 
 
Loads the repository-specific SSL configuration files.
 
 
<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_apache_repoid_conf -->
+
==COPYRIGHT==
==='''EPRINTS/cfg/apache/[repoid].conf'''===
+
Copyright 2000-2011 University of Southampton.
  
A &lt;VirtualHost&gt; that responds to the configured hostname and port of the repository.
+
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_cfg_apache_ssl_repoid_conf -->
+
==='''EPRINTS/cfg/apache_ssl/[repoid].conf'''===
+
  
A &lt;Location&gt; that responds to the configured https_root 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%; '>
 
<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_repoid_cfg_d_10_base_pl -->
+
==='''EPRINTS/archives/[repoid]/cfg.d/10_base.pl'''===
+
 
+
Default location for host and path directives used to build the Apache configuration files.
+
 
+
<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=_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.3, 3.2) | 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/.