ReadyNAS Developer FAQ

• Can I create files or directories outside of /apps/[AppName]?
  • The short answer is No. Your own app should not contain any files or directories outside of /apps/[AppName]. The directory layout should look like this: /app/[AppName]/etc, /app/[AppName]/lib, /app/[AppName]/bin, and so on. However, if your app depends on other standard Debian packages (or modified version of them), those packages can install into /usr/lib, /etc/init.d, etc. Saving user's data (such as pictures) on /var/cache, for example, is a big no-no.
• I am writing multiple applications that use a common shared library which is not standard Debian. What to do?
  • We understand there is overhead if two app contains two identical libraries, like /apps/[AppName1]/lib/libxyz.so and /apps/[AppName2]/lib/libxyz.so. However, we recommend that developers follow the rule above. (If you have concerns about huge overhead, please consult with NETGEAR. We might accept a common library package and your applications can depend on the package.
• Do I need to specify packages, such as genie platform installs php, python, etc., in Debian/control/Depends section?
  • We recommend that you specify all dependent packages, except those that are already in the base ReadyNAS OS.
• I have config files which might be configured by the UI. How do I preserve them when I update?
  • See sample2/debian/postinst script. You can create default-config directory and config directory. And when Debian package contains only default-config, but copy files into config directory if not exist.
• How do I create an app using the Samba VFS module?
  • You can use rn_nml -a shareUsedBy:{ShareName}={AppName} to mark your application as using the specified share. If the application is marked as UsedBy and /apps/{AppName}/etc/samba.include exists, then include /apps/{AppName}/samba.include is inserted at the end of the [{ShareName}] section of the smb.conf file. If /apps/{AppName}/etc/samba.include does not exist, but /apps/{AppName}/etc/samba.include.{ARCH} (where {ARCH} is either x86_64 or arm) exists, then that is included instead. So you can write your VFS module-specific option in the file. Note that the vfs objects = line in smb.conf must specify all vfs objects within a single line. Please add acl_xattr shadow_copy2 for arm, and aio_linux acl_xattr shadow_copy2 for x86_64. (See sample3 for reference.) We understand that there are issues if two or more applications require the vfs module. Currently we are working with the Samba core team to specify vfs objects parameter support + option, so that each application can add its own vfs module independently.

hagi:~/apps-sdk/examples/sample3-1.0.0/files 167$ more apps/sample3/etc/samba.include.*
::::::::::::::
apps/sample3/etc/samba.include.arm
::::::::::::::
vfs objects = audit acl_xattr shadow_copy2
audit:priority = INFO
::::::::::::::
apps/sample3/etc/samba.include.x86_64
::::::::::::::
vfs objects = audit aio_linux acl_xattr shadow_copy2
audit:priority = INFO

• Why didn't my application start automatically by framework?

  • Some applications require setup before starting the service. If you would like to start the service automatically, you can call rn_nml -S {AppName} to start and enable your service within postinst.

• What should I do if I have question?

  • Please read through latest documentation first. If your question is about a generic Linux or Debian issue, please utilize Google or your favorite search engine. If you still have questions, please contact NETGEAR.

• How can I participate in the NETGEAR ReadyNAS Developer program?

  • Simply complete the registration form to become a developer and read and agree to the terms and conditions. Being a registered ReadyNAS developer allows you to submit apps.

• What is the focus for the ReadyNAS product line?

  • ReadyNAS storage systems can service multiple needs. The most common uses in business are: backup, file server, and virtualization. You can safely backup all your data from any computer to a ReadyNAS system. A ReadyNAS system also provides options to copy data to another off-site ReadyNAS system for disaster recovery in case of: fires, floods, or other disasters, or copy data to the cloud. File servers are efficient ways to share data among employees, customers, and partners. No more emailing files back and forth. As businesses grow and start to host their own servers on-site, virtualization becomes a must to achieve high efficiency. ReadyNAS storage systems are certified with VMware, Citrix, and Hyper-V.

• What devices work with a ReadyNAS storage system?

  • A ReadyNAS storage system can be accessed from any computer (Mac/Windows/Linux), tablet, smartphone, or web browser. You can access your data using built-in operating system file managers (Finder, Explorer, and so on), mobile applications (Android, iOS), or any internet device with a web browser via the ReadyCLOUD portal. Your files can be accessed from remote locations without the need to set up complicated VPNs, configure firewalls, or even know an IP address. ReadyNAS systems match the way you want to use and access your data, with nothing new to learn.

• If I have a ReadyNAS system that uses RAIDiator 4.x firmware or RAIDiator 5.x firmware, can I develop app?

  • Yes. For those products, check our forum for supporting these devices.

• What are ReadyNAS apps?

  • ReadyNAS apps are programs that expand the functionality of ReadyNAS storage system. Applications that are being developed cover a number of consumer and business segments. To see examples, click the Available apps tab in any ReadyNAS device. More than 50 apps are available in the following segments:

    • Storage and backup
    • Office productivity
    • Project management
    • Multimedia
    • Surveillance and monitoring

• What ReadyNAS storage systems are supported?

ARM:	x86_64:
ReadyNAS 102	ReadyNAS 312	ReadyNAS 716
ReadyNAS 104	ReadyNAS 314	ReadyNAS 2304
ReadyNAS 202	ReadyNAS 316	ReadyNAS 2312
ReadyNAS 204	ReadyNAS 422	ReadyNAS 3130
ReadyNAS 212	ReadyNAS 424	ReadyNAS 3138
ReadyNAS 214	ReadyNAS 516	ReadyNAS 3220
ReadyNAS 2120	ReadyNAS 524	ReadyNAS 3312
	ReadyNAS 526	ReadyNAS 4220
	ReadyNAS 528X	ReadyNAS 4312
	ReadyNAS 626X
	ReadyNAS 628X

• What is the approval process?

  • Before you can submit an app for approval, you must first register as a developer. After you agree to the developer agreement and privacy policy terms, you can download the full SDK and get started.

    After you submit your app, NETGEAR sends an email message confirming that your submission was received. NETGEAR tests your app and provides you with feedback via email about whether your app passed or failed testing. If your app failed, NETGEAR explains why. If your app passed, NETGEAR posts it to https://apps.readynas.com/pages/. The next planned build of firmware will include a link to your app, which allows customers to select your app from the storage system GUI.

• What do I need to get started developing an application?

  • Download SDK Package
  • Download Example debs Ver. 103 (189721 bytes)
  • View README file in SDK package (This is included in SDK too.)
  • Download Zipped Development Environment VirtualBox VDI (839743644 bytes)
  • Read How to jump start using VM image
  • Read How to setup ReadyNASOS on VM

• How do I submit an app?

  • After you register, click the Developer tab and select App Submission from the drop-down menu.

    Follow these steps to submit your app to NETGEAR for SDK and QA review:

    1. Browse to the .deb file on your local computer.

    2. Enter your developer account password in the Password field.

    3. Add a comment about your app.

    If you are re-submitting an app that NETGEAR previously rejected, you must enter a comment.

    4. If you want to validate the image file without submitting your app, check the validation only box and submit.

    5. If you have any issues, send an email to devreadynas@netgear.com.

• Are apps free?

  • Currently, NETGEAR is accepting only free apps for distribution on ReadyNAS storage systems. If your business model offers a free trial offer, and your back end supports transactions, contact develop relations at devreadynas@netgear.com for more information.

• After my app appears in the Apps available tab, can I update it?

  • Yes. Submit the revision through the same app submission process. Include a brief description of the changes to help the QA team.

• Can I remove my app ?

  • Yes. This requires an email request from you and verification by your developer relations team. They can be reached at devreadynas@netgear.com. Please submit your request to this email address to start the process.