dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #22800
[Branch ~dhis2-devs-core/dhis2/trunk] Rev 11077: [dhis2-tools]
------------------------------------------------------------
revno: 11077
committer: Bob Jolliffe <bobjolliffe@xxxxxxxxx>
branch nick: dhis2
timestamp: Wed 2013-05-29 12:52:03 +0100
message:
[dhis2-tools]
Made dhis2-restoredb more flexile in accepting gzip, bzipped and plain sql files
Reworked dhis2-deploy-war to allow deployment of war from stable release other user determined locations
Some updates to reference manual
removed:
tools/dhis2-tools-deb/pkg/usr/bin/dhis2-deploy-stable
added:
tools/dhis2-tools-deb/pkg/usr/bin/dhis2-deploy-war
modified:
tools/dhis2-tools-deb/docs/manual.xml
tools/dhis2-tools-deb/pkg/usr/bin/dhis2-restoredb
--
lp:dhis2
https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk
Your team DHIS 2 developers is subscribed to branch lp:dhis2.
To unsubscribe from this branch go to https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk/+edit-subscription
=== modified file 'tools/dhis2-tools-deb/docs/manual.xml'
--- tools/dhis2-tools-deb/docs/manual.xml 2013-05-28 12:06:12 +0000
+++ tools/dhis2-tools-deb/docs/manual.xml 2013-05-29 11:52:03 +0000
@@ -1,18 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
- "http://www.docbook.org/xml/4.5/docbookx.dtd";>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.docbook.org/xml/4.5/docbookx.dtd";>
<book>
<bookinfo>
<title>DHIS2 server tools manual</title>
<author>
- <firstname>Bob</firstname>
- <surname>Jolliffe</surname>
+ <firstname>DHIS2 developer team</firstname>
</author>
</bookinfo>
<chapter>
<title>Overview</title>
- <para>Installing and managing DHIS2.</para>
+ <para>The dhis2-tools package is a collection of tools and utilities for installing and managing
+ DHIS2 applications on an ubuntu server. The tools provide the ability to go from a "blank"
+ server with only ssh running, to a fully functioning dhis2 installation in a matter of
+ minutes. Used together they can also be combined into automated scripts to facilitate rapid
+ reconstruction of a given configuration.</para>
</chapter>
<chapter>
@@ -41,7 +43,29 @@
<refsect1>
<title>Description</title>
- <para>Use this tool to create a new dhis2 instance in a tomcat container.</para>
+ <para>Use this tool to create a new dhis2 instance in a tomcat container. The name that is
+ specified will be used to create a new user and a new database with the name of that user.
+ The user will be assigned to the <emphasis role="bold">dhis2</emphasis> group. The user
+ will have a home directory created in /var/lib/dhis2/<username>. This directory acts as
+ both the <emphasis role="bold">DHIS2_HOME</emphasis> directory and also the <emphasis
+ role="bold">CATALINA_BASE</emphasis> directory for the tomcat servlet container.</para>
+ <para>By default the instance is allocated 2G of heap space RAM. This can be adjusted by
+ editing the parameters in <emphasis role="bold">/var/lib/dhis2/<name>/bin/setenv.sh</emphasis>.</para>
+ <para>The servlet container is configured to run with an http connector pool of a maximum of
+ 100 threads. This parameter can be adjusted by editing <emphasis role="bold">/var/lib/dhis2/<name>/conf/server.conf</emphasis>.</para>
+ <para>The servlet container configuration has been specially tweaked for running DHIS2. For
+ example tomcat filters are used to ensure that all static content from the web application
+ are cacheable by web proxy servers such as nginx or apache. The lib directory of the
+ webapp has been explicitly placed in the application classpath so that additional jars
+ such as java compiled apache camel routes can be made available to the DHIS2
+ application.</para>
+ <para>Note that a dhis2 war file is not deployed by default. See the manual page for
+ <emphasis role="bold">dhis2-deploy-war</emphasis> for instructions to deploy a dhis2 war
+ file over the internet from the latest stable global build, latest trunk build or from a
+ user specified war file on the filesystem. </para>
+ <para>You need to be a member of the <emphasis role="bold">dhis2-admin</emphasis> group to
+ use these and other tools for managing the instance. See the manual page for <emphasis
+ role="bold">dhis2-create-admin</emphasis>.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
@@ -54,7 +78,13 @@
</refsect1>
<refsect1>
<title>Examples</title>
- <para>Create it like this</para>
+ <para><command>dhis2-instance-create -p 8080 hmis</command></para>
+ <para>Creates a new instance called hmis listening on http port 8080.</para>
+ </refsect1>
+ <refsect1>
+ <title>See also</title>
+ <para>dhis2-create-admin (1), dhis2-deploy-war (1), dhis2-startup (1), dhis2-shutdown (1),
+ dhis2-deploy-war (1) and dhis2-log (1).</para>
</refsect1>
</refentry>
@@ -117,28 +147,52 @@
<!-- ============================================================================== -->
<refentry>
<refmeta>
- <refentrytitle>dhis2-deploy-stable</refentrytitle>
+ <refentrytitle>dhis2-deploy-war</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
- <refname>dhis2-deploy-stable</refname>
+ <refname>dhis2-deploy-war</refname>
<refpurpose>Deploys a war file</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>/usr/bin/dhis2-deploy-stable</command>
- <arg choice="opt">instance name</arg>
+ <arg choice="opt">
+ <option>OPTIONS</option>
+ </arg>
+ <arg choice="plain">instance name</arg>
</cmdsynopsis>
</refsynopsisdiv>
-
+
+ <refsect1>
+ <title>OPTIONS</title>
+ <variablelist>
+ <varlistentry>
+ <term>-t</term>
+ <listitem><para>Deploy war from latest trunk build. NOT RECOMMENDED for production systems</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>-l</term>
+ <listitem><para>Deploy war located at a custom url</para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>-f</term>
+ <listitem><para>Deploy war from a file on the filesystem</para></listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
<refsect1>
<title>Description</title>
- <para>Deploys the latest stable dhis2 war file from http://stable.dhis2.org.</para>
+ <para>Deploys a dhis2 war file to the instance. The default behaviour when no options are given is to download and deploy the latest stable release from http://stable.dhis2.org.</para>
</refsect1>
<refsect1>
<title>Examples</title>
- <para>dhis2-deploy-stable myInstance</para>
+ <para><command>dhis2-deploy-war myInstance</command> deploys the latest stable release from dhis2.org into myInstance.</para>
+ <para><command>dhis2-deploy-war -f wars/dhis.war myInstance</command> deploys the war file at wars/dhis.war into myInstance.</para>
+ <para><command>dhis2-deploy-war -t myInstance</command> deploys the latest trunk build from the dhis2 team integration server into myInstance. Don't use this in production.</para>
+ <para><command>dhis2-deploy-war -l http://mywars.org/dhis.war myInstance</command> deploys the war file from a user provided url into myInstance.</para>
</refsect1>
</refentry>
=== removed file 'tools/dhis2-tools-deb/pkg/usr/bin/dhis2-deploy-stable'
--- tools/dhis2-tools-deb/pkg/usr/bin/dhis2-deploy-stable 2013-05-28 12:06:12 +0000
+++ tools/dhis2-tools-deb/pkg/usr/bin/dhis2-deploy-stable 1970-01-01 00:00:00 +0000
@@ -1,25 +0,0 @@
-#!/bin/sh
-# ____ __ ______________
-# / __ \/ / / / _/ ___/__ \
-# / / / / /_/ // / \__ \__/ /
-# / /_/ / __ // / ___/ / __/
-# /_____/_/ /_/___//____/____/
-#
-# DHIS2 instance startup script
-
-set -e
-
-if [ "$#" -ne 1 ]; then
- echo "usage: dhis2-deploy-stable <instance name>"
- exit 1
-fi
-
-INSTANCE=$1
-DHIS2STABLE="http://stable.dhis2.org";
-
-dhis2-shutdown $INSTANCE 2>/dev/null || { echo $INSTANCE not running; }
-# clean out existing webapps
-sudo -u $INSTANCE rm -rf /var/lib/dhis2/$INSTANCE/webapps/* 1>/dev/null 2>&1 || { echo "No $INSTANCE webapps"; exit 1; }
-# get the latest stable dhis.war
-sudo -u $INSTANCE wget -O /var/lib/dhis2/$INSTANCE/webapps/$INSTANCE.war $DHIS2STABLE
-dhis2-startup $INSTANCE
=== added file 'tools/dhis2-tools-deb/pkg/usr/bin/dhis2-deploy-war'
--- tools/dhis2-tools-deb/pkg/usr/bin/dhis2-deploy-war 1970-01-01 00:00:00 +0000
+++ tools/dhis2-tools-deb/pkg/usr/bin/dhis2-deploy-war 2013-05-29 11:52:03 +0000
@@ -0,0 +1,59 @@
+#!/bin/sh
+# ____ __ ______________
+# / __ \/ / / / _/ ___/__ \
+# / / / / /_/ // / \__ \__/ /
+# / /_/ / __ // / ___/ / __/
+# /_____/_/ /_/___//____/____/
+#
+# DHIS2 war deployment
+
+set -e
+
+DHIS2STABLE="http://stable.dhis2.org";
+DHIS2TRUNK="http://trunk.dhis2.org";
+TEMPWAR=/tmp/dhis.war
+
+SOURCE=$DHIS2STABLE
+
+# remove any stale temp file
+rm -f $TEMPWAR
+
+while getopts :tl:f: opt;
+do
+ case $opt in
+ f)
+ cp $OPTARG $TEMPWAR;
+ break;
+ ;;
+ t)
+ SOURCE=$DHIS2TRUNK
+ ;;
+ l)
+ SOURCE=$OPTARG
+ ;;
+ \?)
+ echo "Invalid option -$opt" >&2
+ exit 1;
+ ;;
+ :)
+ echo "Option -$opt requires an argument." >&2
+ exit 1
+ esac
+done
+
+shift $(( $OPTIND-1 ))
+
+INSTANCE=$1
+TARGET=/var/lib/dhis2/$INSTANCE/webapps/$INSTANCE.war
+
+# download war file if we don't have it
+test -f $TEMPWAR || wget -O $TEMPWAR $SOURCE
+unzip -tq $TEMPWAR || { echo "Corrupt war file: $TEMPWAR"; exit 1; }
+
+dhis2-shutdown $INSTANCE 2>/dev/null || { echo $INSTANCE not running; }
+# clean out existing webapp
+sudo -u $INSTANCE rm -rf /var/lib/dhis2/$INSTANCE/webapps/$INSTANCE 1>/dev/null 2>&1 || { echo "No $INSTANCE webapps"; exit 1; }
+sudo -u $INSTANCE cp $TEMPWAR $TARGET
+
+rm $TEMPWAR || echo "Warning $TEMPWAR not deleted. Please delete manually."
+dhis2-startup $INSTANCE
=== modified file 'tools/dhis2-tools-deb/pkg/usr/bin/dhis2-restoredb'
--- tools/dhis2-tools-deb/pkg/usr/bin/dhis2-restoredb 2013-05-28 17:30:32 +0000
+++ tools/dhis2-tools-deb/pkg/usr/bin/dhis2-restoredb 2013-05-29 11:52:03 +0000
@@ -45,4 +45,4 @@
pg_dump -s $DHIS2_DB | grep -i 'owner to' | sed -e "s/OWNER TO .*;/OWNER TO $DHIS2_USER;/i"|psql $DHIS2_DB
# restart tomcat
-dhis2-startup $INSTANCE
+# dhis2-startup $INSTANCE
