|
|
| (6 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| | The FreeBSD init system is called <code>rc</code>. |
| | |
| = Documentation = | | = Documentation = |
| <blockquote> | | <blockquote> |
| Line 21: |
Line 23: |
| |- | | |- |
| | <code>/usr/local/etc/rc.d/*</code> || user rc scripts | | | <code>/usr/local/etc/rc.d/*</code> || user rc scripts |
| | |- |
| | | <code>/etc/rc.subr</code> || available rc script methods |
| |- | | |- |
| |} | | |} |
| </blockquote><!-- Locations --> | | </blockquote><!-- Locations --> |
|
| |
|
| = Managing Services = | | = Notes = |
| <blockquote> | | <blockquote> |
| All daemons are enabled, and primarily configured in the <code>/etc/rc.conf</code>.
| | {| class="wikitable" |
| rcvars (variables which can be overridden in rc.conf) are listed in the program's
| |
| rcscript <code>/usr/local/etc/rc.d</code>.
| |
| | |
| <source lang="bash">
| |
| # /etc/rc.conf:
| |
| sshd_enable="YES"
| |
| sshguard_enable="YES"
| |
| sshguard_whitelist="/etc/sshguard.whitelist"
| |
| </source>
| |
| | |
| Services can be managed from the commandline very simply:
| |
| <source lang="bash">
| |
| service sshguard start # start service
| |
| service sshguard stop # stop service
| |
| service sshguard restart # restart service
| |
| </source>
| |
| </blockquote><!-- Basic Usage -->
| |
| | |
| = Force Starting Broken InitScripts =
| |
| <blockquote>
| |
| Sometimes, you don't have time to troubleshoot why a particular
| |
| command is not working. You can get around this in two ways:
| |
| | |
| ''' rc.local method '''
| |
| <source lang="bash">
| |
| # /etc/rc.local
| |
| /usr/local/etc/rc.d/${MY_SERVICE} start # bypass rc.d init and run
| |
| </source>
| |
| | |
| ''' crontab method '''
| |
| <source lang="bash">
| |
| su
| |
| crontab -u
| |
| </source>
| |
| | |
| <source lang="bash">
| |
| # crontab
| |
| | |
| @reboot /usr/local/etc/rc.d/<my_service> start
| |
| </source>
| |
| {|
| |
| |- | | |- |
| | https://forums.freebsd.org/threads/31249/ | | | [[freebsd rc usage]] |
| |- | | |- |
| |} | | | [[freebsd rc syntax]] |
| </blockquote><!-- Force Starting Broken InitScripts -->
| |
| | |
| = Init Scripting =
| |
| <blockquote>
| |
| {{ NOTE |
| |
| Checkout the following initscripts (in my saltstack repostiory) for simple examples:
| |
| * taskwarrior's taskd
| |
| * minecraft
| |
| }}
| |
| | |
| {| class="wikitable"
| |
| |- | | |- |
| | <code>https://www.freebsd.org/doc/en/articles/rc-scripting/rcng-dummy.html</code> || Official Documentation | | | [[freebsd rc troubleshooting]] |
| |- | | |- |
| | <code>/etc/rc.subr</code> || Library of rc-script functions
| |
| |} | | |} |
| | | </blockquote><!-- Notes --> |
| == Skeleton File ==
| |
| <blockquote>
| |
| <source lang="bash">
| |
| #!/bin/sh
| |
| | |
| # PROVIDE: myservice # allows other services to require 'myservice'
| |
| # REQUIRE: DAEMON # before this service starts, DAEMON must be provided
| |
| # KEYWORD: shutdown # this service must be killed before the system shuts down
| |
| | |
| . /etc/rc.subr # source rc.subr, generic rc-script functions
| |
| </source>
| |
| | |
| <source lang="bash">
| |
| # General Commands
| |
| | |
| name="myservice" # mandatory unique-name for script
| |
| rcvar="myservice_enable" # name of variable in /etc/rc.conf used to enable service
| |
| </source>
| |
| | |
| <source lang="bash">
| |
| # Read User-Configuration in /etc/rc.conf
| |
| # Set Variables that can be used in rc.conf
| |
| | |
| load_rc_config $name # load variables from /etc/rc.conf
| |
| | |
| : ${myservice_enable:=NO} # rc.conf variables, and their defaults
| |
| : ${myservice_config=/etc/myservice.conf}
| |
| : ${myservice_user=will}
| |
| </source>
| |
| | |
| <source lang="bash">
| |
| # Environment Variables
| |
| ${name}_env="VAR=value VAR2=value" # you can set environment variables for the command this way
| |
| </source>
| |
| | |
| <source lang="bash">
| |
| # Builtin Variables thave affect CLI command to be run
| |
| ${name}_user=myuser # user to run command as (using su)
| |
| pidfile=/var/run/myservice/myservice.pid # pidfile path
| |
| command=/usr/local/bin/myservice # path to binary
| |
| command_args="-d -p ${pidfile}" # arguments to use against $command
| |
| command_interpreter=/usr/local/bin/python2.7 # use different interpreter than /bin/sh
| |
| </source>
| |
| | |
| <source lang="bash">
| |
| # Other Builtin Variables
| |
| | |
| # Command is not run if files do not exist
| |
| required_files="/etc/${name}.conf /usr/share/misc/${name}.rules"
| |
| </source>
| |
| | |
| <source lang="bash">
| |
| # Start/Stop/Restart/... Functions
| |
| | |
| start_cmd="${name}_start" # override default /etc/rc.subr start function with the function ${name}_start
| |
| stop_cmd=":" # use default /etc/rc.subr stop_cmd function
| |
| | |
| start_precmd="echo start" # runs before 'start'
| |
| start_postcmd="echo end" # runs after successful 'start'
| |
| | |
| dummy_start() # define your own functions
| |
| {
| |
| echo "Nothing started."
| |
| }
| |
| </source>
| |
| | |
| <source lang="bash">
| |
| # run Command
| |
| | |
| run_rc_command "$1" # based on above conts, run command using /etc/rc.subr function
| |
| </source>
| |
| </blockquote><!-- skeleton file -->
| |
| | |
| == Debugging ==
| |
| <blockquote>
| |
| You can create 'debug mode' for a particular init script by
| |
| adding the following lines to it's init script (just below the shebang),
| |
| then rebooting and checking <code>/tmp/output.txt</code>.
| |
| | |
| <source lang="bash">
| |
| set -xv
| |
| exec 1>/tmp/output.txt 2>&1
| |
| </source>
| |
| </blockquote><!-- debugging -->
| |
| | |
| == Daemonize Non-Daemon Programs ==
| |
| <blockquote>
| |
| FreeBSD provides the program '''daemon''' which manages forking processes
| |
| along with their pidfile. Simply use this as your command instead. Note that you
| |
| will need to manage your status/stop manually if running the program this way.
| |
| | |
| <source lang="bash">
| |
| pidfile=/var/run/program_name.pid
| |
| | |
| is_running(){
| |
| if [ -f $pidfile ]; then
| |
| pgrep `cat $pidfile`
| |
| return $0
| |
| fi
| |
| | |
| return 1
| |
| }
| |
| | |
| program_status(){
| |
| if is_running; then
| |
| echo "${name} is running"
| |
| else
| |
| echo "${name} is not running"
| |
| fi
| |
| }
| |
| | |
| program_stop() {
| |
| if is_running; then
| |
| echo "stopping ${name}"
| |
| kill -15 `cat pidfile`
| |
| else
| |
| echo "${name} is not running"
| |
| fi
| |
| }
| |
| | |
| | |
| status_cmd=program_status
| |
| stop_cmd=program_stop
| |
| | |
| command="/usr/sbin/daemon"
| |
| command_args="-u $command_user -f -p $pidfile $program_name -x -y -z"
| |
| </source>
| |
| </blockquote><!-- Daemonize Non-Daemon Programs -->
| |
| </blockquote><!-- Init Scripting --> | |
