CloudPub.Client 1.2.0

CloudPub .NET SDK

Expose local HTTP, HTTPS, TCP, and other services to the internet through CloudPub — similar in spirit to ngrok-style tunnels, with a control WebSocket, protobuf protocol, and optional ASP.NET Core integration that publishes your app during startup and tears it down on shutdown.

This repository ships two NuGet packages:

Both packages share the root namespace CloudPub (types such as CloudPubClient, CloudPub.Options.CloudPubClientOptions).

Installation

dotnet add package CloudPub.Client

For ASP.NET Core integration:

dotnet add package CloudPub.AspNet

(CloudPub.AspNet references CloudPub.Client; you do not need to add the client package separately unless you want an explicit reference.)

Authentication

The agent handshake accepts either:

• Token — set CloudPubClientOptions.Token (e.g. from environment or user secrets), or
• Email + password — set Email and Password.

You can also point ServerUri at another control plane (default is https://cloudpub.ru).

Using the client library

Minimal example (publish HTTP on localhost)

using CloudPub;
using CloudPub.Options;
using CloudPub.Protocol;

CloudPubClientOptions options = new CloudPubClientOptions
{
    Email = "you@example.com",
    Password = "your-password",
    // Or: Token = "your-token",
};

await using CloudPubClient client = new CloudPubClient(options);
await client.ConnectAsync();

Endpoint endpoint = await client.PublishAsync(new CloudPubPublishOptions
{
    Protocol = ProtocolType.Http,
    Address = "8080",              // localhost:8080 (or host:port, URL, etc.)
    Name = "my-app",
    Auth = AuthType.None,
});

Console.WriteLine($"Public URL: {endpoint.Url}");
// … keep running …
await client.UnpublishAsync(endpoint);

Extension helpers (CloudPubClientExtensions)

After ConnectAsync, use the static extension methods on ICloudPubClient:

CloudPubClientOptions (common properties)

CloudPubPublishOptions (publishing)

ASP.NET Core addon (CloudPub.AspNet)

The addon wires ICloudPubClient into DI and provides HostedCloudPubLifecycleService, which:

1. Runs during host startup (IHostedLifecycleService.StartingAsync): connects the client and calls PublishAsync for each registered CloudPubPublishOptions.
2. Adds each public URL to IServerAddressesFeature.Addresses (so logs show “Now listening on …” for the tunnel URL as well as local URLs).
3. Runs during shutdown (StoppingAsync): unpublishes each endpoint.

1. Register client + options

Pick one style.

Option A — bind from configuration (recommended)

appsettings.json:

{
  "CloudPub": {
    "ServerUri": "https://cloudpub.ru",
    "Email": "you@example.com",
    "Password": "your-password"
  }
}

Program:

using CloudPub;

WebApplicationBuilder builder = WebApplication.CreateBuilder(args);

builder.Services.AddCloudPub(builder.Configuration.GetSection("CloudPub"));

Option B — inline options

builder.Services.AddCloudPub(new CloudPub.Options.CloudPubClientOptions
{
    Token = builder.Configuration["CloudPub:Token"]!,
});

Option C — custom factory

builder.Services.AddCloudPub(sp =>
{
    CloudPub.Options.CloudPubClientOptions o = sp.GetRequiredService<IOptions<CloudPub.Options.CloudPubClientOptions>>().Value;
    return new CloudPubClient(o);
});

2. Declare what to publish

Register one or more publish profiles. The port overload publishes localhost at that port (same idea as Address = "5000" in the client API):

builder.Services.AddPublishEndpoint(port: 5000, name: "My API");

// Or full control:
builder.Services.AddPublishEndpoint(new CloudPub.Options.CloudPubPublishOptions
{
    Protocol = CloudPub.Protocol.ProtocolType.Https,
    Address = "5001",
    Name = "Secure API",
});

Full minimal Program.cs sketch

using CloudPub;

WebApplicationBuilder builder = WebApplication.CreateBuilder(args);

builder.Services.AddCloudPub(builder.Configuration.GetSection("CloudPub"));
builder.Services.AddPublishEndpoint(port: 5000, name: "Sample site");

WebApplication app = builder.Build();
app.MapGet("/", () => "Hello from CloudPub!");
app.Run();

CloudPubEndpointsBuilder

builder.Services.AddCloudPub(builder.Configuration.GetSection("CloudPub"));
builder.Services.AddPublishEndpoint(builder => builder
    .AddPublishEndpoint(port: 5010, name: "Sample site")
    .AddPublishEndpoint(port: 5020, name: "Sample site 2"));

Requirements: a server that exposes IServerAddressesFeature (Kestrel does). The hosted service throws at startup if the feature is missing.

Sample console project

The solution includes CloudPub.Example: a small CLI that reads CLOUDPUB_* environment variables and can publish-http <port> to expose a local HTTP port. Run it with:

set CLOUDPUB_EMAIL=you@example.com
set CLOUDPUB_PASSWORD=secret
dotnet run --project src/CloudPub.Example/CloudPub.Example.csproj -- publish-http 8080

(Use CLOUDPUB_TOKEN instead of email/password if you prefer.)

Building from source

git clone <repository-url>
cd CloudPub.Client
dotnet build CloudPub.Sdk.slnx -c Release

Packages are emitted under bin/Release/ when GeneratePackageOnBuild is enabled.

Repository and license

• Repository: see the package metadata (e.g. RepositoryUrl in the .csproj files).
• License: see the LICENSE file bundled with the package.

For API details, open the XML documentation shipped with each package or browse the /// comments in the source.