feat: letsencrypt staging environment

2025-10-04 21:44:54 +00:00 · 2025-01-06 19:45:26 +08:00
parent 87e1749553
commit 155371cdd0
7 changed files with 137 additions and 58 deletions
--- a/ui/src/domain/settings.ts
+++ b/ui/src/domain/settings.ts
@@ -133,13 +133,11 @@ export const notifyChannelsMap: Map<NotifyChannel["type"], NotifyChannel> = new
 // #endregion

 // #region Settings: SSLProvider
-export const SSLPROVIDER_LETSENCRYPT = "letsencrypt" as const;
-export const SSLPROVIDER_ZEROSSL = "zerossl" as const;
-export const SSLPROVIDER_GOOGLETRUSTSERVICES = "gts" as const;
 export const SSLPROVIDERS = Object.freeze({
-  LETS_ENCRYPT: SSLPROVIDER_LETSENCRYPT,
-  ZERO_SSL: SSLPROVIDER_ZEROSSL,
-  GOOGLE_TRUST_SERVICES: SSLPROVIDER_GOOGLETRUSTSERVICES,
+  LETS_ENCRYPT: "letsencrypt",
+  LETS_ENCRYPT_STAGING: "letsencrypt_staging",
+  ZERO_SSL: "zerossl",
+  GOOGLE_TRUST_SERVICES: "gts",
 } as const);

 export type SSLProviders = (typeof SSLPROVIDERS)[keyof typeof SSLPROVIDERS];
@@ -148,9 +146,10 @@ export type SSLProviderSettingsContent = {
  provider: (typeof SSLPROVIDERS)[keyof typeof SSLPROVIDERS];
  config: {
    [key: string]: Record<string, unknown> | undefined;
-    letsencrypt?: SSLProviderLetsEncryptConfig;
-    zerossl?: SSLProviderZeroSSLConfig;
-    gts?: SSLProviderGoogleTrustServicesConfig;
+    [SSLPROVIDERS.LETS_ENCRYPT]?: SSLProviderLetsEncryptConfig;
+    [SSLPROVIDERS.LETS_ENCRYPT_STAGING]?: SSLProviderLetsEncryptConfig;
+    [SSLPROVIDERS.ZERO_SSL]?: SSLProviderZeroSSLConfig;
+    [SSLPROVIDERS.GOOGLE_TRUST_SERVICES]?: SSLProviderGoogleTrustServicesConfig;
  };
 };

--- a/ui/src/i18n/locales/en/nls.settings.json
+++ b/ui/src/i18n/locales/en/nls.settings.json
@@ -73,6 +73,12 @@

  "settings.sslprovider.tab": "Certificate authority",
  "settings.sslprovider.form.provider.label": "ACME provider",
+  "settings.sslprovider.form.provider.option.letsencrypt.label": "Let's Encrypt",
+  "settings.sslprovider.form.provider.option.letsencrypt_staging.label": "Let's Encrypt Staging Environment",
+  "settings.sslprovider.form.provider.option.zerossl.label": "ZeroSSL",
+  "settings.sslprovider.form.provider.option.gts.label": "Google Trust Services",
+  "settings.sslprovider.form.letsencrypt_staging_alert": "The staging environment can reduce the chance of your running up against rate limits.<br><br>Learn more:<br><a href=\"https://letsencrypt.org/docs/staging-environment/\" target=\"_blank\">https://letsencrypt.org/docs/staging-environment/</a>",
+  "settings.sslprovider.form.letsencrypt_staging_warning": "Attention: Certificates from the staging environment are only for testing purposes.",
  "settings.sslprovider.form.zerossl_eab_kid.label": "EAB KID",
  "settings.sslprovider.form.zerossl_eab_kid.placeholder": "Please enter EAB KID",
  "settings.sslprovider.form.zerossl_eab_kid.tooltip": "For more information, see <a href=\"https://zerossl.com/documentation/acme/\" target=\"_blank\">https://zerossl.com/documentation/acme/</a>",
--- a/ui/src/i18n/locales/zh/nls.settings.json
+++ b/ui/src/i18n/locales/zh/nls.settings.json
@@ -72,7 +72,13 @@
  "settings.notification.channel.form.wecom_webhook_url.tooltip": "这是什么？请参阅 <a href=\"https://open.work.weixin.qq.com/help2/pc/18401#%E5%85%AD%E3%80%81%E7%BE%A4%E6%9C%BA%E5%99%A8%E4%BA%BAWebhook%E5%9C%B0%E5%9D%80\" target=\"_blank\">https://open.work.weixin.qq.com/help2/pc/18401</a>",

  "settings.sslprovider.tab": "证书颁发机构（CA）",
-  "settings.sslprovider.form.provider.label": "ACME 提供商",
+  "settings.sslprovider.form.provider.label": "ACME 服务商",
+  "settings.sslprovider.form.provider.option.letsencrypt.label": "Let's Encrypt",
+  "settings.sslprovider.form.provider.option.letsencrypt_staging.label": "Let's Encrypt 测试环境",
+  "settings.sslprovider.form.provider.option.zerossl.label": "ZeroSSL",
+  "settings.sslprovider.form.provider.option.gts.label": "Google Trust Services",
+  "settings.sslprovider.form.letsencrypt_staging_alert": "测试环境比生产环境有更宽松的速率限制，可进行测试性部署。<br><br>点击下方链接了解更多：<br><a href=\"https://letsencrypt.org/zh-cn/docs/staging-environment/\" target=\"_blank\">https://letsencrypt.org/zh-cn/docs/staging-environment/</a>",
+  "settings.sslprovider.form.letsencrypt_staging_warning": "警告：测试环境证书仅能用于测试目的。",
  "settings.sslprovider.form.zerossl_eab_kid.label": "EAB KID",
  "settings.sslprovider.form.zerossl_eab_kid.placeholder": "请输入 EAB KID",
  "settings.sslprovider.form.zerossl_eab_kid.tooltip": "这是什么？请参阅 <a href=\"https://zerossl.com/documentation/acme/\" target=\"_blank\">https://zerossl.com/documentation/acme/</a>",
