From 7a48c2fe4104869439bbff7ee720bcf2419cea9c Mon Sep 17 00:00:00 2001 From: ShareVB Date: Sun, 11 May 2025 21:19:52 +0200 Subject: [PATCH] feat(new tool): Traefik Compose Maker Fix #639 --- src/tools/traefik-compose-maker/index.ts | 13 +++ .../traefik-compose-maker.service.test.ts | 88 +++++++++++++++++++ .../traefik-compose-maker.service.ts | 76 ++++++++++++++++ .../traefik-compose-maker.vue | 83 +++++++++++++++++ 4 files changed, 260 insertions(+) create mode 100644 src/tools/traefik-compose-maker/index.ts create mode 100644 src/tools/traefik-compose-maker/traefik-compose-maker.service.test.ts create mode 100644 src/tools/traefik-compose-maker/traefik-compose-maker.service.ts create mode 100644 src/tools/traefik-compose-maker/traefik-compose-maker.vue diff --git a/src/tools/traefik-compose-maker/index.ts b/src/tools/traefik-compose-maker/index.ts new file mode 100644 index 00000000..490c3ab5 --- /dev/null +++ b/src/tools/traefik-compose-maker/index.ts @@ -0,0 +1,13 @@ +import { NetworkCheckSharp } from '@vicons/material'; +import { defineTool } from '../tool'; + +export const tool = defineTool({ + name: 'Traefik Docker Compose Maker', + path: '/traefik-compose-maker', + description: 'Create a docker compose with Traefik labels ready for a given service and options', + keywords: ['traefik', 'docker', 'compose'], + component: () => import('./traefik-compose-maker.vue'), + icon: NetworkCheckSharp, + createdAt: new Date('2024-03-30'), + category: 'Docker', +}); diff --git a/src/tools/traefik-compose-maker/traefik-compose-maker.service.test.ts b/src/tools/traefik-compose-maker/traefik-compose-maker.service.test.ts new file mode 100644 index 00000000..29da2243 --- /dev/null +++ b/src/tools/traefik-compose-maker/traefik-compose-maker.service.test.ts @@ -0,0 +1,88 @@ +import { describe, expect, it } from 'vitest'; +import type { TraefikComposeOptions } from './traefik-compose-maker.service'; +import { generateCompose } from './traefik-compose-maker.service'; + +const defaultConfig: TraefikComposeOptions = { + logDebug: false, + certResolverName: 'letsencrypt', + postmasterEmail: 'admin@example.com', + letEncryptTest: false, + dashboard: false, + traefikDashboardHostName: '', + dashboardUserAndPass: '', + proxiedServiceName: 'webapp', + proxiedServiceImage: 'nginx:latest', + proxiedServiceLoadBalancePort: 8080, + proxiedServiceHostName: 'example.com', + loadBalance: false, +}; + +describe('generateCompose', () => { + it('should generate compose YAML with default settings', () => { + const result = generateCompose(defaultConfig); + + expect(result).toBe(` +version: \"3.3\" +services: + traefik: + image: \"traefik:v2.11\" + container_name: \"traefik\" + command: + + - \"--api=true\" + - \"--providers.docker=true\" + - \"--providers.docker.exposedbydefault=false\" + - \"--entrypoints.web.address=:80\" + - \"--entrypoints.websecure.address=:443\" + - \"--certificatesresolvers.letsencrypt.acme.httpchallenge=true\" + - \"--certificatesresolvers.letsencrypt.acme.httpchallenge.entrypoint=web\" + + - \"--certificatesresolvers.letsencrypt.acme.email=admin@example.com\" + - \"--certificatesresolvers.letsencrypt.acme.storage=/letsencrypt/acme.json\" + labels: + + ports: + - \"80:80\" + - \"443:443\" + volumes: + - \"./letsencrypt:/letsencrypt\" + - \"/var/run/docker.sock:/var/run/docker.sock:ro\" + + webapp: + image: nginx:latest + labels: + - \"traefik.enable=true\" + - \"traefik.http.middlewares.webapp-redirect.redirectscheme.scheme=https\" + - \"traefik.http.middlewares.webapp-redirect.redirectscheme.permanent=true\" + + - \"traefik.http.routers.webapp.rule=Host(\`example.com\`)\" + - \"traefik.http.routers.webapp.entrypoints=web\" + - \"traefik.http.routers.webapp-secure.rule=Host(\`example.com\`)\" + - \"traefik.http.routers.webapp-secure.entrypoints=websecure\" + - \"traefik.http.routers.webapp-secure.tls=true\" + - \"traefik.http.routers.webapp-secure.tls.certresolver=letsencrypt\" + `); + }); + + it('should include debug logging when enabled', () => { + const config: TraefikComposeOptions = { + ...defaultConfig, + logDebug: true, + }; + + const result = generateCompose(config); + expect(result).toContain('--log.level=DEBUG'); + }); + + it('should enable load balancing when configured', () => { + const config: TraefikComposeOptions = { + ...defaultConfig, + loadBalance: true, + }; + + const result = generateCompose(config); + expect(result).toContain( + `traefik.http.services.webapp.loadbalancer.server.port=${config.proxiedServiceLoadBalancePort}`, + ); + }); +}); diff --git a/src/tools/traefik-compose-maker/traefik-compose-maker.service.ts b/src/tools/traefik-compose-maker/traefik-compose-maker.service.ts new file mode 100644 index 00000000..5947b37a --- /dev/null +++ b/src/tools/traefik-compose-maker/traefik-compose-maker.service.ts @@ -0,0 +1,76 @@ +export interface TraefikComposeOptions { + logDebug: boolean + certResolverName: string + postmasterEmail: string + letEncryptTest: boolean + dashboard: boolean + traefikDashboardHostName: string + dashboardUserAndPass: string + proxiedServiceName: string + proxiedServiceImage: string + proxiedServiceLoadBalancePort: number + proxiedServiceHostName: string + loadBalance: boolean +} + +/** + * Generates Docker Compose configuration based on form input. + * @param config Configuration object + * @returns Docker Compose YAML string + */ +export function generateCompose(config: TraefikComposeOptions): string { + if (config.proxiedServiceName === '' + || config.proxiedServiceImage === '' + || config.proxiedServiceHostName === '') { + return ''; + } + + return ` +version: "3.3" +services: + traefik: + image: "traefik:v2.11" + container_name: "traefik" + command: + ${config.logDebug ? '- "--log.level=DEBUG"' : ''} + - "--api=true" + - "--providers.docker=true" + - "--providers.docker.exposedbydefault=false" + - "--entrypoints.web.address=:80" + - "--entrypoints.websecure.address=:443" + - "--certificatesresolvers.${config.certResolverName}.acme.httpchallenge=true" + - "--certificatesresolvers.${config.certResolverName}.acme.httpchallenge.entrypoint=web" + ${config.letEncryptTest ? `- "--certificatesresolvers.${config.certResolverName}.acme.caserver=https://acme-staging-v02.api.letsencrypt.org/directory"` : ''} + - "--certificatesresolvers.${config.certResolverName}.acme.email=${config.postmasterEmail}" + - "--certificatesresolvers.${config.certResolverName}.acme.storage=/letsencrypt/acme.json" + labels: + ${config.dashboard +? ` + - "traefik.http.routers.dashboard.rule=Host(\`${config.traefikDashboardHostName}\`) && (PathPrefix('/api') || PathPrefix('/dashboard'))" + - "traefik.http.routers.dashboard.service=api@internal" + - "traefik.http.routers.dashboard.middlewares=auth" + - "traefik.http.middlewares.auth.basicauth.users=${config.dashboardUserAndPass}" + ` +: ''} + ports: + - "80:80" + - "443:443" + volumes: + - "./letsencrypt:/letsencrypt" + - "/var/run/docker.sock:/var/run/docker.sock:ro" + + ${config.proxiedServiceName}: + image: ${config.proxiedServiceImage} + labels: + - "traefik.enable=true" + - "traefik.http.middlewares.${config.proxiedServiceName}-redirect.redirectscheme.scheme=https" + - "traefik.http.middlewares.${config.proxiedServiceName}-redirect.redirectscheme.permanent=true" + ${config.loadBalance ? `- "traefik.http.services.${config.proxiedServiceName}.loadbalancer.server.port=${config.proxiedServiceLoadBalancePort}"` : ''} + - "traefik.http.routers.${config.proxiedServiceName}.rule=Host(\`${config.proxiedServiceHostName}\`)" + - "traefik.http.routers.${config.proxiedServiceName}.entrypoints=web" + - "traefik.http.routers.${config.proxiedServiceName}-secure.rule=Host(\`${config.proxiedServiceHostName}\`)" + - "traefik.http.routers.${config.proxiedServiceName}-secure.entrypoints=websecure" + - "traefik.http.routers.${config.proxiedServiceName}-secure.tls=true" + - "traefik.http.routers.${config.proxiedServiceName}-secure.tls.certresolver=${config.certResolverName}" + `; +} diff --git a/src/tools/traefik-compose-maker/traefik-compose-maker.vue b/src/tools/traefik-compose-maker/traefik-compose-maker.vue new file mode 100644 index 00000000..8b7ac060 --- /dev/null +++ b/src/tools/traefik-compose-maker/traefik-compose-maker.vue @@ -0,0 +1,83 @@ + + +