Skip to main content

Resource

In Nanocl, a Resource refers to a configuration setting.
A Resource can be any Kind of configuration defined by the user, currently there is only no Kind of Resource natively supported:

While Kind of Resource can be defined by the user, there is currently two type of Resources usually supported after a basic installation:

Plugin KindUsage
ncproxy.io/ruledata for setup a proxy config installed by our proxy controller
ncdns.io/ruledata for setup a dns config installed by our dns controller

Proxy Rule​

As the name suggests, a ProxyRule is a configuration that determines how your cargoes can be accessed through the proxy.
By configuring ProxyRules, you can fine-tune the accessibility of your cargoes.

There is the openapi specification to create a proxy ProxyRule:

required
Array of ProxyRuleHttp (object) or ProxyRuleStream (object) (ProxyRule)

The rules to apply

{
  • "Rules": [
    ]
}

Proxy Rule Network​

NetworkUsage
InternalBind only on 127.0.0.1
PublicBind only on public ip address
AllBind on all interfaces
{namespace_name}.nspBind on namespace gateway

Dns Rule​

As the name suggests, a DnsRule is a configuration that determines how a dns server is configured.
That way you can tunes your network access with domain names.

There is the openapi specification to create a proxy ProxyRule:

required
Array of objects (DnsEntry)
Network
required
string
{
  • "Network": "string",
  • "Entries": [
    ]
}