diff --git a/INSTALL b/INSTALL index afd059e3..2113e4e1 100644 --- a/INSTALL +++ b/INSTALL @@ -29,10 +29,11 @@ Setup ----- The www/ directory contains the Django web application. The file -www/settings_local.py.template must be copied to www/settings_local.py and +www/settings_local.py-template must be copied to www/settings_local.py and modified to match your installation configuration. -Likewise for www/maposmatic.wsgi-template and scripts/maposmaticd.sh. +Likewise for www/maposmatic.wsgi-template and +scripts/maposmaticd.sh-template. The database must then be initialized with the tables needed for MapOSMatic, using : @@ -43,6 +44,23 @@ The scripts/maposmaticd daemon should be run in the background. It will fetch rendering jobs from the database and put the results in a directory, as specified in the settings_local.py file. +You can adapt the example of init script given in +examples/init-maposmaticd-template: + + cp examples/init-maposmaticd-template /etc/init.d/maposmaticd + vi /etc/init.d/maposmaticd + +notice the --chuid option to start-stop-daemon, adapt it to your +settings and once done: + + sudo chmod 755 /etc/init.d/maposmaticd + sudo update-rc.d maposmaticd defaults + +Web server configuration +------------------------ + +For Apache, you can adapt the configuration file given in +example/apache/maposmatic. Internationalization -------------------- diff --git a/examples/apache/maposmatic b/examples/apache/maposmatic new file mode 100644 index 00000000..a01013fe --- /dev/null +++ b/examples/apache/maposmatic @@ -0,0 +1,25 @@ + + ServerAdmin postmaster@your.domain + ServerName maposmatic + + DocumentRoot /path/to/maposmatic/www + WSGIScriptAlias / /path/to/maposmatic/www/maposmatic.wsgi + + + Options FollowSymLinks + AllowOverride None + + + Alias /smedia /path/to/maposmatic/www/media/ + + Options FollowSymlinks +Indexes + Order allow,deny + Allow from all + + + LogLevel warn + ServerSignature On + + CustomLog /path/to/maposmatic-logs/access.log combined + ErrorLog /path/to/maposmatic-logs/error.log + \ No newline at end of file diff --git a/examples/init-maposmaticd-template b/examples/init-maposmaticd-template new file mode 100644 index 00000000..e0882a1d --- /dev/null +++ b/examples/init-maposmaticd-template @@ -0,0 +1,153 @@ +#! /bin/sh +### BEGIN INIT INFO +# Provides: maposmaticd +# Required-Start: $local_fs $remote_fs +# Required-Stop: $local_fs $remote_fs +# Default-Start: 2 3 4 5 +# Default-Stop: S 0 1 6 +# Short-Description: maposmatic job scheduler +# Description: This script starts the mapOSMaticd job scheduler and +# rendering daemon +### END INIT INFO + +# Author: mapOSMatic authors + +# Do NOT "set -e" + +# PATH should only include /usr/* if it runs after the mountnfs.sh script +PATH=/usr/sbin:/usr/bin:/sbin:/bin +DESC="Starts the mapOSMaticd job scheduler and rendering daemon" +NAME=maposmaticd +DAEMON=/path/to/maposmatic/scripts/$NAME.sh +DAEMON_ARGS="" +PIDFILE=/var/run/$NAME.pid +SCRIPTNAME=/etc/init.d/$NAME + +# Exit if the package is not installed +[ -x "$DAEMON" ] || exit 0 + +# Read configuration variable file if it is present +[ -r /etc/default/$NAME ] && . /etc/default/$NAME + +# Load the VERBOSE setting and other rcS variables +[ -f /etc/default/rcS ] && . /etc/default/rcS + +# Define LSB log_* functions. +# Depend on lsb-base (>= 3.0-6) to ensure that this file is present. +. /lib/lsb/init-functions + +# +# Function that starts the daemon/service +# +do_start() +{ + # Return + # 0 if daemon has been started + # 1 if daemon was already running + # 2 if daemon could not be started + start-stop-daemon --start --quiet --background --pidfile $PIDFILE --make-pidfile --chuid maposmatic:maposmatic --exec $DAEMON --test > /dev/null \ + || return 1 + start-stop-daemon --start --quiet --background --pidfile $PIDFILE --make-pidfile --chuid maposmatic:maposmatic --exec $DAEMON -- \ + $DAEMON_ARGS \ + || return 2 + # Add code here, if necessary, that waits for the process to be ready + # to handle requests from services started subsequently which depend + # on this one. As a last resort, sleep for some time. +} + +# +# Function that stops the daemon/service +# +do_stop() +{ + # Return + # 0 if daemon has been stopped + # 1 if daemon was already stopped + # 2 if daemon could not be stopped + # other if a failure occurred + start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --pidfile $PIDFILE + RETVAL="$?" + [ "$RETVAL" = 2 ] && return 2 + # Wait for children to finish too if this is a daemon that forks + # and if the daemon is only ever run from this initscript. + # If the above conditions are not satisfied then add some other code + # that waits for the process to drop all resources that could be + # needed by services started subsequently. A last resort is to + # sleep for some time. + start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec $DAEMON + [ "$?" = 2 ] && return 2 + # Many daemons don't delete their pidfiles when they exit. + rm -f $PIDFILE + return "$RETVAL" +} + +# +# Function that sends a SIGHUP to the daemon/service +# +do_reload() { + # + # If the daemon can reload its configuration without + # restarting (for example, when it is sent a SIGHUP), + # then implement that here. + # + #start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME + echo "$SCRIPTNAME: reload not supported" >&2 + return 0 +} + +case "$1" in + start) + [ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME" + do_start + case "$?" in + 0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;; + 2) [ "$VERBOSE" != no ] && log_end_msg 1 ;; + esac + ;; + stop) + [ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME" + do_stop + case "$?" in + 0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;; + 2) [ "$VERBOSE" != no ] && log_end_msg 1 ;; + esac + ;; + #reload|force-reload) + # + # If do_reload() is not implemented then leave this commented out + # and leave 'force-reload' as an alias for 'restart'. + # + #log_daemon_msg "Reloading $DESC" "$NAME" + #do_reload + #log_end_msg $? + #;; + restart|force-reload) + # + # If the "reload" option is implemented then remove the + # 'force-reload' alias + # + log_daemon_msg "Restarting $DESC" "$NAME" + do_stop + case "$?" in + 0|1) + do_start + case "$?" in + 0) log_end_msg 0 ;; + 1) log_end_msg 1 ;; # Old process is still running + *) log_end_msg 1 ;; # Failed to start + esac + ;; + *) + # Failed to stop + log_end_msg 1 + ;; + esac + ;; + *) + #echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2 + echo "Usage: $SCRIPTNAME {start|stop|restart|force-reload}" >&2 + exit 3 + ;; +esac + +: diff --git a/www/settings_local.py.template b/www/settings_local.py-template similarity index 85% rename from www/settings_local.py.template rename to www/settings_local.py-template index 48170411..a7ea2f6e 100644 --- a/www/settings_local.py.template +++ b/www/settings_local.py-template @@ -27,14 +27,14 @@ import logging DEBUG = True ADMINS = ( - ('MapOSMatic admin', 'contact@maposmatic.org'), + ('MapOSMatic admin', 'contact@your.domain'), ) DATABASE_ENGINE = 'postgresql_psycopg2' # 'postgresql_psycopg2', 'postgresql', 'mysql', 'sqlite3' or 'oracle'. -DATABASE_NAME = 'testdb' # Or path to database file if using sqlite3. -GIS_DATABASE_NAME = 'testdb' # Or path to PostGIS database file if using sqlite3. -DATABASE_USER = 'test' # Not used with sqlite3. -DATABASE_PASSWORD = 'test' # Not used with sqlite3. +DATABASE_NAME = 'maposmatic' # Or path to database file if using sqlite3. +GIS_DATABASE_NAME = 'maposmatic' # Or path to PostGIS database file if using sqlite3. +DATABASE_USER = 'maposmatic' # Not used with sqlite3. +DATABASE_PASSWORD = 'ereiamjh' # Not used with sqlite3. DATABASE_HOST = 'localhost' # Set to empty string for localhost. Not used with sqlite3. DATABASE_PORT = '' # Set to empty string for default. Not used with sqlite3.