Skip to content

Latest commit

 

History

History
22 lines (19 loc) · 1.32 KB

README.md

File metadata and controls

22 lines (19 loc) · 1.32 KB
Raw

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/");
}