Line 1: |
Line 1: |
− | ==Start a boot a custom service== | + | ===Start at the boot time a custom service=== |
| | | |
| If you want to start a custom service on the SME Server, you will have to follow some steps. | | If you want to start a custom service on the SME Server, you will have to follow some steps. |
− | The init script below is just a wrapper, a launcher that will start the real script which will do the job for you (see SCRIPT=<COMMAND> to give the path to your job script). Of course the init script is here only if you want to add a service by hand and thus not installed by a rpm.<br /> | + | The init script below is just a wrapper, a launcher that will start the real script which will do the job for you '''(see SCRIPT=<COMMAND> to give the path to your job script)'''. Of course the init script is here only if you want to add a service by hand and thus not installed by a rpm.<br /> |
| | | |
− | In the case of you have installed a service which comes from a rpm, but without init scripts in the runlevel 7, you have to follow from this [[Add_a_custom_service#allow_a_service_to_start_for_a_particular_time |section]] | + | '''In the case of you have installed a service which comes from a rpm, but without init scripts in the runlevel 7, you have to follow from this [[Add_a_custom_service#allow_a_service_to_start_for_a_particular_time |section]]''' |
| | | |
| add a script to /etc/rc.d/init.d like the script below | | add a script to /etc/rc.d/init.d like the script below |
Line 20: |
Line 20: |
| ### END INIT INFO | | ### END INIT INFO |
| | | |
− | SCRIPT=<COMMAND> | + | '''SCRIPT=<COMMAND>''' |
− | RUNAS=<USERNAME> | + | '''RUNAS=<USERNAME>''' |
− | NAME=<SERVICE_NAME> | + | '''NAME=<SERVICE_NAME>''' |
| | | |
| PIDFILE=/var/run/$NAME.pid | | PIDFILE=/var/run/$NAME.pid |
Line 34: |
Line 34: |
| echo 'Starting service…' >&2 | | echo 'Starting service…' >&2 |
| local CMD="$SCRIPT &> \"$LOGFILE\" & echo \$!" | | local CMD="$SCRIPT &> \"$LOGFILE\" & echo \$!" |
− | su -c "$CMD" $RUNAS > "$PIDFILE" | + | su -s /bin/sh $RUNAS -c "$CMD" > "$PIDFILE" |
− | echo 'Service started' >&2 | + | |
| + | # Try with this command line instead of above if not workable |
| + | # su -c "$CMD" $RUNAS > "$PIDFILE" |
| + | |
| + | sleep 2 |
| + | PID=$(cat $PIDFILE) |
| + | if pgrep -u $RUNAS -f $NAME > /dev/null |
| + | then |
| + | echo "$NAME is now running, the PID is $PID" |
| + | else |
| + | echo "Error! Could not start $NAME!" |
| + | fi |
| + | |
| } | | } |
| | | |
Line 48: |
Line 60: |
| } | | } |
| | | |
− | uninstall() {
| + | status() { |
− | echo -n "Are you really sure you want to uninstall this service? That cannot be undone. [yes|No] " | |
− | local SURE
| |
− | read SURE
| |
− | if [ "$SURE" = "yes" ]; then
| |
− | stop
| |
− | rm -f "$PIDFILE"
| |
− | echo "Notice: log file is not be removed: '$LOGFILE'" >&2
| |
− | update-rc.d -f <NAME> remove
| |
− | rm -fv "$0"
| |
− | fi
| |
− | }
| |
− |
| |
− | status() {
| |
| printf "%-50s" "Checking $NAME..." | | printf "%-50s" "Checking $NAME..." |
| if [ -f $PIDFILE ]; then | | if [ -f $PIDFILE ]; then |
− | PID=$(cat $PIDFILE)
| + | PID=$(cat $PIDFILE) |
| if [ -z "$(ps axf | grep ${PID} | grep -v grep)" ]; then | | if [ -z "$(ps axf | grep ${PID} | grep -v grep)" ]; then |
− | printf "%s\n" "The process appears to be dead but pidfile still exists"
| + | printf "%s\n" "The process appears to be dead but pidfile still exists" |
| else | | else |
− | echo "Running, the PID is $PID"
| + | echo "Running, the PID is $PID" |
| fi | | fi |
− | else
| + | else |
− | printf "%s\n" "Service not running"
| + | printf "%s\n" "Service not running" |
| fi | | fi |
| } | | } |
Line 85: |
Line 84: |
| status) | | status) |
| status | | status |
− | ;;
| |
− | uninstall)
| |
− | uninstall
| |
| ;; | | ;; |
| restart) | | restart) |
Line 94: |
Line 90: |
| ;; | | ;; |
| *) | | *) |
− | echo "Usage: $0 {start|stop|status|restart|uninstall}" | + | echo "Usage: $0 {start|stop|status|restart}" |
| esac | | esac |
| | | |
| you have to fill these fields with the relevant values | | you have to fill these fields with the relevant values |
| | | |
− | <nowiki># Provides: <'''NAME'''></nowiki> | + | <nowiki># </nowiki>Provides: <'''NAME'''> |
| .. | | .. |
− | <nowiki># Description: <'''DESCRIPTION'''></nowiki> | + | <nowiki>#</nowiki> Description: <'''DESCRIPTION'''> |
| .. | | .. |
| SCRIPT=<'''COMMAND'''> #path to the script you want to start automatically at boot | | SCRIPT=<'''COMMAND'''> #path to the script you want to start automatically at boot |
Line 111: |
Line 107: |
| chmod u+x /etc/rc.d/init.d/YOUR_SERVICE_NAME | | chmod u+x /etc/rc.d/init.d/YOUR_SERVICE_NAME |
| | | |
− | You have to say to SME Server to add that script to each run level you have specified at the top of your init script( Default-Start: 2 3 4 5 and Default-Stop: 0 1 6 ). For Linux using rpm as centos or redhat, you can use | + | ====optional chkconfig==== |
| + | You need to say to SME Server to add the script to each run level you have specified at the top of your init script( Default-Start: 2 3 4 5 and Default-Stop: 0 1 6 ). For Linux using rpm as centos or redhat, you can use |
| | | |
| chkconfig YOUR_SERVICE_NAME --add | | chkconfig YOUR_SERVICE_NAME --add |
| | | |
− | if you want to see which level you start the script
| + | You can set the levels where the initscript has to start |
| + | chkconfig YOUR_SERVICE_NAME --level 2345 on |
| + | |
| + | If you want to see which runlevel your script will run in |
| | | |
| chkconfig YOUR_SERVICE_NAME --list | | chkconfig YOUR_SERVICE_NAME --list |
Line 124: |
Line 124: |
| | | |
| | | |
− | However it is not enough for SME server since we have to add service to rc7.d and to say to our distro to start that service at boot, therefore let's go to the section below | + | {{Note box|However it is not enough for SME server since we have to add service to rc7.d to say to our distro to start the service at boot, therefore let's go to the section below}} |
− | | |
− | | |
| | | |
| ===allow a service to start for a particular time=== | | ===allow a service to start for a particular time=== |
Line 145: |
Line 143: |
| config set '''YOUR_SERVICE_NAME''' service status enabled | | config set '''YOUR_SERVICE_NAME''' service status enabled |
| | | |
− | if your init script is not already in etc/rc.d/init.d you can do a link to you the init script
| + | :* IF your init script is not ALREADY in etc/rc.d/init.d you can do a link to the init script |
| cd /etc/rc.d/init.d | | cd /etc/rc.d/init.d |
| ln -s /path/to/myinitscript '''YOUR_SERVICE_NAME''' | | ln -s /path/to/myinitscript '''YOUR_SERVICE_NAME''' |
Line 151: |
Line 149: |
| '''We are creating a symlink of the original startup script with a new name (the point is that '''YOUR_SERVICE_NAME''' must be identical to the service name above)''' | | '''We are creating a symlink of the original startup script with a new name (the point is that '''YOUR_SERVICE_NAME''' must be identical to the service name above)''' |
| | | |
− | then in /etc/rc7.d we do a link to the wrapper e-smith-service
| + | * In /etc/rc7.d we do a link to the wrapper e-smith-service |
| | | |
| cd /etc/rc7.d | | cd /etc/rc7.d |
Line 194: |
Line 192: |
| db configuration setprop <servicename> UDPPorts <portnumbers> # Ranges of ports are defined with a : not a - | | db configuration setprop <servicename> UDPPorts <portnumbers> # Ranges of ports are defined with a : not a - |
| db configuration setprop <servicename> status enabled|disabled | | db configuration setprop <servicename> status enabled|disabled |
− | db configuration setprop <servicename> access public|private | + | db configuration setprop <servicename> access public|private|localhost |
| db configuration setprop <servicename> AllowHosts a.b.c.d,x.y.z.0/24 | | db configuration setprop <servicename> AllowHosts a.b.c.d,x.y.z.0/24 |
| db configuration setprop <servicename> DenyHosts e.f.g.h,l.m.n.0/24 | | db configuration setprop <servicename> DenyHosts e.f.g.h,l.m.n.0/24 |
Line 203: |
Line 201: |
| | | |
| === General Service Handling === | | === General Service Handling === |
| + | SME Server uses [http://smarden.org/runit/ runit], a UNIX init scheme with service supervision. See the man page of [http://smarden.org/runit/sv.8.html the 'sv' command] |
| + | |
| + | All other linux common way to start or stop services are also valuable |
| + | |
| + | /etc/init.d/servicename start/stop/status |
| + | service servicename start/stop/status |
| | | |
| *start | | *start |
Line 210: |
Line 214: |
| *restart | | *restart |
| sv t /service/servicename | | sv t /service/servicename |
− | | + | * status |
| + | sv s /service/servicename |
| {{tip box|you may use TAB to auto-complete your command line}} | | {{tip box|you may use TAB to auto-complete your command line}} |
| | | |
− | All other linux common way to start or stop services are also valuable
| + | you have some shortcuts |
− | | + | down => 'd', |
− | /etc/init.d/servicename start/stop/status | + | stop => 'd', |
− | service servicename start/stop/status | + | up => 'u', |
| + | start => 'u', |
| + | restart => 't', |
| + | sigterm => 't', |
| + | adjust => 'h', |
| + | reload => 'h', |
| + | sighup => 'h', |
| + | sigusr1 => '1', |
| + | sigusr2 => '2', |
| + | once => 'o', |
| + | pause => 'p', |
| + | alarm => 'a', |
| + | interrupt => 'i', |
| + | quit => 'q', |
| + | kill => 'k', |
| + | exit => 'x', |
| | | |
| ====Example==== | | ====Example==== |
Line 223: |
Line 243: |
| | | |
| sv t /service/httpd-e-smith | | sv t /service/httpd-e-smith |
− |
| |
| [[category:developer]] | | [[category:developer]] |