Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<info>
<title>Advanced Installation Methods</title>
<date>1Q18</date>
<date>2Q19</date>
<keywordset>
<keyword>installation</keyword>
<keyword>operations</keyword>
Expand Down Expand Up @@ -46,25 +46,6 @@
background service which is automatically launched during system start-up. This can be
convenient, especially for servers. eXist-db continues to run even after users have
logged off.</para>
<para>eXist-db comes with pre-configured scripts that use <link condition="_blank"
xlink:href="http://yajsw.sourceforge.net/">YAJSW (Yet Another Java Service
Wrapper)</link> to handle the setup procedure. The scripts for this are contained in the
directory <literal>tools/yajsw</literal>. </para>
<para>Out of the box the following mainstream platforms are supported:</para>
<itemizedlist>
<listitem>
<para>Windows x86 (32bit/64bit)</para>
</listitem>
<listitem>
<para>Linux x86 (32bit/64bit) &amp; IA (64bit) </para>
</listitem>
<listitem>
<para>macOS x86 (32bit/64bit) </para>
</listitem>
<listitem>
<para>Solaris x86 (32bit/64bit) &amp; SPARC (32bit/64bit)</para>
</listitem>
</itemizedlist>

<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->

Expand All @@ -81,10 +62,6 @@
<para>Choose <guimenuitem>Install eXist-db as Service</guimenuitem> from
eXist-db's entry in the Windows start menu.</para>
</listitem>
<listitem>
<para>Run <literal>tools/yajsw/bin/installService.bat</literal> from the command
line.</para>
</listitem>
</itemizedlist>
<para>Installing eXist-db as a service on Windows requires full administrator
rights.</para>
Expand All @@ -98,9 +75,6 @@
</imageobject>
</mediaobject>
</informalfigure>
<para>Launch it via the service manager (as shown in the screenshot above) or from the
command line:</para>
<programlisting>tools\yaysw\bin\startService.bat</programlisting>
</sect2>

<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
Expand All @@ -109,7 +83,7 @@
<title>Unix/Linux</title>

<para>The scripts for running eXist-db as a service for Unix and Linux based system
(among which MacOS)can be found in the <literal>tools/yajsw/bin/</literal>
(among which MacOS) can be found in the <literal>tools/serviced/</literal>
sub-directory.</para>
<para>Run the following command to get eXist-db started during initialization of the
system:</para>
Expand Down Expand Up @@ -168,17 +142,6 @@
</sect3>

</sect2>

<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->

<sect2 xml:id="other">
<title>Other platforms</title>

<para>Support for additional platforms can be bootstrapped by looking at templates in
the <code>tools/yajsw/templates</code> sub-directory. Consult the <link
condition="_blank" xlink:href="http://yajsw.sourceforge.net/">YAJSW
documentation</link> for more information.</para>
</sect2>
</sect1>

<!-- ================================================================== -->
Expand All @@ -187,8 +150,8 @@
<title>Alternatives for scripts in the bin Directory</title>

<para>Included in the distribution are a number of useful <literal>.sh</literal> (Unix
Shell) and <literal>.bat</literal> (DOS batch) programs located in the
<literal>bin</literal> sub-directory. Their names speak for themselves.</para>
Shell) and <literal>.bat</literal> (Windows batch) programs located in the
<literal>bin</literal> sub-directory. Their names speak for themselves.</para>
<para>However, if you find that programs do not launch, you can try to manually launch them
on the command-line without the scripting wrapper. This often provides useful debugging
information.</para>
Expand All @@ -197,7 +160,6 @@
<varlistentry>
<term> <code>startup.sh</code> (Unix) / <code>startup.bat</code> (Windows)</term>
<listitem>
<programlisting>java -jar start.jar jetty</programlisting>
<para>Starts the included Jetty web server at port 8080. eXist runs as a web
application, located at <link xlink:href="http://localhost:8080/exist/"
>http://localhost:8080/exist/</link>. </para>
Expand All @@ -206,7 +168,7 @@
<varlistentry>
<term> <code>shutdown.sh</code> (Unix) / <code>shutdown.bat</code> (Windows)</term>
<listitem>
<programlisting>java -jar start.jar shutdown -p youradminpassword</programlisting>
<programlisting>shutdown.sh -p youradminpassword</programlisting>
<para>Closes the running instance of eXist. If eXist has been started with
<literal>startup.sh</literal>, calling <literal>shutdown.sh</literal> will
also stop the Jetty web server. Otherwise, only the database is stopped by
Expand All @@ -215,22 +177,11 @@
<literal>shutdown</literal> before killing the server process.</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <code>server.sh</code> (Unix) / <code>server.bat</code> (Windows)</term>
<listitem>
<programlisting>java -jar start.jar standalone</programlisting>
<para>Launches eXist as a stand-alone server process. In this setup, eXist is
only accessible through the XMLRPC and the built-in HTTP interface.</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <code>client.sh</code> (Unix) / <code>client.bat</code> (Windows)</term>
<listitem>
<programlisting>java -jar start.jar client</programlisting>
<para>Launches the <link xlink:href="java-admin-client">Java Admin
Client</link>. This application is also launched if no application is
selected on the command-line, like this:</para>
<programlisting>java -jar start.jar</programlisting>
Client</link>.</para>
</listitem>
</varlistentry>
</variablelist>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Wolfgangs-MacBook-Air:eXist wolf$ java -jar installer/eXist-db-setup-2.0RC2-rev17974.jar -console
Wolfgangs-MacBook-Air:eXist wolf$ java -jar exist-installer/target/exist-installer-5.0.0-RC8-SNAPSHOT.jar
Select target path [/Users/wolf/Source/trunk/eXist]
/Applications/eXist/
press 1 to continue, 2 to quit, 3 to redisplay
1
Set Data Directory
Please select a directory where eXist will keep its data files. On Vista and Windows 7, this should be outside the usual 'Program Files' directory:
Data dir: [webapp/WEB-INF/data]
Data dir: [data]

