Skip to content

Upgrading to LettuceEncrypt 1.0.0 🥬 - package and code renames #99

Closed
@natemcmaster

Description

@natemcmaster

This project has been renamed to LettuceEncrypt. This rename does not affect the features it offers or its function. This rename requires manual changes to your code to upgrade from older versions (see instructions below), but I expect the upgrade will be minimal effort on your part. This project still uses https://letsencrypt.org as the default certificate authority.

Earlier versions of this project are now unsupported. Please upgrade to LettuceEncrypt 1.0.0.
There will not be any updates to McMaster.AspNetCore.LetsEncrypt on nuget.org. I have hidden the old packages, but per nuget.org's policy, they are not deleted so existing users can continue to download it.

Why rename?

Earlier versions of this package were named "McMaster.AspNetCore.LetsEncrypt", a name selected from combining my family name, the web framework for .NET Core, and the most widely used certificate authority that implements the ACME protocol, which is "Let's Encrypt®", of course. This was started as a hobby project years ago and I never thought the naming would be a problem. This project drew the attention of the Internet Security Research Group (ISRG)™️, which runs Let's Encrypt. They informed me last week that they considered my original project name a violation of their trademarks. As this code is not an official offering of ISRG and I want to support their efforts to run Let's Encrypt, I have complied with their request to rename the project.

So to be clear, this project is not officially offered by ISRG and Let's Encrypt, nor Microsoft and the ASP.NET Core project or Azure. This is still a hobby project of @natemcmaster and is available for use under the terms of the Apache License 2.0.

How to upgrade

Step 1 - your .csproj file

Replace usage of the McMaster.AspNetCore.LetsEncrypt with LettuceEncrypt.

- <PackageReference Include="McMaster.AspNetCore.LetsEncrypt" Version="0.5.0" />
- <PackageReference Include="McMaster.AspNetCore.LetsEncrypt.Azure" Version="0.5.0" />
+ <PackageReference Include="LettuceEncrypt" Version="1.0.0" />
+ <PackageReference Include="LettuceEncrypt.Azure" Version="1.0.0" />

Step 2 - update appsettings.json

Use the "LettuceEncrypt" key now to configure options.

// appsettings.json
{
-    "LetsEncrypt": {
+    "LettuceEncrypt": {
        "AcceptTermsOfService": true,
        "DomainNames": [ "example.com", "www.example.com" ],
        "EmailAddress": "it-admin@example.com",
    }
}

Step 3 - update your C# files

Find and replace all references to the 'McMaster.AspNetCore.LetsEncrypt' namespace with 'LettuceEncrypt'.

- using McMaster.AspNetCore.LetsEncrypt;
+ using LettuceEncrypt;

Also, you may need to update to use new type names and methods. You should be able to find/replace the word 'LetsEncrypt' with 'LettuceEncrypt'.

    public void ConfigureServices(IServiceCollection services)
    {
-        services.AddLetsEncrypt();
+        services.AddLettuceEncrypt();
    }

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions