Running Your Own Application at Startup: Difference between revisions

From QNAPedia
Jump to navigation Jump to search
← Older edit
Glenn (talk | contribs)
157 edits
m catchg
Nyax4 (talk | contribs)
1 edit
Tag: visualeditor
 
(21 intermediate revisions by 5 users not shown)
Line 1: Line 1:
Some advanced uses of your NAS may require you to run custom applications at boot-time. Even though QNAP NAS are Linux-based, you cannot use the usual Linux methods for launching an application at startup: default config files are reset on every startup.
Some advanced uses of your NAS may require you to run custom applications at boot-time. Even though QNAP NAS are Linux-based, you cannot use the usual Linux methods for launching an application at startup: default config files are reset on every startup.


 


== Skills required ==


== Skills required ==
*must be able to remote login via ssh or telnet (e.g. use '''SSH PuTTY''')
*must know how to edit files using nano, vi, or edit via SFTP (e.g. use '''WinSCP''')


*must be able to remote login via ssh or telnet (e.g. use '''SSH PuTTY''')
 
*must know how to edit files using nano, vi, or edit via SFTP (e.g. use '''WinSCP''')


== MTD-based method ==
== MTD-based method ==


autorun.sh is a script which will be executed on every startup of the TS-x09, TS-x19 and TS-x39. Editing this file allows you to start your own programs or overwrite config files with your own copies.
autorun.sh is a script which will be executed on every startup of the TS-x09, TS-x19 and TS-x39. Editing this file allows you to start your own programs or overwrite config files with your own copies.
 
 


=== Manual edit of autorun.sh ===
=== Manual edit of autorun.sh ===


#Log into your QNAP device using SSH or Telnet, for instance by using Putty
#Log into your QNAP device using SSH or Telnet, for instance by using Putty  
#Optional: install nano; use '''ipkg install nano''' & edit with nano instead of vi
#Optional: install nano; use '''ipkg install nano''' & edit with nano instead of vi  
#Mount config ramblock by finding your specific model below:<br/><br/>'''TS-201: '''<br/>Mount the config ramblock /dev/mtdblock4:<br/><code># mount -t ext2 /dev/mtdblock4 /tmp/config</code><br/><br/>1 bay:&nbsp;'''TS-109, TS-109P, TS-110, TS-119,''' <br/>2 bay: '''TS-209, TS-209P, TS-212, TS-219 '''(TS-219P II: ''since the new firmware update you maybe have to use ext4 instead of ext2'''''), <br/>'''4 bay: '''TS-409 (Marvell ARM), TS-412, TS-419P:'''<br/>Mount the config ramblock /dev/mtdblock5:<br/><code># mount -t ext2 /dev/mtdblock5 /tmp/config</code><br/><br/>'''TS-439, TS-509, TS-639, TS-809, TS-809U (x86): '''<br/>Mount the config ramblock /dev/sdx6:<br/><code># mount -t ext2 /dev/sdx6 /tmp/config</code><br/><br/>'''TS-269L: '''<br/>Mount the config ramblock /dev/sdc6:<br/><code># mount -t ext2 /dev/sdc6 /tmp/config</code>
#Mount config ramblock by finding your specific model below:  
#Create/Edit /tmp/config/autorun.sh .
 
##either using vi:<pre># vi /tmp/config/autorun.sh</pre>
'''TS-201: ''' Mount the config ramblock /dev/mtdblock4:
 
#mount -t ext2 /dev/mtdblock4 /tmp/config  
 
'''TS-109, TS-109P, TS-110, TS-119,TS-209, TS-209P, TS-212, TS-219 '''(TS-219P II:since the new firmware update you maybe have to use ext4 instead of ext2)''', TS-409 (Marvell ARM), TS-412, TS-419P:'''
 
Mount the config ramblock /dev/mtdblock5:
<pre>mount -t ext2 /dev/mtdblock5 /tmp/config</pre>
 