press 1 to continue, 2 to quit, 3 to redisplay
1
Expand Down Expand Up @@ -40,12 +40,12 @@ press 1 to continue, 2 to quit, 3 to redisplay
[ Starting processing ]
Starting process Setting admin password ... (1/1)
--- Starting embedded database instance ---
File lock last access timestamp: 30.12.2012 /Applications/eXist/webapp/WEB-INF/data/dbx_dir.lck
Found a stale lockfile. Trying to remove it: /Applications/eXist/webapp/WEB-INF/data/dbx_dir.lck
File lock last access timestamp: 30.12.2012 /Applications/eXist/webapp/WEB-INF/data/journal.lck
Found a stale lockfile. Trying to remove it: /Applications/eXist/webapp/WEB-INF/data/journal.lck
File lock last access timestamp: 30.12.2012 /Applications/eXist/data/dbx_dir.lck
Found a stale lockfile. Trying to remove it: /Applications/eXist/data/dbx_dir.lck
File lock last access timestamp: 30.12.2012 /Applications/eXist/data/journal.lck
Found a stale lockfile. Trying to remove it: /Applications/eXist/data/journal.lck
Dez 30, 2012 10:13:26 PM org.expath.pkg.repo.util.Logger info
INFO: Create a new repository with storage: File system storage in /Applications/eXist/webapp/WEB-INF/expathrepo
INFO: Create a new repository with storage: File system storage in /Applications/eXist/data/expathrepo
Setting admin user password...
--- Initialization complete. Shutdown embedded database instance ---
[ Console installation done ]
24 changes: 7 additions & 17 deletions src/main/xar-resources/data/ant-tasks/ant-tasks.xml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<info>
<title>Ant Tasks</title>
<date>1Q18</date>
<date>2Q19</date>
<keywordset>
<keyword>operations</keyword>
</keywordset>
Expand All @@ -17,9 +17,9 @@
<!-- ================================================================== -->

