Merge pull request #452 from mslinn/master

Enhanced install script so it works under Ubuntu and Mac OS/X

contrib/README.md

@@ -0,0 +1,13 @@
+# Contrib Notes #
+
+The configuration script adapts according to the OS.
+The `linux` directory contains scripts for Ubuntu and RedHat.
+The Mac scripts have been folded in as well.
+Common scripts are in this directory.
+
+This version of scripts has so far only been tested on Ubuntu and Mac. Someone else will have to test on RedHat.
+
+To run:
+1. Edit `gitbucket.conf` to suit.
+2. Type: `install`
+

contrib/gitbucket.conf

@@ -0,0 +1,62 @@
+# Configuration section is below. Ignore this part
+
+function isUbuntu {
+  if [ -f /etc/lsb-release ]; then
+    grep -i ubuntu /etc/lsb-release | head -n 1 | cut -d \  -f 1 | cut -d = -f 2
+  fi
+}
+
+function isRedHat {
+  if [ -d "/etc/rc.d/init.d" ]; then echo yes; fi
+}
+
+function isMac {
+  if [[ "$(uname -a | cut -d \  -f 1 )" == "Darwin" ]]; then echo yes; fi
+}
+
+# 
+# Configuration section start
+#
+
+# Bind host
+GITBUCKET_HOST=0.0.0.0
+
+# Other Java option
+GITBUCKET_JVM_OPTS=-Dmail.smtp.starttls.enable=true
+
+# Data directory, holds repositories
+GITBUCKET_HOME=/var/lib/gitbucket
+
+GITBUCKET_LOG_DIR=/var/log/gitbucket
+
+# Server port
+GITBUCKET_PORT=8080
+
+# URL prefix for the GitBucket page (http://<host>:<port>/<prefix>/)
+GITBUCKET_PREFIX=
+
+# Directory where GitBucket is installed
+# Configuration is stored here:
+GITBUCKET_DIR=/usr/share/gitbucket
+GITBUCKET_WAR_DIR=$GITBUCKET_DIR/lib
+
+# Path to the WAR file
+GITBUCKET_WAR_FILE=$GITBUCKET_WAR_DIR/gitbucket.war
+
+# GitBucket version to fetch when installing
+GITBUCKET_VERSION=2.1
+
+#
+# End of configuration section. Ignore this part
+#
+if [ `isUbuntu` ]; then
+  GITBUCKET_SERVICE=/etc/init.d/gitbucket
+elif [ `isRedHat` ]; then
+  GITBUCKET_SERVICE=/etc/rc.d/init.d
+elif [ `isMac` ]; then
+  GITBUCKET_SERVICE=/Library/StartupItems/GitBucket/GitBucket
+else
+  echo "Don't know how to install onto this OS"
+  exit -2
+fi
+

contrib/gitbucket.init

@@ -1,6 +1,8 @@
 #!/bin/bash
 #
-# /etc/rc.d/init.d/gitbucket
+# RedHat: /etc/rc.d/init.d/gitbucket
+# Ubuntu: /etc/init.d/gitbucket
+# Mac OS/X: /Library/StartupItems/GitBucket
 #
 # Starts the GitBucket server
 #
@@ -8,28 +10,44 @@
 # description: Run GitBucket server
 # processname: java
 
-# Source function library
-. /etc/rc.d/init.d/functions
+set -e
+
+[ -f /etc/rc.d/init.d/functions ] && source /etc/rc.d/init.d/functions  # RedHat
+[ -f /etc/rc.common ] && source /etc/rc.common # Mac OS/X
 
 # Default values
 GITBUCKET_HOME=/var/lib/gitbucket
 GITBUCKET_WAR_FILE=/usr/share/gitbucket/lib/gitbucket.war
 
 # Pull in cq settings
-[ -f /etc/sysconfig/gitbucket ] && . /etc/sysconfig/gitbucket
+[ -f /etc/sysconfig/gitbucket ] && source /etc/sysconfig/gitbucket # RedHat
+[ -f gitbucket.conf ] && source gitbucket.conf  # For all systems
 
 # Location of the log and PID file
-LOG_FILE=/var/log/gitbucket/run.log
+LOG_FILE=$GITBUCKET_LOG_DIR/run.log
 PID_FILE=/var/run/gitbucket.pid
 
-# Default return value
-RETVAL=0
+RED='\033[1m\E[37;41m'
+GREEN='\033[1m\E[37;42m'
+OFF='\E[0m'
 
+if [ -z "$(which success)" ]; then
+	function success {
+	  printf "%b\n" "$GREEN $* $OFF"
+  }
+fi
+if [ -z "$(which failure)" ]; then
+	function failure {
+	  printf "%b\n" "$RED $* $OFF"
+  }
+fi
+
+RETVAL=0
 
 start() {
 	echo -n $"Starting GitBucket server: "
 
-	# Compile statup parameters
+  START_OPTS=
 	if [ $GITBUCKET_PORT ]; then
 		START_OPTS="${START_OPTS} --port=${GITBUCKET_PORT}"
 	fi
@@ -40,17 +58,15 @@ start() {
 		START_OPTS="${START_OPTS} --host=${GITBUCKET_HOST}"
 	fi
 
-	# Run the Java process
 	GITBUCKET_HOME="${GITBUCKET_HOME}" java $GITBUCKET_JVM_OPTS -jar $GITBUCKET_WAR_FILE $START_OPTS >>$LOG_FILE 2>&1 &
 	RETVAL=$?
 
-	# Store PID of the Java process into a file
 	echo $! > $PID_FILE
 
 	if [ $RETVAL -eq 0 ] ; then
-		success "GitBucket startup"
+		success "Success"
 	else
-		failure "GitBucket startup"
+		failure "Exit code $RETVAL"
 	fi
 
 	echo
@@ -82,7 +98,23 @@ restart() {
 	start
 }
 
+## MacOS proxies for System V service hooks:
+StartService() {
+	start
+}
 
+StopService() {
+	stop
+}
+
+RestartService() {
+	restart
+}
+
+
+if [ `isMac` ]; then
+  RunService "$1"
+else
 	case "$1" in
 		start)
 			start
@@ -101,6 +133,6 @@ status)
 			echo $"Usage: $0 [start|stop|restart|status]"
 			RETVAL=2
 	esac
