feat(new tool): Traefik Compose Maker

Fix #639
This commit is contained in:
ShareVB committed 2025-05-11 21:19:52 +02:00
1 parent 665db9b9ec
commit 7a48c2fe41
4 files changed
+260

No files matched your search

+13
View File
@@ -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',
});
@@ -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}`,
);
});
});
@@ -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}"
`;
}
@@ -0,0 +1,83 @@
<script setup lang="ts">
import type { TraefikComposeOptions } from './traefik-compose-maker.service';
import { generateCompose } from './traefik-compose-maker.service';
const formModel = ref<TraefikComposeOptions>({
logDebug: false,
certResolverName: '',
postmasterEmail: '',
letEncryptTest: false,
dashboard: false,
traefikDashboardHostName: '',
dashboardUserAndPass: '',
proxiedServiceName: '',
proxiedServiceImage: '',
proxiedServiceLoadBalancePort: 80,
proxiedServiceHostName: '',
loadBalance: false,
});
const dockerComposeEntry = computed<string>(() => generateCompose(formModel.value));
</script>
<template>
<n-card title="Traefik Docker Compose Generator">
<n-form :model="formModel" label-placement="left">
<n-form-item label="Proxied Service Name:">
<n-input v-model:value="formModel.proxiedServiceName" placeholder="Enter service name" />
</n-form-item>
<n-form-item label="Proxied Service Image:">
<n-input v-model:value="formModel.proxiedServiceImage" placeholder="Enter image name" />
</n-form-item>
<n-form-item label="Proxied Service Host Name:">
<n-input v-model:value="formModel.proxiedServiceHostName" placeholder="Enter service hostname" />
</n-form-item>
<n-space>
<n-form-item label="Proxied Service Load Balancer Port:">
<n-input-number v-model:value="formModel.proxiedServiceLoadBalancePort" placeholder="Enter port" />
</n-form-item>
<n-form-item label="Enable Load Balancer">
<n-switch v-model:value="formModel.loadBalance" />
</n-form-item>
</n-space>
<n-form-item label="Cert Resolver Name:">
<n-input v-model:value="formModel.certResolverName" placeholder="Enter cert resolver name" />
</n-form-item>
<n-form-item label="Postmaster Email:">
<n-input v-model:value="formModel.postmasterEmail" placeholder="Enter email" />
</n-form-item>
<n-space>
<n-form-item label="Let's Encrypt Test Mode">
<n-switch v-model:value="formModel.letEncryptTest" />
</n-form-item>
<n-form-item label="Enable Dashboard">
<n-switch v-model:value="formModel.dashboard" />
</n-form-item>
<n-form-item label="Log Level (DEBUG)">
<n-switch v-model:value="formModel.logDebug" />
</n-form-item>
</n-space>
<n-form-item label="Traefik Dashboard Host Name:">
<n-input v-model:value="formModel.traefikDashboardHostName" placeholder="Enter dashboard host name" />
</n-form-item>
<n-form-item label="Dashboard User and Password:">
<n-input v-model:value="formModel.dashboardUserAndPass" placeholder="User:Password" />
</n-form-item>
<n-card v-if="dockerComposeEntry" title="Generated Compose Entry">
<textarea-copyable :value="dockerComposeEntry" language="yaml" />
</n-card>
</n-form>
</n-card>
</template>