Skip to content

Subscriptions ​

A subscription is a profile that Specola would download from a URL and refresh on a schedule. The current Core cannot do this. This page says what happens when you try, and how to use a published profile today.

Current state ​

What you tryWhat happens
Add from URL on the Profiles pageCore does not serve the subscription methods. The app reports This Core does not support URL profiles yet. and nothing is added.
Update now or the update interval of a profilenot available: Core never lists a profile as a subscription
[[subscription]] or subscriptions in a profileignored, with the warning Ignoring configuration field 'subscription' in the minimal build
[metadata] type = "subscription", [metadata.subscription] (auto-update, update-interval, user-agent), [metadata] download-viano effect: Core drops the whole [metadata] table before reading it. The subscription settings in the app stay disabled.
Control API profile.createSubscriptionProfile, profile.updateSubscriptionProfile, profile.refreshSubscriptionProfiledefined in api/profile.toml, but Core replies method not found

[metadata] name is still useful: the app shows it as the profile's name.

Using a published profile today ​

  1. Download the profile file from the publisher.

  2. Read it, then validate it:

    bash
    specola-core --test-config --config /absolute/path/to/team.toml
  3. On Profiles, use Import file, then Use this profile.

A profile controls every route, DNS answer and listener of Core. Only use files from publishers you trust, and read what they route where.

Keep your own changes in modules ​

Put your own rules, proxies and DNS settings in a module and apply it to the published profile, instead of editing the profile itself. When a new version of the profile comes out, you replace the file and your module still applies on top.

Updating by hand ​

An import never overwrites an existing profile. To update, replace the file in the Profiles folder yourself and activate the profile again:

bash
# macOS / Linux example
curl -fsSL -o /tmp/team.toml https://config.example.org/team.toml
specola-core --test-config --config /tmp/team.toml \
  && cp /tmp/team.toml ~/.config/specola/profiles/team.toml

The test above checks the file alone. Activation checks it again together with its modules; if it fails, the profile that was running keeps running. The Profiles folder of each platform is listed in Quick Start.

team.toml.modules and team.toml.disabled-rules stay next to the file when you replace it, so the modules and the rules you switched off still apply. A switched-off rule is matched by its text; if the new version changes that rule, it is on again.