-
-
   exit $RETVAL
+fi
+

contrib/install

@@ -0,0 +1,69 @@
+#!/bin/bash
+
+# Only tested on Ubuntu 14.04
+
+# Uses information stored in GitBucket git repo on GitHub as defaults.
+# Edit gitbucket.conf before running this
+
+set -e
+
+GITBUCKET_VERSION=2.1
+
+if [ ! -f gitbucket.conf ]; then
+  echo "gitbucket.conf not found, aborting"
+  exit -3
+fi
+source gitbucket.conf
+
+function createDir {
+  if [ ! -d "$1" ]; then
+    echo "Making $1 directory."
+    sudo mkdir -p "$1"
+  fi
+}
+
+if [ "$(which iptables)" ]; then
+  echo "Opening port $GITBUCKET_PORT in firewall."
+  sudo iptables -A INPUT -p tcp --dport $GITBUCKET_PORT -j ACCEPT
+  echo "Please use iptables-persistent:"
+  echo "  sudo apt-get install iptables-persistent"
+  echo "After installed, you can save/reload iptables rules anytime:"
+  echo "  sudo /etc/init.d/iptables-persistent save"
+  echo "  sudo /etc/init.d/iptables-persistent reload"
+fi
+
+createDir "$GITBUCKET_HOME"
+createDir "$GITBUCKET_WAR_DIR"
+createDir "$GITBUCKET_DIR"
+createDir "$GITBUCKET_LOG_DIR"
+
+echo "Fetching GitBucket v$GITBUCKET_VERSION and saving as $GITBUCKET_WAR_FILE"
+sudo wget -qO "$GITBUCKET_WAR_FILE" https://github.com/takezoe/gitbucket/releases/download/$GITBUCKET_VERSION/gitbucket.war
+
+sudo rm -f "$GITBUCKET_LOG_DIR/run.log"
+
+echo "Copying gitbucket.conf to $GITBUCKET_DIR"
+sudo cp gitbucket.conf $GITBUCKET_DIR
+if [ `isUbuntu` ] || [ `isRedHat` ]; then
+  sudo cp gitbucket.init "$GITBUCKET_SERVICE"
+  # Install gitbucket as a service that starts when system boots
+  sudo chown root:root $GITBUCKET_SERVICE
+  sudo chmod 755 $GITBUCKET_SERVICE
+  sudo update-rc.d "$(basename $GITBUCKET_SERVICE)" defaults 98 02
+  echo "Starting GitBucket service"
+  sudo $GITBUCKET_SERVICE start
+elif [ `isMac` ]; then
+  sudo macosx/makePlist
+  echo "Starting GitBucket service"
+  sudo cp gitbucket.conf "$GITBUCKET_SERVICE"
+  sudo cp gitbucket.init "$GITBUCKET_SERVICE"
+  sudo chmod a+x "$GITBUCKET_SERVICE"
+  sudo "$GITBUCKET_SERVICE" start
+else
+  echo "Don't know how to install this OS"
+  exit -2
+fi
+
+if [ $? != 0 ]; then
+  less "$GITBUCKET_LOG_DIR/run.log"
+fi

contrib/macosx/makePlist

@@ -1,3 +1,10 @@
+#!/bin/bash
+
+# From http://docstore.mik.ua/orelly/unix3/mac/ch02_02.htm
+source gitbucket.conf
+GITBUCKET_SERVICE_DIR=`dirname "$GITBUCKET_SERVICE"`
+mkdir -p "$GITBUCKET_SERVICE_DIR"
+cat << EOF > "$GITBUCKET_SERVICE_DIR/gitbucket.plist"
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
@@ -7,14 +14,15 @@
     <key>ProgramArguments</key>
     <array>
       <string>/usr/bin/java</string>
-      <string>-Dmail.smtp.starttls.enable=true</string>
+      <string>$GITBUCKET_JVM_OPTS</string>
       <string>-jar</string>
       <string>gitbucket.war</string>
-      <string>--host=127.0.0.1</string>
-      <string>--port=8080</string>
+      <string>--host=$GITBUCKET_HOST</string>
+      <string>--port=$GITBUCKET_PORT</string>
       <string>--https=true</string>
     </array>
     <key>RunAtLoad</key>
     <true/>
   </dict>
 </plist>
+EOF

contrib/redhat/gitbucket.conf

@@ -1,17 +0,0 @@
-# Bind host
-#GITBUCKET_HOST=0.0.0.0
-
-# Server port
-#GITBUCKET_PORT=8080
-
-# Data directory (GITBUCKET_HOME/gitbucket)
-#GITBUCKET_HOME=/var/lib/gitbucket
-
-# Path to the WAR file
-#GITBUCKET_WAR_FILE=/usr/share/gitbucket/lib/gitbucket.war
-
-# URL prefix for the GitBucket page (http://<host>:<port>/<prefix>/)
-#GITBUCKET_PREFIX=
-
-# Other Java option
-#GITBUCKET_JVM_OPTS=