<para>eXist-db provides a library for the <link xlink:href="http://ant.apache.org"
><code>Ant</code></link> build tool to automate common system administration and operation
tasks, like backup/restore or importing files. <code>Ant</code> is included in the eXist-db
distribution (only if you've installed the eXist-db source code).</para>
><code>Ant</code></link> build tool to automate common system administration and
operation tasks, like backup/restore or importing files. The latest version of eXist-db's
Ant Tasks can be found on Maven Central as the artifact <link xlink:href="https://search.maven.org/search?q=g:org.exist-db%20AND%20a:exist-ant">exist-ant</link>.</para>

<!-- ================================================================== -->

Expand All @@ -35,22 +35,11 @@
<programlisting>&lt;project xmlns:xdb="http://exist-db.org/ant" … &gt;</programlisting>
</listitem>
<listitem>
<para>Import the eXist-db tasks by adding the following code:</para>
<para>Import the eXist-db tasks with Ivy and then add the following code:</para>
<programlisting language="xml" xlink:href="listings/listing-1.xml"/>
</listitem>
<listitem>
<para>Setup the <code>classpath</code> (the property <code>${server.dir}</code> must
point to the eXist-db installation directory):</para>
<programlisting language="xml" xlink:href="listings/listing-2.xml"/>
</listitem>
</itemizedlist>

<note>
<para>For a working example have a look into the file
<literal>webapp/xqts/build.xml</literal>, which is used to prepare the database for
running the xquery test suite.</para>
</note>

</sect1>

<!-- ================================================================== -->
Expand Down Expand Up @@ -848,7 +837,8 @@
eXist-db (remote or local).</para>
<para>Supply your own values for the source and target <code>user</code>, <code>pass</code>,
and <code>url</code> properties. You can find this Ant script under the
<code>samples/ant</code> directory.</para>
<code>$EXIST_HOME/exist-samples/src/main/resources/org/exist/samples/ant</code>
directory.</para>
<programlisting language="xml" xlink:href="listings/listing-37.xml"/>
</sect1>

Expand Down
4 changes: 1 addition & 3 deletions src/main/xar-resources/data/ant-tasks/listings/listing-1.xml
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
<typedef resource="org/exist/ant/antlib.xml" uri="http://exist-db.org/ant">
<classpath refid="classpath.core"/>
</typedef>
<typedef resource="org/exist/ant/antlib.xml" uri="http://exist-db.org/ant"/>
7 changes: 0 additions & 7 deletions src/main/xar-resources/data/ant-tasks/listings/listing-2.xml

This file was deleted.

43 changes: 35 additions & 8 deletions src/main/xar-resources/data/backup/backup.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<info>
<title>Database Backup and Restore</title>
<date>1Q18</date>
<date>2Q19</date>
<keywordset>
<keyword>operations</keyword>
</keywordset>
Expand Down Expand Up @@ -160,7 +160,7 @@
<para>eXist-db can also create <emphasis>incremental backups</emphasis>, meaning only
resources which were modified since the last backup are backed up.</para>
<para>All backups will be stored in ZIP format. The default storage directory is
<literal>webapp/WEB-INF/data/export/</literal>. You can configure a different
<literal>$EXIST_HOME/data/export/</literal>. You can configure a different
directory in the configuration file <literal>conf.xml</literal>.</para>
</sect2>

Expand All @@ -170,7 +170,7 @@
<para>You can use eXist-db's <link xlink:href="configuration">scheduler</link> to
schedule server-side backup and consistency check tasks. To do this, add the
following definition to the scheduler section in the configuration file
<literal>conf.xml</literal></para>
<literal>$EXIST_HOME/etc/conf.xml</literal></para>


<example>
Expand Down Expand Up @@ -309,7 +309,16 @@

<para>eXist also includes a command-line JMX client. Call it with parameter
<literal>-s</literal> to see the latest consistency report:</para>
<programlisting>java -jar start.jar org.exist.management.client.JMXClient -s</programlisting>
<itemizedlist>
<listitem>
<para>Unix/Linux:</para>
<programlisting>$EXIST_HOME/bin/jmxclient.sh -s</programlisting>
</listitem>
<listitem>
<para>Windows:</para>
<programlisting>$EXIST_HOME\bin\jmxclient.bat -s</programlisting>
</listitem>
</itemizedlist>
<para>This may produce output as shown below:</para>
<programlisting xlink:href="listings/listing-6.txt"/>
<para>You can also subscribe to the notifications made available by the SanityReport
Expand Down Expand Up @@ -423,9 +432,9 @@
<para>Stop the running eXist database instance</para>
</listitem>
<listitem>
<para>Change into directory <literal>EXIST_HOME/webapp/WEB-INF/data</literal> or
<para>Change into directory <literal>$EXIST_HOME/data</literal> or
another directory you specified as data directory in the configuration
(<code>conf.xml</code>).</para>
(<code>$EXIST_HOME/etc/conf.xml</code>).</para>
</listitem>
<listitem>
<para>Remove all <literal>.dbx</literal>, <literal>.lck</literal> and
Expand Down Expand Up @@ -550,7 +559,16 @@
<para>This tool needs direct access to the database files, so you must stop the running
database instance first if it is active.</para>
<para>Use the following command line to start the utility as a GUI:</para>
<programlisting>java -jar start.jar org.exist.backup.ExportGUI</programlisting>
<itemizedlist>
<listitem>
<para>Unix/Linux:</para>
<programlisting>$EXIST_HOME/bin/export-gui.sh</programlisting>
</listitem>
<listitem>
<para>Windows:</para>
<programlisting>$EXIST_HOME\bin\export-gui.bat</programlisting>
</listitem>
</itemizedlist>
<informalfigure>
<mediaobject>
<imageobject>
Expand All @@ -564,7 +582,16 @@
consistency check <emphasis>and</emphasis> a full backup.</para>
<para>On a headless system use the command-line version instead (The <literal>-h</literal>
parameter will get you a list of possible options):</para>
<programlisting>java -jar start.jar org.exist.backup.ExportMain</programlisting>
<itemizedlist>
<listitem>
<para>Unix/Linux:</para>
<programlisting>$EXIST_HOME/bin/export.sh</programlisting>
</listitem>
<listitem>
<para>Windows:</para>
<programlisting>$EXIST_HOME\bin\export.bat</programlisting>
</listitem>
</itemizedlist>
</sect1>

<sect1 xml:id="standalone">
Expand Down
Loading