Merge branch 'knadh:master' into master

dragonwocky · web-flow · commit 31145b8ec5a9 · 2025-06-05T16:47:20.000+10:00
diff --git a/cmd/subscribers.go b/cmd/subscribers.go
@@ -458,9 +458,6 @@ func (a *App) BlocklistSubscribersByQuery(c echo.Context) error {
 
 	req.Search = strings.TrimSpace(req.Search)
 	req.Query = formatSQLExp(req.Query)
-	if req.Search == "" && req.Query == "" {
-		return echo.NewHTTPError(http.StatusBadRequest, a.i18n.Ts("globals.messages.invalidFields", "name", "query"))
-	}
 
 	// Does the user have the subscribers:sql_query permission?
 	if req.Query != "" {
@@ -495,9 +492,6 @@ func (a *App) ManageSubscriberListsByQuery(c echo.Context) error {
 
 	req.Search = strings.TrimSpace(req.Search)
 	req.Query = formatSQLExp(req.Query)
-	if req.Search == "" && req.Query == "" {
-		return echo.NewHTTPError(http.StatusBadRequest, a.i18n.Ts("globals.messages.invalidFields", "name", "query"))
-	}
 
 	// Does the user have the subscribers:sql_query permission?
 	if req.Query != "" {
diff --git a/cmd/templates.go b/cmd/templates.go
@@ -157,7 +157,7 @@ func (a *App) UpdateTemplate(c echo.Context) error {
 	// Subject is only relevant for fixed tx templates. For campaigns,
 	// the subject changes per campaign and is on models.Campaign.
 	var funcs template.FuncMap
-	if o.Type == models.TemplateTypeCampaign {
+	if o.Type == models.TemplateTypeCampaign || o.Type == models.TemplateTypeCampaignVisual {
 		o.Subject = ""
 		funcs = a.manager.TemplateFuncs(nil)
 	} else {
diff --git a/cmd/users.go b/cmd/users.go
@@ -13,7 +13,7 @@ import (
 )
 
 var (
-	reUsername = regexp.MustCompile(`^[a-zA-Z0-9_\\-\\.]+$`)
+	reUsername = regexp.MustCompile(`^[a-zA-Z0-9_\-\.@]+$`)
 )
 
 // GetUser retrieves a single user by ID.
@@ -56,7 +56,7 @@ func (a *App) CreateUser(c echo.Context) error {
 
 	u.Username = strings.TrimSpace(u.Username)
 	u.Name = strings.TrimSpace(u.Name)
-	email := strings.TrimSpace(u.Email.String)
+	email := strings.ToLower(strings.TrimSpace(u.Email.String))
 
 	// Validate fields.
 	if !strHasLen(u.Username, 3, stdInputMaxLen) {
@@ -111,7 +111,7 @@ func (a *App) UpdateUser(c echo.Context) error {
 
 	u.Username = strings.TrimSpace(u.Username)
 	u.Name = strings.TrimSpace(u.Name)
-	email := strings.TrimSpace(u.Email.String)
+	email := strings.ToLower(strings.TrimSpace(u.Email.String))
 
 	// Validate fields.
 	if !strHasLen(u.Username, 3, stdInputMaxLen) {
diff --git a/docs/docs/content/oidc.md b/docs/docs/content/oidc.md
@@ -0,0 +1,77 @@
+
+## OIDC Single Sign On
+
+Listmonk supports single sign-on with OIDC (OpenID Connect). Any standards compliant OIDC provider can be configured in Settings -> Security -> OIDC
+
+!!! note "Automatic user creation"
+    There is no support for automatic user creation via OIDC currently. The Super Admin must create users prior in Admin -> Users with the same e-mail address that is expected from the OIDC provider per user.
+
+
+# Tutorials
+
+Tutorials for configuring listmonk SSO with popular OIDC providers.
+
+## Keycloak
+Keycloak configuration for listmonk SSO integration.
+
+### 1. Create a new client in Keycloak
+In the Keycloak admin, use an existing realm, or create a new realm. Create a new client in `Clients → Create`.
+
+- **General Settings**
+    - **Client type**: `OpenID Connect`
+    - **Client ID**: `listmonk` (or any preferred name)
+    - **Name**: Optional descriptive name (e.g., "listmonk SSO")
+- **Capability Config**:
+    - **Client authentication**: On
+    - **Authorization**: On
+    - **Authentication Flow**
+        - **Standard Flow**: On
+        - **Direct Access grants**: On
+- **Login Settings**:
+    - **Root URL**: Copy the **Redirect URL for oAuth provider** value from listmonk Admin -> Settings -> Security -> OIDC. It will look like `https://listmonk.yoursite.com/auth/oidc`
+    - **Valid redirect URIs**: Same as the Root URL above
+    - **Valid post logout redirect URIs**: *
+
+After the client creation steps above, go to the client's `Credentials` tab and copy the `Client Secret`.
+
+### 2. Configure Listmonk
+2. In Listmonk Admin -> Settings -> Security -> OIDC.
+    - **Enable OIDC SSO**: Turn on
+    - **Provider URL**: `https://keycloak.yoursite.com/auth/realms/{realm}` (replace `{realm}` with the chosen realm name)
+    - **Provider name**: Set a name to show on the listmonk login form, eg: `Login with OrgName`
+    - **Client ID**: Client ID set in Keycloak, eg: `listmonk`
+    - **Client Secret**: Client Secret copied from Keycloak
+
+
+
+## Authentik  
+Authentik configuration for listmonk SSO integration.
+
+### 1. Create a new OIDC provider in Authentik
+In the Authentik admin interface, create a new OIDC provider for listmonk.
+
+- **Provider Settings**:  
+    - **Name**: `listmonk` (or any preferred name)
+    - **Signing Key**: `authentik Self-signed Certificate`
+    - **Client Type**: `Confidential`
+    - **Client ID**: `listmonk` (or any preferred name)
+    - **Redirect URIs**: Copy the **Redirect URL for oAuth provider** value from listmonk Admin -> Settings -> Security -> OIDC. It will look like `https://listmonk.yoursite.com/auth/oidc`
+
+After creating the provider, copy the **Client Secret**.
+
+### 2. Create an application in Authentik
+Create a new application and connect it to the newly created provider.
+
+- **Application Settings**:
+    - **Name**: `listmonk` (or any preferred name)
+    - **Slug**: `listmonk` (or any preferred slug. Used in the redirect URL)
+    - **Provider**: Select the OIDC provider created in the previous step
+
+### 3. Configure listmonk
+In listmonk Admin → Settings → Security → OIDC:
+
+- **Enable OIDC SSO**: Turn on
+- **Provider URL**: `https://authentik.yoursite.com/application/o/{slug}/` (replace `{slug}` with the application's slug)
+- **Provider Name**: Set a name to show on the login form (e.g., `Login with OrgName`)
+- **Client ID**: Client ID set in Authentik (e.g., `listmonk`)
+- **Client Secret**: Client Secret copied from Authentik
diff --git a/docs/docs/mkdocs.yml b/docs/docs/mkdocs.yml
@@ -54,6 +54,7 @@ nav:
     - "Internationalization": "i18n.md"
     - "Integrating with external systems": external-integration.md
     - "User roles and permissions": roles-and-permissions.md
+    - "OIDC SSO": oidc.md
   - "API":
     - "Introduction": apis/apis.md
     - "SDKs and libs": apis/sdks.md
diff --git a/docs/docs/requirements.txt b/docs/docs/requirements.txt
@@ -0,0 +1,4 @@
+mkdocs>=1.6.1
+mkdocs-material>=9.6.14
+mkdocs-material-extensions>=1.3.1
+pymdown-extensions>=10.15
diff --git a/docs/site/data/github.json b/docs/site/data/github.json
@@ -1 +1 @@
-{"version":"v5.0.0","date":"2025-04-28T19:00:04Z","url":"https://github.com/knadh/listmonk/releases/tag/v5.0.0","assets":[{"name":"darwin","url":"https://github.com/knadh/listmonk/releases/download/v5.0.0/listmonk_5.0.0_darwin_amd64.tar.gz"},{"name":"freebsd","url":"https://github.com/knadh/listmonk/releases/download/v5.0.0/listmonk_5.0.0_freebsd_amd64.tar.gz"},{"name":"linux","url":"https://github.com/knadh/listmonk/releases/download/v5.0.0/listmonk_5.0.0_linux_amd64.tar.gz"},{"name":"netbsd","url":"https://github.com/knadh/listmonk/releases/download/v5.0.0/listmonk_5.0.0_netbsd_amd64.tar.gz"},{"name":"openbsd","url":"https://github.com/knadh/listmonk/releases/download/v5.0.0/listmonk_5.0.0_openbsd_amd64.tar.gz"},{"name":"windows","url":"https://github.com/knadh/listmonk/releases/download/v5.0.0/listmonk_5.0.0_windows_amd64.tar.gz"}]}
+{"version":"v5.0.1","date":"2025-05-25T09:59:32Z","url":"https://github.com/knadh/listmonk/releases/tag/v5.0.1","assets":[{"name":"darwin","url":"https://github.com/knadh/listmonk/releases/download/v5.0.1/listmonk_5.0.1_darwin_amd64.tar.gz"},{"name":"freebsd","url":"https://github.com/knadh/listmonk/releases/download/v5.0.1/listmonk_5.0.1_freebsd_amd64.tar.gz"},{"name":"linux","url":"https://github.com/knadh/listmonk/releases/download/v5.0.1/listmonk_5.0.1_linux_amd64.tar.gz"},{"name":"netbsd","url":"https://github.com/knadh/listmonk/releases/download/v5.0.1/listmonk_5.0.1_netbsd_amd64.tar.gz"},{"name":"openbsd","url":"https://github.com/knadh/listmonk/releases/download/v5.0.1/listmonk_5.0.1_openbsd_amd64.tar.gz"},{"name":"windows","url":"https://github.com/knadh/listmonk/releases/download/v5.0.1/listmonk_5.0.1_windows_amd64.tar.gz"}]}
diff --git a/docs/site/layouts/index.html b/docs/site/layouts/index.html
@@ -50,6 +50,8 @@ <h3>Binary</h3>
 
           <br />
           <h3>Hosting providers</h3>
+          <a href="https://www.kloudbean.com/listmonk-self-hosted"><img src="https://storage-basic.kloudbean.com/opensource/deploy_on_kloudbean_listmonk.svg" alt="One-click deploy on Kloudbean" style="max-height: 32px;" /></a>
+          <br />
           <a href="https://railway.app/new/template/listmonk"><img src="https://railway.app/button.svg" alt="One-click deploy on Railway" style="max-height: 32px;" /></a>
           <br />
           <a href="https://www.pikapods.com/pods?run=listmonk"><img src="https://www.pikapods.com/static/run-button.svg" alt="Deploy on PikaPod" /></a>
diff --git a/frontend/package.json b/frontend/package.json
@@ -53,7 +53,7 @@
     "eslint-plugin-import": "^2.23.3",
     "eslint-plugin-vue": "^9.19.2",
     "sass": "^1.34.0",
-    "vite": "^5.4.18",
+    "vite": "^5.4.19",
     "vue-eslint-parser": "^9.3.2",
     "vue-template-compiler": "^2.6.12"
   },
diff --git a/frontend/src/components/Editor.vue b/frontend/src/components/Editor.vue
@@ -318,6 +318,10 @@ export default {
       if (this.self.contentType === 'visual') {
         this.visualTemplateId = this.validTemplates[0]?.id || null;
       } else {
+        if (this.templateId) {
+          return;
+        }
+
         const defaultTemplate = this.validTemplates.find((t) => t.isDefault === true);
         this.templateId = defaultTemplate?.id || this.validTemplates[0]?.id || null;
       }
diff --git a/frontend/src/utils.js b/frontend/src/utils.js
@@ -5,9 +5,11 @@ import {
 import dayjs from 'dayjs';
 import relativeTime from 'dayjs/plugin/relativeTime';
 import updateLocale from 'dayjs/plugin/updateLocale';
+import dayDuration from 'dayjs/plugin/duration';
 
 dayjs.extend(updateLocale);
 dayjs.extend(relativeTime);
+dayjs.extend(dayDuration);
 
 const reEmail = /(.+?)@(.+?)/ig;
 const prefKey = 'listmonk_pref';
@@ -71,11 +73,15 @@ export default class Utils {
   duration = (start, end) => {
     const a = dayjs(start);
     const b = dayjs(end);
+    const d = dayjs.duration(Math.abs(b.diff(a)));
 
-    // Get the duration string, eg: "2 days".
-    const diff = b.from(a, true);
+    const parts = [
+      Math.floor(d.asDays()) && `${Math.floor(d.asDays())}d`,
+      d.hours() && `${d.hours()}h`,
+      d.minutes() && `${d.minutes()}m`,
+    ].filter(Boolean);
 
-    return `${b.isBefore(a) ? '-' : ''}${diff}`;
+    return `${b.isBefore(a) ? '-' : ''}${parts.join(' ')}`;
   };
 
   // Simple, naive, e-mail address check.
diff --git a/frontend/src/views/Campaigns.vue b/frontend/src/views/Campaigns.vue
@@ -145,8 +145,7 @@
             <label for="#"><b-icon icon="speedometer" size="is-small" /></label>
             <span class="send-rate">
               <b-tooltip
-                :label="`${stats.netRate} / ${$t('campaigns.rateMinuteShort')} @
-                                                                                          ${$utils.duration(stats.startedAt, stats.updatedAt)}`"
+                :label="`${stats.netRate} / ${$t('campaigns.rateMinuteShort')} @ ${$utils.duration(stats.startedAt, stats.updatedAt)}`"
                 type="is-dark">
                 {{ stats.rate.toFixed(0) }} / {{ $t('campaigns.rateMinuteShort') }}
               </b-tooltip>
diff --git a/frontend/src/views/Subscribers.vue b/frontend/src/views/Subscribers.vue
@@ -9,6 +9,7 @@
           </span>
           <span v-if="currentList">
             &raquo; {{ currentList.name }}
+            <span v-if="queryParams.subStatus" class="has-text-grey has-text-weight-normal is-capitalized">({{ queryParams.subStatus }})</span>
           </span>
         </h1>
       </div>
@@ -452,7 +453,7 @@ export default Vue.extend({
           this.$api.deleteSubscribersByQuery({
             // If the query expression is empty, explicitly pass `all=true`
             // so that the backend deletes all records in the DB with an empty query string.
-            all: this.queryParams.queryExp.trim() === '',
+            all: this.queryParams.queryExp.trim() === '' && this.queryParams.search.trim() === '',
             search: this.queryParams.search,
             query: this.queryParams.queryExp,
             list_ids: this.queryParams.listID ? [this.queryParams.listID] : null,
@@ -527,6 +528,9 @@ export default Vue.extend({
     if (this.$route.params.listID) {
       this.queryParams.listID = parseInt(this.$route.params.listID, 10);
     }
+    if (this.$route.query.subscription_status) {
+      this.queryParams.subStatus = this.$route.query.subscription_status;
+    }
 
     if (this.$route.params.id) {
       this.$api.getSubscriber(parseInt(this.$route.params.id, 10)).then((data) => {
@@ -536,9 +540,6 @@ export default Vue.extend({
       // Get subscribers on load.
       this.querySubscribers();
     }
-    if (this.$route.query.subscription_status) {
-      this.queryParams.subStatus = this.$route.query.subscription_status;
-    }
   },
 });
 </script>
diff --git a/frontend/src/views/UserForm.vue b/frontend/src/views/UserForm.vue
@@ -45,7 +45,7 @@
         <b-field :label="$t('users.username')" label-position="on-border">
           <b-input :maxlength="200" v-model="form.username" name="username" ref="focus" autofocus
             :placeholder="$t('users.username')" required :message="$t('users.usernameHelp')" autocomplete="off"
-            pattern="[a-zA-Z0-9_\-\.]+$" />
+            pattern="[a-zA-Z0-9_\-\.@]+$" />
         </b-field>
 
         <b-field :label="$t('globals.fields.name')" label-position="on-border">
diff --git a/frontend/yarn.lock b/frontend/yarn.lock
@@ -4090,10 +4090,10 @@ verror@1.10.0:
     core-util-is "1.0.2"
     extsprintf "^1.2.0"
 
-vite@^5.4.18:
-  version "5.4.18"
-  resolved "https://registry.yarnpkg.com/vite/-/vite-5.4.18.tgz#b5af357f9d5ebb2e0c085779b7a37a77f09168a4"
-  integrity sha512-1oDcnEp3lVyHCuQ2YFelM4Alm2o91xNoMncRm1U7S+JdYfYOvbiGZ3/CxGttrOu2M/KcGz7cRC2DoNUA6urmMA==
+vite@^5.4.19:
+  version "5.4.19"
+  resolved "https://registry.yarnpkg.com/vite/-/vite-5.4.19.tgz#20efd060410044b3ed555049418a5e7d1998f959"
+  integrity sha512-qO3aKv3HoQC8QKiNSTuUM1l9o/XX3+c+VTgLHbJWHZGeTPVAg2XwazI9UWzoxjIJCGCV2zU60uqMzjeLZuULqA==
   dependencies:
     esbuild "^0.21.3"
     postcss "^8.4.43"
diff --git a/i18n/hu.json b/i18n/hu.json
@@ -158,14 +158,14 @@
     "globals.buttons.saveChanges": "Változtatások mentése",
     "globals.buttons.toggleSelect": "Kijelölés váltása",
     "globals.buttons.view": "Megtekintés",
-    "globals.days.0": "H",
-    "globals.days.1": "H",
-    "globals.days.2": "K",
-    "globals.days.3": "Sze",
-    "globals.days.4": "Cs",
-    "globals.days.5": "P",
-    "globals.days.6": "Szo",
-    "globals.days.7": "V",
+    "globals.days.0": "V",
+    "globals.days.1": "V",
+    "globals.days.2": "H",
+    "globals.days.3": "K",
+    "globals.days.4": "Sze",
+    "globals.days.5": "Cs",
+    "globals.days.6": "P",
+    "globals.days.7": "Szo",
     "globals.fields.createdAt": "Létrehozva",
     "globals.fields.description": "Leírás",
     "globals.fields.id": "Azonosító",
diff --git a/i18n/nl.json b/i18n/nl.json
diff --git a/internal/core/bounces.go b/internal/core/bounces.go
diff --git a/internal/manager/pipe.go b/internal/manager/pipe.go
diff --git a/models/models.go b/models/models.go

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		-{"version":"v5.0.0","date":"2025-04-28T19:00:04Z","url":"https://github.com/knadh/listmonk/releases/tag/v5.0.0","assets":[{"name":"darwin","url":"https://github.com/knadh/listmonk/releases/download/v5.0.0/listmonk_5.0.0_darwin_amd64.tar.gz"},{"name":"freebsd","url":"https://github.com/knadh/listmonk/releases/download/v5.0.0/listmonk_5.0.0_freebsd_amd64.tar.gz"},{"name":"linux","url":"https://github.com/knadh/listmonk/releases/download/v5.0.0/listmonk_5.0.0_linux_amd64.tar.gz"},{"name":"netbsd","url":"https://github.com/knadh/listmonk/releases/download/v5.0.0/listmonk_5.0.0_netbsd_amd64.tar.gz"},{"name":"openbsd","url":"https://github.com/knadh/listmonk/releases/download/v5.0.0/listmonk_5.0.0_openbsd_amd64.tar.gz"},{"name":"windows","url":"https://github.com/knadh/listmonk/releases/download/v5.0.0/listmonk_5.0.0_windows_amd64.tar.gz"}]}
	`1`	+{"version":"v5.0.1","date":"2025-05-25T09:59:32Z","url":"https://github.com/knadh/listmonk/releases/tag/v5.0.1","assets":[{"name":"darwin","url":"https://github.com/knadh/listmonk/releases/download/v5.0.1/listmonk_5.0.1_darwin_amd64.tar.gz"},{"name":"freebsd","url":"https://github.com/knadh/listmonk/releases/download/v5.0.1/listmonk_5.0.1_freebsd_amd64.tar.gz"},{"name":"linux","url":"https://github.com/knadh/listmonk/releases/download/v5.0.1/listmonk_5.0.1_linux_amd64.tar.gz"},{"name":"netbsd","url":"https://github.com/knadh/listmonk/releases/download/v5.0.1/listmonk_5.0.1_netbsd_amd64.tar.gz"},{"name":"openbsd","url":"https://github.com/knadh/listmonk/releases/download/v5.0.1/listmonk_5.0.1_openbsd_amd64.tar.gz"},{"name":"windows","url":"https://github.com/knadh/listmonk/releases/download/v5.0.1/listmonk_5.0.1_windows_amd64.tar.gz"}]}