Triunnia Labs

ASP.NET

Arch is built on the ASP.NET platform. To get started with the Files Api, add its NuGet package to your program, register it with the service collection, and work with its client.

NuGet Setup

Add NuGet package TriunniaLabs.Arch.Api.Files.Client to your project.

Note that we use our own NuGet package feed, which you must add as a package source in your environment.

Service Setup

In the main Service Composition section of your program startup, make the call to AddTriunniaLabsFilesApi() to add the Files Api. This reads the FilesApi configuration section, registers the Files Api client with its resilience policies, and provides a callback for its types to be registered with the message formatter.

builder.Services.AddTriunniaLabsFilesApi(builder.Configuration, builder.Services.AddStandardMessagePackFormatters);

See: Program.cs

Accessing the Files Api

Access the Files Api by injecting the IFilesApiClient.

See FilesApiSampleController.cs for examples of how to use its functions. Note that all parameters passed to these functions must be Protected Types (Protected<T>). Use UploadAsync with a stream source for large files and DownloadSmallAsync for frequently accessed small files that benefit from the coordinated memory cache.

Aspire

If using Aspire, add this extension method to your solution to install the Files Api in the Aspire solution. Set the correct version number, fill in the environment variables, ensure the bind mount path is accurate, and make any other changes as required.

public static void AddFilesApi(this IDistributedApplicationBuilder builder) { builder.AddContainer("FilesApi", "gitea.triunnialabs.com/triunnialabs/arch-files-api", "0.1.4") .WithEndpoint(50008, 8080, isProxied: false, name: "http") .WithEndpoint("http", e => e.TargetHost = "0.0.0.0") // Obtain the values for these fields from the Control Panel .WithEnvironment("Microservice__Name", "") .WithEnvironment("Microservice__EnvelopePassword", "") .WithEnvironment("Microservice__EnableDiagnostics", "true") // Set to false in production deployments .WithEnvironment("Microservice__Application__Url", "") .WithEnvironment("Microservice__Application__ApplicationId", "") .WithEnvironment("Microservice__Application__ApiKey", "") .WithEnvironment("Microservice__Application__EnvelopePassword", "") .WithEnvironment("Microservice__ProtectedMemory__HmacSha512HashKey", "") .WithEnvironment("Microservice__ProtectedMemory__AesEncryptionPassword", "") .WithEnvironment("Microservice__ProtectedMemory__AesEncryptionSalt", "") .WithEnvironment("Microservice__ProtectedMemory__AesEncryptionIterations", "") .WithEnvironment("FilesApi__DataPath", "/opt/triunnialabs/arch/apis/files/data") .WithEnvironment("FilesApi__MaxSmallFileSizeBytes", "102400") .WithEnvironment("FilesApi__CacheTimeSeconds", "300") // Api will write log and other files to this relative source folder .WithBindMount("..\\..\\..\\data\\FilesApi", "/opt/triunnialabs/arch/apis/files"); }

See: FilesApiSetup.cs