'''TS-439, TS-509, TS-639, TS-809, TS-809U (x86):'''
 
Mount the config ramblock /dev/sdx6:
<pre>mount -t ext2 /dev/sdx6 /tmp/config</pre>
 
'''TS-269L: ''' Mount the config ramblock /dev/sdc6:
<pre>mount -t ext2 /dev/sdc6 /tmp/config</pre>
 
'''TS-212P3, TS-230: ''' Mount the config ramblock /dev/mmcblk0p5:
<pre>mount -t ext2 /dev/mmcblk0p5 /tmp/config</pre>
 
'''All HAL-based Intel and AMD NAS:'''
 
Starting from QTS 4.3.3 it's required to enable the autorun.sh processing in the Control Panel -> Hardware -> General: Run user defined startup processes (autorun.sh)
<pre>mount $(/sbin/hal_app --get_boot_pd port_id=0)6 /tmp/config</pre>
 
&nbsp;
 
'''''Create/Edit /tmp/config/autorun.sh'''''.
 
#either using vi: <pre># vi /tmp/config/autorun.sh</pre>
 
 
&nbsp;
 
#Get vi editor into edit mode:&nbsp;'''press a'''
##Edit whatever you need to
##Exit edit mode:&nbsp;'''press ESC'''
##Save and exit: '''x''' 
#or editing it using a desktop PC and e.g. SFTP
#Ensure that /tmp/config/autorun.sh is executable <pre># chmod +x /tmp/config/autorun.sh</pre>
 


#
&nbsp;
#
#Get vi editor into edit mode: '''press a'''
##
#Edit whatever you need to
###Exit edit mode: '''press ESC'''
###Save and exit: '''press ZZ'''
##or editing it using a desktop PC and e.g. SFTP
#Ensure that /tmp/config/autorun.sh is executable:<pre># chmod +x /tmp/config/autorun.sh</pre>


#'''IMPORTANT:''' Unmount the mounted flash partition:<pre># umount /tmp/config</pre>
#'''IMPORTANT:'''&nbsp;Unmount the mounted flash partition: <pre># umount /tmp/config</pre>


=== editautorun.sh: script to ease autorun.sh edit ===
 
&nbsp;
 
&nbsp;
 
=== '''editautorun.sh: script to ease autorun.sh edit''' ===


If you edit this file regularly you can save some time by creating a shell script (e.g. editautorun.sh) to automate the process. You can call the script by either putting it in the environment path, or add its folder to the path or call it by an alias.
If you edit this file regularly you can save some time by creating a shell script (e.g. editautorun.sh) to automate the process. You can call the script by either putting it in the environment path, or add its folder to the path or call it by an alias.
Line 43: Line 87:
chmod +x /tmp/config/autorun.sh
chmod +x /tmp/config/autorun.sh
echo .
echo .
echo "unmounting /tmp/config..."
echo &quot;unmounting /tmp/config...&quot;
umount /tmp/config
umount /tmp/config
</pre>
</pre>
Line 65: Line 109:
</pre>
</pre>


=== autorun.sh: one script to rule them all ===
TS-230 use ...
<pre>mount -t ext2 /dev/mmcblk0p5 /tmp/config
vi /tmp/config/autorun.sh
chmod +x /tmp/config/autorun.sh
echo .
echo "unmounting /tmp/config..."
umount /tmp/config
</pre>


