Elefess.Authenticators.GitHub 1.2.0

dotnet add package Elefess.Authenticators.GitHub --version 1.2.0
NuGet\Install-Package Elefess.Authenticators.GitHub -Version 1.2.0
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="Elefess.Authenticators.GitHub" Version="1.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Elefess.Authenticators.GitHub --version 1.2.0
#r "nuget: Elefess.Authenticators.GitHub, 1.2.0"
#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.
// Install Elefess.Authenticators.GitHub as a Cake Addin
#addin nuget:?package=Elefess.Authenticators.GitHub&version=1.2.0

// Install Elefess.Authenticators.GitHub as a Cake Tool
#tool nuget:?package=Elefess.Authenticators.GitHub&version=1.2.0

Elefess.Authenticators.GitHub

Elefess.Authenticators.GitHub is a custom ILfsAuthenticator implementation for Elefess which utilizes a GitHub username & personal access token for Basic authorization.

Quick start

See the main Elefess quick start guide for core Elefess-related information.

While registering your services:

// Registers an instance of GitHubLfsAuthenticator, an implementation of ILfsAuthenticator
services.AddGitHubAuthenticator("MyGitHubUsername", "MyGitHubRepository");

Git LFS clients should be expected to send a Basic Authorization header with the encoded value being your GitHub username and a personal access token with permission to view the repository used for the authenticator.

An alternative method which does not require passing your organization/username and repository names directly can also be used, but this requires you to additionally register an instance of GitHubLfsAuthenticatorOptions to your service provider:

public sealed class GitHubLfsAuthenticatorOptions
{
    public string Organization { get; init; } = string.Empty;
    public string Repository { get; init; } = string.Empty;
    public Uri BaseAddress { get; init; } = new("https://api.github.com/");
}
Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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. 
Compatible target framework(s)
Additional computed target framework(s)
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
1.2.0 145 5/9/2023
1.1.0 127 5/9/2023
1.0.0 122 5/9/2023

Split READMEs into per-project files.