--- a/ui/src/pages/settings/SettingsSSLProvider.tsx
+++ b/ui/src/pages/settings/SettingsSSLProvider.tsx
@@ -1,7 +1,7 @@
 import { createContext, useContext, useEffect, useMemo, useState } from "react";
 import { useTranslation } from "react-i18next";
 import { CheckCard } from "@ant-design/pro-components";
-import { Button, Form, Input, Skeleton, message, notification } from "antd";
+import { Alert, Button, Form, Input, Skeleton, message, notification } from "antd";
 import { createSchemaFieldRule } from "antd-zod";
 import { produce } from "immer";
 import { z } from "zod";
@@ -61,6 +61,55 @@ const SSLProviderEditFormLetsEncryptConfig = () => {
  );
 };

+const SSLProviderEditFormLetsEncryptStagingConfig = () => {
+  const { t } = useTranslation();
+
+  const { pending, settings, updateSettings } = useContext(SSLProviderContext);
+
+  const { form: formInst, formProps } = useAntdForm<NonNullable<unknown>>({
+    initialValues: settings?.content?.config?.[SSLPROVIDERS.LETS_ENCRYPT_STAGING],
+    onSubmit: async (values) => {
+      const newSettings = produce(settings, (draft) => {
+        draft.content ??= {} as SSLProviderSettingsContent;
+        draft.content.provider = SSLPROVIDERS.LETS_ENCRYPT_STAGING;
+
+        draft.content.config ??= {} as SSLProviderSettingsContent["config"];
+        draft.content.config[SSLPROVIDERS.LETS_ENCRYPT_STAGING] = values;
+      });
+      await updateSettings(newSettings);
+
+      setFormChanged(false);
+    },
+  });
+
+  const [formChanged, setFormChanged] = useState(false);
+  useEffect(() => {
+    setFormChanged(settings?.content?.provider !== SSLPROVIDERS.LETS_ENCRYPT_STAGING);
+  }, [settings?.content?.provider]);
+
+  const handleFormChange = () => {
+    setFormChanged(true);
+  };
+
+  return (
+    <Form {...formProps} form={formInst} disabled={pending} layout="vertical" onValuesChange={handleFormChange}>
+      <Form.Item>
+        <Alert type="info" message={<span dangerouslySetInnerHTML={{ __html: t("settings.sslprovider.form.letsencrypt_staging_alert") }}></span>} />
+      </Form.Item>
+
+      <Form.Item>
+        <Alert type="warning" message={<span dangerouslySetInnerHTML={{ __html: t("settings.sslprovider.form.letsencrypt_staging_warning") }}></span>} />
+      </Form.Item>
+
+      <Form.Item>
+        <Button type="primary" htmlType="submit" disabled={!formChanged} loading={pending}>
+          {t("common.button.save")}
+        </Button>
+      </Form.Item>
+    </Form>
+  );
+};
+
 const SSLProviderEditFormZeroSSLConfig = () => {
  const { t } = useTranslation();

@@ -231,6 +280,8 @@ const SettingsSSLProvider = () => {
    switch (providerType) {
      case SSLPROVIDERS.LETS_ENCRYPT:
        return <SSLProviderEditFormLetsEncryptConfig />;
+      case SSLPROVIDERS.LETS_ENCRYPT_STAGING:
+        return <SSLProviderEditFormLetsEncryptStagingConfig />;
      case SSLPROVIDERS.ZERO_SSL:
        return <SSLProviderEditFormZeroSSLConfig />;
      case SSLPROVIDERS.GOOGLE_TRUST_SERVICES:
@@ -272,14 +323,25 @@ const SettingsSSLProvider = () => {
              <CheckCard
                avatar={<img src={"/imgs/acme/letsencrypt.svg"} className="size-8" />}
                size="small"
-                title="Let's Encrypt"
+                title={t("settings.sslprovider.form.provider.option.letsencrypt.label")}
                value={SSLPROVIDERS.LETS_ENCRYPT}
              />
-              <CheckCard avatar={<img src={"/imgs/acme/zerossl.svg"} className="size-8" />} size="small" title="ZeroSSL" value={SSLPROVIDERS.ZERO_SSL} />
+              <CheckCard
+                avatar={<img src={"/imgs/acme/letsencrypt.svg"} className="size-8" />}
+                size="small"
+                title={t("settings.sslprovider.form.provider.option.letsencrypt_staging.label")}
+                value={SSLPROVIDERS.LETS_ENCRYPT_STAGING}
+              />
+              <CheckCard
+                avatar={<img src={"/imgs/acme/zerossl.svg"} className="size-8" />}
+                size="small"
+                title={t("settings.sslprovider.form.provider.option.zerossl.label")}
+                value={SSLPROVIDERS.ZERO_SSL}
+              />
              <CheckCard
                avatar={<img src={"/imgs/acme/google.svg"} className="size-8" />}
                size="small"
-                title="Google Trust Services"
+                title={t("settings.sslprovider.form.provider.option.gts.label")}
                value={SSLPROVIDERS.GOOGLE_TRUST_SERVICES}
              />
            </CheckCard.Group>