Frequently mounting and editing autorun.sh on the flash could be an annoying task. More important, it may reduce the lifetime of some flash blocks. Flash blocks have limited write/erase cycles, and the mtdblock device driver does little to prevent their wear. Read more on this on the [http://www.linux-mtd.infradead.org/faq/general.html#L_ext2_mtd Linux mtd] web site.
All HAL-based Intel and AMD NAS use ...
<pre>mount $(/sbin/hal_app --get_boot_pd port_id=0)6 /tmp/config
touch /tmp/config/autorun.sh
chmod +x /tmp/config/autorun.sh
$EDITOR /tmp/config/autorun.sh
umount /tmp/config</pre>


To avoid this, you could configure autorun.sh to launch another script located in the inner drive: in this way there no need to always mount and modify the file inside the flash. but only edit the script file located on your drive.
TAS-x68, TS-x28 use ...
 
<pre>/bin/mount -t ext4 /dev/mmcblk0p7 /tmp/config
Create the directory /share/HDA_DATA/.qpkg/autorun and file autorun.sh with:
vi /tmp/config/autorun.sh
<pre>mkdir /share/HDA_DATA/.qpkg/autorun
chmod +x /tmp/config/autorun.sh
cd /share/HDA_DATA/.qpkg/autorun/
echo .
touch autorun.sh
echo "unmounting /tmp/config..."
chmod +x autorun.sh
umount /tmp/config
</pre>
</pre>


The autorun.sh located on the flash could be something like this (just two lines that won't need many changes!):
All AL-based NAS(TS-x31+ and TS-x31X) and TS-x31 use ...
<pre>#!/bin/sh
<pre>ubiattach -m 6 -d 2
/share/HDA_DATA/.qpkg/autorun/autorun.sh &amp;
/bin/mount -t ubifs ubi2:config /tmp/config
</pre>
vi /tmp/config/autorun.sh
 
chmod +x /tmp/config/autorun.sh
and then edit the file /share/HDA_DATA/.qpkg/autorun/autorun.sh to be used to launch all your startup scripts.
echo .
 
echo "unmounting /tmp/config..."
 
umount /tmp/config
 
ubidetach -m 6
=== IMPORTANT Notes! ===
 
1. Never put any larger files on your flashboot devices and ramdisk; instead, create symbolic links to whatever you want to put there, e.g.:<br/>''Create a link from /usr (which is in ramdisk) to /share/MD0_DATA/jre1.6.0_10 (which is on a hard disk) at the mountpoint /usr/java''
<pre># ln -sf /share/MD0_DATA/jre1.6.0_10 /usr/java</pre>
 
<br/>2. Always use the full system path because locations like /opt/bin or /opt/sbin might not have been exported yet when Autorun.sh is executed, e.g:
 
No good.
<pre>svnserve -d --listen-port=4000 -r /share/subversion</pre>
 
<br/>This is better.
<pre>/opt/bin/svnserve -d --listen-port=4000 -r /share/subversion</pre>
 
<br/><br/>If it still fails to start svnserve, you might try adding this line to your autoexec script:
<pre>/bin/ln -sf /opt/bin/ /share/HDA_DATA/opt/bin/</pre>
 
<br/>3. Many startup scripts in /etc/init.d overwrite their corresponding configuration files in /etc. In this case overwriting the config file using autorun.sh is not enough; we also have to overwrite the startup script itself. Moreover, many startup scripts get excecuted before autorun, such that we also have to restart the service. In this case an autorun.sh may look like this:
<pre>#!/bin/sh
 
cp /share/MD0_DATA/admin/nfs /etc/init.d/nfs
cp /share/MD0_DATA/admin/exports /etc
 
/etc/init.d/nfs restart
</pre>
</pre>


Very ugly, indeed! However, it seems this is the only way to make it work (unless you want to throw out the QNAP OS and install a 'better' OS on your NAS).
&nbsp;
 
4. On our QNAP TS-879 Pro we were not able to run
<pre>/opt/bin/rsyncd-acl.sh start
</pre>


from the autorun.sh as /opt is not the one from Optware but a directory containing one file, i.e. nasconfig_fs.img.tgz.


Thus we modified /tmp/config/autorun.sh to
<pre>#!/bin/sh
log=/share/MD0_DATA/.qpkg/Optware/var/log/autorun
date &gt; $log
# removing bogus /opt
/bin/rm /opt/nasconfig_fs.img.tgz /opt 2&gt;&gt; $log &gt;&gt; $log
/bin/rmdir /opt 2&gt;&gt; $log &gt;&gt; $log
# link correct /opt
/bin/ln -s /share/MD0_DATA/.qpkg/Optware /opt 2&gt;&gt; $log &gt;&gt; $log
# run autorun.sh
/opt/etc/autorun.sh 2&gt;&gt; $log &gt;&gt; $log
</pre>


created a log file directory
=== '''Using "init" script to mount the flash''' ===
<pre>mkdir -p /opt/var/log
</pre>


and created /opt/etc/autorun.sh on the disk
The QNAP GUI has the ability to view the autorun.sh content.&nbsp; As at V4.5.1.1540 on a TS-831XU-RP this is how the GUI does that:
<pre>#!/bin/sh
<pre>/etc/init.d/init_disk.sh mount_flash_config
/opt/bin/rsyncd-acl.sh start
(displays /tmp/nasconfig_tmp/autorun.sh)
/etc/init.d/init_disk.sh umount_flash_config
</pre>
</pre>


thus no mounting of the flash partition is necessary anymore.
Using these commands, you can create/edit the "autorun.sh" in the location given.
 
== QPKG-based method ==
 
With firmware 3.8.2, the [[#MTD-based_method|#MTD-based_method]] was broken. With the next firmware update, this bug was corrected, but in the meanwhile, the below workaround has been devised.
 
This method consists of declaring a dummy QPKG which launches your script at startup.
 
*Log into your QNAP device using SSH or Telnet, for instance by using Putty
*Edit QPKG config file:
 
# vi /etc/config/qpkg.conf
 
*Declare a new dummy package by adding something like that in this file, but take care about the order. e.g. if you would like to start a service from a optware package, be sure optware is initialized before:
 
[autorun]
Name = autorun
Version = 0.1
Author = neomilium
Date = 2013-05-06
Shell = /share/MD0_DATA/.qpkg/autorun/autorun.sh
Install_Path = /share/MD0_DATA/.qpkg/autorun
Enable = TRUE
 
As you can see, '''Shell''' is the interesting variable: at boot-time, QNAP OS will launch each QPKG's '''Shell''' variable content.


Note: if your NAS doesn't have /share/MD0_DATA (i.e. is a one-drive NAS), put the right directory into the '''Shell''' and '''Install_Path''' variables and adapt the following commands to your needs.
&nbsp;


*Create the dummy package directory:
=== '''Allow running autorun.sh during startup''' ===
 
# mkdir /share/MD0_DATA/.qpkg/autorun
 
*Create the autorun script with the contents of your choice:
 
# vi /share/MD0_DATA/.qpkg/autorun/autorun.sh
 
Note: don't forget "#!/bin/sh" at the beginning of script.
 
*Set the execute bit:
 
# chmod +x /share/MD0_DATA/.qpkg/autorun/autorun.sh
 
*Reboot and enjoy!
 
== MTD-based method (old) ==
 
This section is here only to make sure existing anchor links continue to work. The meat is in the section [[#MTD-based_method|MTD-based method]].
 
== QPKG-based method (new) ==
 
This section is here only to make sure existing anchor links continue to work. The meat is in the section [[#QPKG-based_method|QPKG-based method]]
 
== Trick & tips ==
 
=== Waiting for encrypted partitions ===
 
If your data partition is encrypted, you might have some script that has to wait until the encrypted partition is available. I added a script called waitforenc.sh in my autorun-directory:
<pre>#! /bin/sh
 
# This script ends after the encrypted filesystem has been mounted.
 
# The following exits successfully (0) if MD0 is mounted
cat /etc/mtab | grep -q MD0
while [[ $? -ne 0 ]]&nbsp;; do
        sleep 5
        cat /etc/mtab | grep -q MD0
done</pre>
 
And now I'm able to call scripts *after* the encrypted partition is available, without blocking other scripts:
<pre>(./waitforenc.sh; /etc/init.d/ldap_server.sh restart ) &amp;</pre>
 
=== Calling all scripts in a certain directory ===
 
Place a file called listoffiles.sh in a directory, create a subdirectory called scripts, add listoffiles.sh to your autorun:
<pre>#! /bin/sh
# listoffiles.sh
 
BASEDIR=$(dirname $0)
 
echo "" &gt; log/userfiles.log
 
for i in scripts/*.sh&nbsp;; do
        if [[ -x $i ]]&nbsp;; then
                echo -n "$i " &gt;&gt; log/userfiles.log
                echo `date` &gt;&gt; log/userfiles.log
                $i 2&gt;&amp;1 &gt;&gt; log/userfiles.log
                cd $BASEDIR
        fi
done</pre>
 
=== Optimized networking ===
 
*You can also try different values from <a href="[http://www.speedguide.net/read_articles.php?id=121 http://www.speedguide.net/read_articles.php?id=121]">SpeedGuide.net&lt;/a&gt;
<pre>ifconfig eth0 txqueuelen 50000
ifconfig eth1 txqueuelen 50000
echo 1 &gt; /proc/sys/net/ipv4/tcp_rfc1337
echo 2 &gt; /proc/sys/net/ipv4/tcp_frto
echo 2 &gt; /proc/sys/net/ipv4/tcp_frto_response
echo 1 &gt; /proc/sys/net/ipv4/tcp_mtu_probing
echo 1 &gt; /proc/sys/net/ipv4/tcp_window_scaling
echo 1 &gt; /proc/sys/net/ipv4/tcp_workaround_signed_windows
echo 1 &gt; /proc/sys/net/ipv4/tcp_tw_reuse
echo 0 &gt; /proc/sys/net/ipv4/tcp_tw_recycle
echo 1 &gt; /proc/sys/net/ipv4/tcp_low_latency
echo 1 &gt; /proc/sys/net/ipv4/tcp_ecn
</pre>


[[Category:Adding new services| ]]
After completing the autorun.sh, please don't forget to enable the option to allow running autorun.sh during the system startup. [[File:AllowAutorun2.png|RTENOTITLE]]

Latest revision as of 22:38, 8 June 2021

Some advanced uses of your NAS may require you to run custom applications at boot-time. Even though QNAP NAS are Linux-based, you cannot use the usual Linux methods for launching an application at startup: default config files are reset on every startup.

 

Skills required

  • must be able to remote login via ssh or telnet (e.g. use SSH PuTTY)
  • must know how to edit files using nano, vi, or edit via SFTP (e.g. use WinSCP)

 

MTD-based method

autorun.sh is a script which will be executed on every startup of the TS-x09, TS-x19 and TS-x39. Editing this file allows you to start your own programs or overwrite config files with your own copies.

 

 

Manual edit of autorun.sh

  1. Log into your QNAP device using SSH or Telnet, for instance by using Putty
  2. Optional: install nano; use ipkg install nano & edit with nano instead of vi
  3. Mount config ramblock by finding your specific model below:

TS-201: Mount the config ramblock /dev/mtdblock4:

  1. mount -t ext2 /dev/mtdblock4 /tmp/config

TS-109, TS-109P, TS-110, TS-119,TS-209, TS-209P, TS-212, TS-219 (TS-219P II:since the new firmware update you maybe have to use ext4 instead of ext2), TS-409 (Marvell ARM), TS-412, TS-419P:

Mount the config ramblock /dev/mtdblock5: 

mount -t ext2 /dev/mtdblock5 /tmp/config

TS-439, TS-509, TS-639, TS-809, TS-809U (x86):

Mount the config ramblock /dev/sdx6: 

mount -t ext2 /dev/sdx6 /tmp/config

TS-269L: Mount the config ramblock /dev/sdc6: 

mount -t ext2 /dev/sdc6 /tmp/config

TS-212P3, TS-230: Mount the config ramblock /dev/mmcblk0p5: 

mount -t ext2 /dev/mmcblk0p5 /tmp/config

All HAL-based Intel and AMD NAS:

Starting from QTS 4.3.3 it's required to enable the autorun.sh processing in the Control Panel -> Hardware -> General: Run user defined startup processes (autorun.sh) 

mount $(/sbin/hal_app --get_boot_pd port_id=0)6 /tmp/config

 

Create/Edit /tmp/config/autorun.sh.

  1. either using vi: 
    # vi /tmp/config/autorun.sh


 

  1. Get vi editor into edit mode: press a
    1. Edit whatever you need to
    2. Exit edit mode: press ESC
    3. Save and exit: x
  2. or editing it using a desktop PC and e.g. SFTP
  3. Ensure that /tmp/config/autorun.sh is executable 
    # chmod +x /tmp/config/autorun.sh


 

  1. IMPORTANT: Unmount the mounted flash partition: 
    # umount /tmp/config


 

 

editautorun.sh: script to ease autorun.sh edit

If you edit this file regularly you can save some time by creating a shell script (e.g. editautorun.sh) to automate the process. You can call the script by either putting it in the environment path, or add its folder to the path or call it by an alias.

The script contents are:

For TS-201 use ... 

mount -t ext2 /dev/mtdblock4 /tmp/config
vi /tmp/config/autorun.sh
chmod +x /tmp/config/autorun.sh
echo .
echo "unmounting /tmp/config..."
umount /tmp/config

For TS-109, TS-109P, TS-119, TS-209, TS-209P, TS-219, TS-412, TS-409 (Marvell ARM) use ... 

mount -t ext2 /dev/mtdblock5 /tmp/config
vi /tmp/config/autorun.sh
chmod +x /tmp/config/autorun.sh
echo .
echo "unmounting /tmp/config..."
umount /tmp/config

TS-439, TS-509, TS-639, TS-809, TS-809U (x86) use ... 

mount -t ext2 /dev/sdx6 /tmp/config
vi /tmp/config/autorun.sh
chmod +x /tmp/config/autorun.sh
echo .
echo "unmounting /tmp/config..."
umount /tmp/config

TS-230 use ... 

mount -t ext2 /dev/mmcblk0p5 /tmp/config
vi /tmp/config/autorun.sh
chmod +x /tmp/config/autorun.sh
echo .
echo "unmounting /tmp/config..."
umount /tmp/config

All HAL-based Intel and AMD NAS use ... 

mount $(/sbin/hal_app --get_boot_pd port_id=0)6 /tmp/config
touch /tmp/config/autorun.sh
chmod +x /tmp/config/autorun.sh
$EDITOR /tmp/config/autorun.sh
umount /tmp/config

TAS-x68, TS-x28 use ... 

/bin/mount -t ext4 /dev/mmcblk0p7 /tmp/config
vi /tmp/config/autorun.sh
chmod +x /tmp/config/autorun.sh
echo .
echo "unmounting /tmp/config..."
umount /tmp/config

All AL-based NAS(TS-x31+ and TS-x31X) and TS-x31 use ... 

ubiattach -m 6 -d 2
/bin/mount -t ubifs ubi2:config /tmp/config
vi /tmp/config/autorun.sh
chmod +x /tmp/config/autorun.sh
echo .
echo "unmounting /tmp/config..."
umount /tmp/config
ubidetach -m 6

 


Using "init" script to mount the flash

The QNAP GUI has the ability to view the autorun.sh content.  As at V4.5.1.1540 on a TS-831XU-RP this is how the GUI does that: 

/etc/init.d/init_disk.sh mount_flash_config
(displays /tmp/nasconfig_tmp/autorun.sh)
/etc/init.d/init_disk.sh umount_flash_config

Using these commands, you can create/edit the "autorun.sh" in the location given.

 

Allow running autorun.sh during startup

After completing the autorun.sh, please don't forget to enable the option to allow running autorun.sh during the system startup. RTENOTITLE

Retrieved from "https://wiki.qnap.com/mediawiki/index.php?title=Running_Your_Own_Application_at_Startup&oldid=1682"