Interface Config

Specifies the URL to base the config on. This is especially helpful when you have multiple release channels and you need a different source for each release channel but want to reduce duplicate configuration.

If the config is hosted in a public GitHub repository, please use the format github:{user or org}/{repo name}/{file path}. For example, github:SideStore/SideSource/example/config/base.json. This will allow us to get around the rate limiting of raw files using the GitHub API.

If you are not using a custom domain (aka you are not using caching), you should not use any github: URLs. github: URLs resolve using GitHub's API, which is limited to 60 requests per hour without an access token, which will be exceeded very quickly without caching. Instead, use the URL that your browser goes to when viewing the "raw" contents of a file.

Number of minutes results will be cached for. If 0, caching will be disabled.

Defaults to 4 hours (240 minutes).

Specifies the URL to fetch the config as JSON. This allows for updating the config without having to re-deploy the cloudflare worker.

If the config is hosted in a public GitHub repository, please use the format github:{user or org}/{repo name}/{file path}. If you need to specify a branch, use this format: github:{user or org}/{repo name}/{file path}?{branch}. For example, github:SideStore/SideSource/example/config/stable.json. This will allow us to get around the rate limiting of raw files using the GitHub API.

If you are not using a custom domain (aka you are not using caching), you should not use any github: URLs. github: URLs resolve using GitHub's API, which is limited to 60 requests per hour without an access token, which will be exceeded very quickly without caching. Instead, use the URL that your browser goes to when viewing the "raw" contents of a file.

Required if remoteConfig is not false. Otherwise, it does nothing.

Inputs for the source.

Please see https://sidestore.io/sidestore-source-types/interfaces/News.html for possible values

An object that will be used to override properties.

Your source output looks something like this:

{
    "name": "Source",
    "identifier": "com.example.source",
    "apps": [
        {
            "name": "My App",
            "identifier": "com.example.myapp"
        }
    ]
}

If you want to change the name property of the first app, you could set overrides to this:

{
    "apps": [
        {
            "name": "Override"
        }
    ]
}

Result:

{
    "name": "Source",
    "identifier": "com.example.source",
    "apps": [
        {
            "name": "Override",
            "identifier": "com.example.myapp"
        }
    ]
}

However, if you have more than one app, like this:

{
    "name": "Source",
    "identifier": "com.example.source",
    "apps": [
        {
            "name": "My App",
            "identifier": "com.example.myapp"
        },
        {
            "name": "My App 2",
            "identifier": "com.example.myapp2"
        }
    ]
}

If you only want to override the second one, you will need to do this:

{
    "apps": [
        {},
        {
            "name": "Override"
        }
    ]
}

Note the first empty app override. Result:

{
    "name": "Source",
    "identifier": "com.example.source",
    "apps": [
        {
            "name": "My App",
            "identifier": "com.example.myapp"
        },
        {
            "name": "Override",
            "identifier": "com.example.myapp2"
        }
    ]
}

You can also manually specify the paths to override with property paths:

{
    "apps[0].name": "Override"
}

Result (using previous 2 app example):

{
    "name": "Source",
    "identifier": "com.example.source",
    "apps": [
        {
            "name": "Override",
            "identifier": "com.example.myapp"
        },
        {
            "name": "My App 2",
            "identifier": "com.example.myapp2"
        }
    ]
}

If set to false, the config will not be fetched from configURL. This is not recommended because you will have to re-deploy your cloudflare worker whenever you want to change the config.

Defaults to true.

Source metadata