Resource Files (DSM 7)¶

Resource files are JSON configuration files that define package resources. While resource files work with DSM 6 and later, some features like web services are only available in DSM 7+.

Overview¶

Resource files provide a declarative way to:

Configure shared folder permissions
Define network ports
Create symlinks in system paths
Set up web services (DSM 7+)

For more information, see the Synology Developer Guide - Resource Acquisition.

Makefile Variables

For port configuration, use the FWPORTS Makefile variable instead of manually editing resource files. For command-line symlinks, use SPK_COMMANDS. See Makefile Variables.

File Locations¶

Resource files are placed in the package's conf directory:

spk/<package>/src/conf/resource

For DSM 7.2+ specific features:

spk/<package>/src/conf_72/resource

Basic Structure¶

{
    "data-share": { ... },
    "port-config": { ... },
    "usr-local-linker": { ... },
    "webservice": { ... }
}

Data Shares¶

Define shared folder requirements and permissions:

{
    "data-share": {
        "shares": [
            {
                "name": "{{wizard_data_share}}",
                "permission": {
                    "rw": ["{{wizard_data_share_user}}"]
                }
            }
        ]
    }
}

Permission Types¶

Type	Description
`rw`	Read/write access
`ro`	Read-only access
`na`	No access

Multiple Shares¶

{
    "data-share": {
        "shares": [
            {
                "name": "{{wizard_data_share}}",
                "permission": {
                    "rw": ["{{wizard_data_share_user}}"]
                }
            },
            {
                "name": "{{wizard_backup_share}}",
                "permission": {
                    "rw": ["{{wizard_data_share_user}}"]
                }
            }
        ]
    }
}

Port Configuration¶

Ports are typically configured using the FWPORTS Makefile variable rather than directly in resource files:

# In spk/<package>/Makefile
FWPORTS = src/<package>.sc

The protocol file (spk/<package>/src/<package>.sc) defines the ports:

[mypackage]
title = "Web Interface"
desc = "HTTP service"
port_forward = no
dst.ports = "8080/tcp"

Protocol File Options¶

Option	Description
`title`	Display name
`desc`	Description
`port_forward`	Enable port forwarding
`dst.ports`	Port and protocol (e.g., "8080/tcp")

usr-local-linker¶

Command-line symlinks are typically configured using the SPK_COMMANDS Makefile variable:

# In spk/<package>/Makefile
SPK_COMMANDS = bin/mycommand bin/myother

This creates: - /usr/local/bin/mycommand → /var/packages/<pkg>/target/bin/mycommand - /usr/local/bin/myother → /var/packages/<pkg>/target/bin/myother

Web Service¶

Configure web applications running under WebStation (DSM 7+ only). See Synology Web Service Documentation.

{
    "webservice": {
        "services": [{
            "service": "mypackage",
            "display_name": "My Package",
            "type": "apache_php",
            "root": "web",
            "backend": 2,
            "icon": "ui/mypackage_{0}.png"
        }]
    }
}

Service Types¶

Type	Description
`apache_php`	PHP application
`nginx`	nginx web server
`node`	Node.js application

Backend Values¶

Value	DSM 7.0-7.1	DSM 7.2+
1	Apache 2.2	-
2	Apache 2.4	Apache 2.4
3	nginx	nginx

Variables in Resource Files¶

Wizard values can be referenced using Mustache syntax:

{
    "data-share": {
        "shares": [{
            "name": "{{wizard_data_share}}"
        }]
    }
}

Common Variables¶

Variable	Source
`{{wizard_*}}`	From installation wizard
`{{SYNOPKG_PKGNAME}}`	Package name
`{{SYNOPKG_PKGVAR}}`	Package variable directory

DSM Version-Specific Resources¶

For different DSM versions, create separate conf directories:

spk/<package>/src/
├── conf/            # DSM 6 and DSM 7.0-7.1
│   └── resource
├── conf_7/          # DSM 7.0+
│   └── resource
└── conf_72/         # DSM 7.2+
    └── resource

The build system selects the appropriate version.

Example: Complete Resource File¶

This example shows the data-share configuration. Port and command-line links are typically handled via Makefile variables (FWPORTS and SPK_COMMANDS).

{
    "data-share": {
        "shares": [
            {
                "name": "{{wizard_data_share}}",
                "permission": {
                    "rw": ["{{wizard_data_share_user}}"]
                }
            }
        ]
    }
}

Database Resources¶

Packages can request database resources. See Synology MariaDB Documentation for details.

{
    "mariadb10-db": {
        "admin-account-m10": "{{wizard_mysql_password_root}}",
        "create-db": {
            "flag": true,
            "db-name": "{{wizard_db_name}}",
            "db-collision": "skip"
        }
    }
}

Best Practices¶

Minimal permissions - Request only necessary folder access
Document ports - Use clear titles and descriptions
Version-specific files - Create separate resources for DSM 7.2+ features
Test thoroughly - Verify on actual DSM installations