CommunityToolkit.Aspire.Hosting.Sftp 13.6.1

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer prerelease version of this package available.
See the version list below for details. 
dotnet add package CommunityToolkit.Aspire.Hosting.Sftp --version 13.6.1
                    


                    

                
NuGet\Install-Package CommunityToolkit.Aspire.Hosting.Sftp -Version 13.6.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="CommunityToolkit.Aspire.Hosting.Sftp" Version="13.6.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="CommunityToolkit.Aspire.Hosting.Sftp" Version="13.6.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="CommunityToolkit.Aspire.Hosting.Sftp" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add CommunityToolkit.Aspire.Hosting.Sftp --version 13.6.1
                    


                    

                
#r "nuget: CommunityToolkit.Aspire.Hosting.Sftp, 13.6.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package CommunityToolkit.Aspire.Hosting.Sftp@13.6.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=CommunityToolkit.Aspire.Hosting.Sftp&version=13.6.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=CommunityToolkit.Aspire.Hosting.Sftp&version=13.6.1
                    


                            Install as a Cake Tool

CommunityToolkit.Aspire.Hosting.Sftp

Overview

This Aspire integration is a wrapper for the atmoz SFTP server image.

Usage

The SFTP integration exposes a connection string with the format endpoint=sftp://<host>:<port>.

Example 1: Add SFTP container with users as an argument or environment variable

Define users in (1) command arguments or (2) SFTP_USERS environment variable (syntax: user:pass[:e][:uid[:gid[:dir1[,dir2]...]]], see below for examples)

Add :e behind password to mark it as encrypted. On Windows, use wsl mkpasswd -m sha-512 to generate encrypted passwords.

builder.AddSftp("sftp").WithArgs($"foo:pass:::uploads");

builder.AddSftp("sftp").WithEnvironment("SFTP_USERS", "foo:pass:::uploads");

builder.AddSftp("sftp").WithEnvironment("SFTP_USERS", "foo:$5$t9qxNlrcFqVBNnad$U27ZrjbKNjv4JkRWvi6MjX4x6KXNQGr8NTIySOcDgi4:e:::uploads");

Example 2: Add SFTP container with users in config file

Define users in file mounted as /etc/sftp/users.conf using the WithUsersFile() extension method.

builder.AddSftp("sftp").WithUsersFile("users.conf");

Example 3: Add SFTP container with own host key

This container will generate new SSH host keys at first run. To avoid that your users get a MITM warning when you recreate your container (and the host keys changes), you can mount your own host keys with the WithHostKeyFile() extension method.

builder.AddSftp("sftp").WithUsersFile("users.conf").WithHostKeyFile("ssh_host_ed25519_key", KeyType.Ed25519);

Example 4: Add SFTP container with user public key

Mount public keys in the user's .ssh/keys/ directory using the WithUserKeyFile() extension method. All keys are automatically appended to .ssh/authorized_keys (you can't mount this file directly, because OpenSSH requires limited file permissions). In this example, we do not provide any password, so the user foo can only login with the corresponding private key.

builder.AddSftp("sftp").WithArgs("foo::::uploads").WithUserKeyFile("foo", "id_rsa.pub", KeyType.Rsa);

builder.AddSftp("sftp").WithArgs("foo::::uploads").WithUserKeyFile("foo", "id_ed25519.pub", KeyType.Ed25519);
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
13.6.2-beta.959 38 10/27/2026
13.6.1 86 10/26/2026
13.6.1-beta.950 45 10/26/2026
13.6.1-beta.938 47 10/24/2026
13.6.1-beta.935 62 10/15/2026
13.6.1-beta.933 56 10/13/2026
13.6.1-beta.930 61 10/11/2026
13.6.0 978 10/1/2026
13.6.0-beta.914 56 10/1/2026
13.6.0-beta.910 58 9/30/2026
13.5.1-beta.895 65 9/29/2026
13.5.1-beta.806 65 9/28/2026
13.5.1-beta.803 59 9/28/2026
13.5.1-beta.781 60 9/28/2026
13.5.1-beta.779 53 9/28/2026
13.5.1-beta.777 52 9/28/2026
13.5.1-beta.776 63 9/28/2026
13.5.1-beta.775 64 9/27/2026
13.5.1-beta.770 67 9/25/2026
13.5.1-beta.767 62 9/22/2026
Loading failed