Skip to content

Modern Docker Management, Designed for Everyone

feat: global compose and env defaults configuration (#617)

Kyle Mendell96dc4c6cdc60
diff --git a/backend/internal/api/template_handler.go b/backend/internal/api/template_handler.go
index 859d593f3..4e4eb9765 100644
--- a/backend/internal/api/template_handler.go
+++ b/backend/internal/api/template_handler.go
@@ -32,8 +32,8 @@ func NewTemplateHandler(group *gin.RouterGroup, templateService *services.Templa
apiGroup.PUT("/:id", handler.UpdateTemplate)
apiGroup.DELETE("/:id", handler.DeleteTemplate)
apiGroup.POST("/:id/download", handler.DownloadTemplate)
- apiGroup.GET("/env/default", handler.GetEnvTemplate)
- apiGroup.POST("/env/default", handler.SaveEnvTemplate)
+ apiGroup.GET("/default", handler.GetDefaultTemplates)
+ apiGroup.POST("/default", handler.SaveDefaultTemplates)
apiGroup.GET("/registries", handler.GetRegistries)
apiGroup.POST("/registries", handler.CreateRegistry)
apiGroup.PUT("/registries/:id", handler.UpdateRegistry)
@@ -316,17 +316,23 @@ func (h *TemplateHandler) DeleteTemplate(c *gin.Context) {
})
}
-func (h *TemplateHandler) GetEnvTemplate(c *gin.Context) {
- content := h.templateService.GetEnvTemplate()
+func (h *TemplateHandler) GetDefaultTemplates(c *gin.Context) {
+ composeTemplate := h.templateService.GetComposeTemplate()
+ envTemplate := h.templateService.GetEnvTemplate()
+
c.JSON(http.StatusOK, gin.H{
"success": true,
- "data": gin.H{"content": content},
+ "data": gin.H{
+ "composeTemplate": composeTemplate,
+ "envTemplate": envTemplate,
+ },
})
}
-func (h *TemplateHandler) SaveEnvTemplate(c *gin.Context) {
+func (h *TemplateHandler) SaveDefaultTemplates(c *gin.Context) {
var req struct {
- Content string `json:"content" binding:"required"`
+ ComposeContent string `json:"composeContent" binding:"required"`
+ EnvContent string `json:"envContent"`
}
if err := c.ShouldBindJSON(&req); err != nil {
c.JSON(http.StatusBadRequest, gin.H{
@@ -336,7 +342,15 @@ func (h *TemplateHandler) SaveEnvTemplate(c *gin.Context) {
return
}
- if err := h.templateService.SaveEnvTemplate(req.Content); err != nil {
+ if err := h.templateService.SaveComposeTemplate(req.ComposeContent); err != nil {
+ c.JSON(http.StatusInternalServerError, gin.H{
+ "success": false,
+ "data": gin.H{"error": "Failed to save compose template: " + err.Error()},
+ })
+ return
+ }
+
+ if err := h.templateService.SaveEnvTemplate(req.EnvContent); err != nil {
c.JSON(http.StatusInternalServerError, gin.H{
"success": false,
"data": gin.H{"error": "Failed to save env template: " + err.Error()},
@@ -346,7 +360,7 @@ func (h *TemplateHandler) SaveEnvTemplate(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{
"success": true,
- "data": gin.H{"message": "Environment template saved successfully"},
+ "data": gin.H{"message": "Default templates saved successfully"},
})
}
diff --git a/backend/internal/services/template_service.go b/backend/internal/services/template_service.go
index ae3682e2a..2a612a506 100644
--- a/backend/internal/services/template_service.go
+++ b/backend/internal/services/template_service.go
@@ -27,7 +27,6 @@ type remoteCache struct {
lastFetch time.Time
}
-// per-registry conditional GET metadata
type registryFetchMeta struct {
LastModified string
Templates []dto.RemoteTemplate
@@ -56,6 +55,12 @@ func NewTemplateService(db *database.DB, httpClient *http.Client) *TemplateServi
if httpClient == nil {
httpClient = http.DefaultClient
}
+
+ ctx := context.Background()
+ if err := appfs.EnsureDefaultTemplates(ctx); err != nil {
+ slog.WarnContext(ctx, "failed to ensure default templates", "error", err)
+ }
+
return &TemplateService{
db: db,
httpClient: httpClient,
@@ -171,7 +176,6 @@ func (s *TemplateService) UpdateTemplate(ctx context.Context, id string, updates
return fmt.Errorf("failed to find template: %w", err)
}
- // Only allow updating local templates
if existing.IsRemote {
return fmt.Errorf("cannot update remote template")
}
@@ -199,7 +203,6 @@ func (s *TemplateService) DeleteTemplate(ctx context.Context, id string) error {
return fmt.Errorf("failed to find template: %w", err)
}
- // Only allow deleting local templates
if existing.IsRemote {
return fmt.Errorf("cannot delete remote template directly")
}
@@ -214,13 +217,38 @@ func (s *TemplateService) DeleteTemplate(ctx context.Context, id string) error {
return nil
}
+func (s *TemplateService) GetComposeTemplate() string {
+ composePath := filepath.Join("data", "templates", ".compose.template")
+ content, err := os.ReadFile(composePath)
+ if err != nil {
+ slog.Warn("failed to read compose template", "error", err)
+ return ""
+ }
+ return string(content)
+}
+
+func (s *TemplateService) SaveComposeTemplate(content string) error {
+ templateDir := filepath.Join("data", "templates")
+ if err := os.MkdirAll(templateDir, 0755); err != nil {
+ return fmt.Errorf("failed to create template directory: %w", err)
+ }
+
+ composePath := filepath.Join(templateDir, ".compose.template")
+ if err := os.WriteFile(composePath, []byte(content), 0600); err != nil {
+ return fmt.Errorf("failed to save compose template: %w", err)
+ }
+
+ return nil
+}
+
func (s *TemplateService) GetEnvTemplate() string {
envPath := filepath.Join("data", "templates", ".env.template")
- if content, err := os.ReadFile(envPath); err == nil {
- return string(content)
+ content, err := os.ReadFile(envPath)
+ if err != nil {
+ slog.Warn("failed to read env template", "error", err)
+ return ""
}
-
- return s.getDefaultEnvTemplate()
+ return string(content)
}
func (s *TemplateService) SaveEnvTemplate(content string) error {
@@ -483,28 +511,6 @@ func (s *TemplateService) convertRemoteToLocal(remote dto.RemoteTemplate, regist
}
}
-func (s *TemplateService) getDefaultEnvTemplate() string {
- return `# Environment Variables
-# These variables will be available to your project services
-# Format: VARIABLE_NAME=value
-
-# Web Server Configuration
-NGINX_HOST=localhost
-NGINX_PORT=80
-
-# Database Configuration
-POSTGRES_DB=myapp
-POSTGRES_USER=myuser
-POSTGRES_PASSWORD=mypassword
-POSTGRES_PORT=5432
-
-# Example Additional Variables
-# API_KEY=your_api_key_here
-# SECRET_KEY=your_secret_key_here
-# DEBUG=false
-`
-}
-
func (s *TemplateService) FetchTemplateContent(ctx context.Context, template *models.ComposeTemplate) (string, string, error) {
if !template.IsRemote || template.Metadata == nil || template.Metadata.RemoteURL == nil {
return template.Content, "", fmt.Errorf("not a remote template or missing remote URL")
diff --git a/backend/internal/utils/fs/fs_templates.go b/backend/internal/utils/fs/fs_templates.go
index f3e45b7bd..162c7c497 100644
--- a/backend/internal/utils/fs/fs_templates.go
+++ b/backend/internal/utils/fs/fs_templates.go
@@ -80,3 +80,70 @@ func WriteTemplateFiles(composePath, envPath, composeContent, envContent string)
}
return &envContent, nil
}
+
+func EnsureDefaultTemplates(ctx context.Context) error {
+ templatesDir, err := GetTemplatesDirectory(ctx)
+ if err != nil {
+ return fmt.Errorf("get templates directory: %w", err)
+ }
+
+ composePath := filepath.Join(templatesDir, ".compose.template")
+ envPath := filepath.Join(templatesDir, ".env.template")
+
+ // Write default compose template if it doesn't exist
+ if _, err := os.Stat(composePath); os.IsNotExist(err) {
+ if err := os.WriteFile(composePath, []byte(getDefaultComposeTemplate()), 0600); err != nil {
+ return fmt.Errorf("write default compose template: %w", err)
+ }
+ }
+
+ // Write default env template if it doesn't exist
+ if _, err := os.Stat(envPath); os.IsNotExist(err) {
+ if err := os.WriteFile(envPath, []byte(getDefaultEnvTemplate()), 0600); err != nil {
+ return fmt.Errorf("write default env template: %w", err)
+ }
+ }
+
+ return nil
+}
+
+func getDefaultComposeTemplate() string {
+ return `services:
+ nginx:
+ image: nginx:alpine
+ container_name: nginx_service
+ env_file:
+ - .env
+ ports:
+ - "8080:80"
+ volumes:
+ - nginx_data:/usr/share/nginx/html
+ restart: unless-stopped
+
+volumes:
+ nginx_data:
+ driver: local
+`
+}
+
+func getDefaultEnvTemplate() string {
+ return `# Environment Variables
+# These variables will be available to your project services
+# Format: VARIABLE_NAME=value
+
+# Web Server Configuration
+NGINX_HOST=localhost
+NGINX_PORT=80
+
+# Database Configuration
+POSTGRES_DB=myapp
+POSTGRES_USER=myuser
+POSTGRES_PASSWORD=mypassword
+POSTGRES_PORT=5432
+
+# Example Additional Variables
+# API_KEY=your_api_key_here
+# SECRET_KEY=your_secret_key_here
+# DEBUG=false
+`
+}
diff --git a/frontend/messages/en.json b/frontend/messages/en.json
index caa367a62..55f0416a6 100644
--- a/frontend/messages/en.json
+++ b/frontend/messages/en.json
@@ -1195,5 +1195,15 @@
"apply": "Apply",
"terminal_websocket_error": "WebSocket error occurred",
"terminal_connection_closed": "Connection closed",
- "shell": "Shell"
+ "shell": "Shell",
+ "customize_defaults_title": "Customize Default Templates",
+ "customize_defaults_heading": "Default Templates Configuration",
+ "customize_defaults_description": "Customize the default Docker Compose and environment templates used when creating new projects. These templates will be pre-populated in the new project form.",
+ "customize_compose_template_label": "Docker Compose Template (YAML)",
+ "customize_env_template_label": "Environment Template (.env)",
+ "customize_validation_error": "Please fix validation errors before saving",
+ "customize_save_failed": "Failed to save default templates",
+ "customize_save_success": "Default templates saved successfully",
+ "customize_reset_success": "Changes reset",
+ "default_templates": "Default Templates"
}
diff --git a/frontend/src/lib/config/navigation-config.ts b/frontend/src/lib/config/navigation-config.ts
index c9beab9b4..fcd79ce36 100644
--- a/frontend/src/lib/config/navigation-config.ts
+++ b/frontend/src/lib/config/navigation-config.ts
@@ -14,6 +14,7 @@ import ComputerIcon from '@lucide/svelte/icons/computer';
import LockKeyholeIcon from '@lucide/svelte/icons/lock-keyhole';
import AlarmClockIcon from '@lucide/svelte/icons/alarm-clock';
import NavigationIcon from '@lucide/svelte/icons/navigation';
+import PaletteIcon from '@lucide/svelte/icons/palette';
import { m } from '$lib/paraglide/messages';
export type NavigationItem = {
@@ -33,6 +34,11 @@ export const navigationItems: Record<string, NavigationItem[]> = {
{ title: m.volumes_title(), url: '/volumes', icon: HardDriveIcon }
],
customizationItems: [
+ {
+ title: m.default_templates(),
+ url: '/customize/defaults',
+ icon: PaletteIcon
+ },
{
title: m.templates_title(),
url: '/customize/templates',
diff --git a/frontend/src/lib/constants.ts b/frontend/src/lib/constants.ts
index e1a2af0e7..0a199a3d6 100644
--- a/frontend/src/lib/constants.ts
+++ b/frontend/src/lib/constants.ts
@@ -1,18 +1 @@
-export const defaultComposeTemplate = `services:
- nginx:
- image: nginx:alpine
- container_name: nginx_service
- env_file:
- - .env
- ports:
- - "8080:80"
- volumes:
- - nginx_data:/usr/share/nginx/html
- restart: unless-stopped
-
-volumes:
- nginx_data:
- driver: local
-`;
-
export const DEFAULT_NETWORK_NAMES = new Set(['host', 'bridge', 'none', 'ingress']);
diff --git a/frontend/src/lib/services/template-service.ts b/frontend/src/lib/services/template-service.ts
index b1fd04fba..ff275844a 100644
--- a/frontend/src/lib/services/template-service.ts
+++ b/frontend/src/lib/services/template-service.ts
@@ -27,13 +27,20 @@ export default class TemplateService extends BaseAPIService {
return response.data?.data;
}
- async getEnvTemplate(): Promise<string> {
- const response = await this.api.get('/templates/env/default');
- return response.data?.data?.content ?? response.data?.content;
+ async getDefaultTemplates(): Promise<{ composeTemplate: string; envTemplate: string }> {
+ const response = await this.api.get('/templates/default');
+ const data = response.data?.data;
+ return {
+ composeTemplate: data?.composeTemplate ?? '',
+ envTemplate: data?.envTemplate ?? ''
+ };
}
- async saveEnvTemplate(content: string): Promise<void> {
- await this.api.post('/templates/env/default', { content });
+ async saveDefaultTemplates(composeContent: string, envContent: string): Promise<void> {
+ await this.api.post('/templates/default', {
+ composeContent,
+ envContent
+ });
}
async getRegistries(): Promise<TemplateRegistry[]> {
diff --git a/frontend/src/routes/customize/defaults/+page.svelte b/frontend/src/routes/customize/defaults/+page.svelte
new file mode 100644
index 000000000..0115252a1
--- /dev/null
+++ b/frontend/src/routes/customize/defaults/+page.svelte
@@ -0,0 +1,132 @@
+<script lang="ts">
+ import { Label } from '$lib/components/ui/label/index.js';
+ import { toast } from 'svelte-sonner';
+ import CodeEditor from '$lib/components/code-editor/editor.svelte';
+ import { createForm } from '$lib/utils/form.utils';
+ import { tryCatch } from '$lib/utils/try-catch';
+ import { handleApiResultWithCallbacks } from '$lib/utils/api.util';
+ import { m } from '$lib/paraglide/messages';
+ import { templateService } from '$lib/services/template-service';
+ import { z } from 'zod/v4';
+ import { ResourcePageLayout, type ActionButton } from '$lib/layouts/index.js';
+
+ let { data } = $props();
+
+ let saving = $state(false);
+ let originalComposeContent = $state(data.composeTemplate);
+ let originalEnvContent = $state(data.envTemplate);
+
+ const formSchema = z.object({
+ composeContent: z.string().min(1, m.compose_compose_content_required()),
+ envContent: z.string().optional().default('')
+ });
+
+ let formData = $derived({
+ composeContent: originalComposeContent,
+ envContent: originalEnvContent
+ });
+
+ let { inputs, ...form } = $derived(createForm<typeof formSchema>(formSchema, formData));
+
+ const hasChanges = $derived(
+ $inputs.composeContent.value !== originalComposeContent || $inputs.envContent.value !== originalEnvContent
+ );
+
+ async function handleSave() {
+ const validated = form.validate();
+ if (!validated) {
+ toast.error(m.customize_validation_error());
+ return;
+ }
+
+ const { composeContent, envContent } = validated;
+
+ handleApiResultWithCallbacks({
+ result: await tryCatch(templateService.saveDefaultTemplates(composeContent, envContent)),
+ message: m.customize_save_failed(),
+ setLoadingState: (value) => (saving = value),
+ onSuccess: async () => {
+ toast.success(m.customize_save_success());
+ originalComposeContent = $inputs.composeContent.value;
+ originalEnvContent = $inputs.envContent.value;
+ }
+ });
+ }
+
+ async function handleReset() {
+ $inputs.composeContent.value = originalComposeContent;
+ $inputs.envContent.value = originalEnvContent;
+ toast.info(m.customize_reset_success());
+ }
+
+ const actionButtons = $derived<ActionButton[]>([
+ {
+ id: 'reset',
+ action: 'restart',
+ label: m.common_reset(),
+ onclick: handleReset,
+ disabled: !hasChanges
+ },
+ {
+ id: 'save',
+ action: 'save',
+ label: m.common_save(),
+ loadingLabel: m.common_saving(),
+ loading: saving,
+ disabled: saving || !hasChanges,
+ onclick: handleSave
+ }
+ ]);
+</script>
+
+<ResourcePageLayout title={m.customize_defaults_title()} subtitle={m.customize_defaults_description()} {actionButtons}>
+ {#snippet mainContent()}
+ <div class="space-y-6">
+ <form class="space-y-6">
+ <div class="grid grid-cols-1 gap-6 lg:grid-cols-3">
+ <div class="lg:col-span-2">
+ <div class="space-y-2">
+ <Label for="compose" class="text-sm font-medium">
+ {m.customize_compose_template_label()}
+ </Label>
+ <div
+ class="border-input focus-within:border-primary focus-within:ring-ring relative rounded-md border bg-transparent transition-colors focus-within:ring-2 focus-within:ring-offset-2"
+ class:border-destructive={$inputs.composeContent.error}
+ >
+ <div class="min-h-[500px] w-full overflow-hidden">
+ <CodeEditor bind:value={$inputs.composeContent.value} language="yaml" height="full" />
+ </div>
+ </div>
+ {#if $inputs.composeContent.error}
+ <p class="text-destructive text-xs">
+ {$inputs.composeContent.error}
+ </p>
+ {/if}
+ </div>
+ </div>
+
+ <div class="lg:col-span-1">
+ <div class="space-y-2">
+ <Label for="env" class="text-sm font-medium">
+ {m.customize_env_template_label()}
+ </Label>
+ <div
+ class="border-input focus-within:border-primary focus-within:ring-ring relative rounded-md border bg-transparent transition-colors focus-within:ring-2 focus-within:ring-offset-2"
+ class:border-destructive={$inputs.envContent.error}
+ >
+ <div class="min-h-[500px] w-full overflow-hidden">
+ <CodeEditor bind:value={$inputs.envContent.value} language="env" height="full" />
+ </div>
+ </div>
+ {#if $inputs.envContent.error}
+ <p class="text-destructive text-xs">
+ {$inputs.envContent.error}
+ </p>
+ {/if}
+ </div>
+ </div>
+ </div>
+ </form>
+ </div>
+ {/snippet}
+</ResourcePageLayout>
diff --git a/frontend/src/routes/customize/defaults/+page.ts b/frontend/src/routes/customize/defaults/+page.ts
new file mode 100644
index 000000000..c24bb3a9b
--- /dev/null
+++ b/frontend/src/routes/customize/defaults/+page.ts
@@ -0,0 +1,13 @@
+import { templateService } from '$lib/services/template-service';
+
+export const load = async () => {
+ const defaultTemplates = await templateService.getDefaultTemplates().catch((err) => {
+ console.warn('Failed to load default templates:', err);
+ return { composeTemplate: '', envTemplate: '' };
+ });
+
+ return {
+ composeTemplate: defaultTemplates.composeTemplate,
+ envTemplate: defaultTemplates.envTemplate
+ };
+};
diff --git a/frontend/src/routes/projects/new/+page.svelte b/frontend/src/routes/projects/new/+page.svelte
index ea5292b99..7180ab92a 100644
--- a/frontend/src/routes/projects/new/+page.svelte
+++ b/frontend/src/routes/projects/new/+page.svelte
@@ -14,7 +14,6 @@
import { preventDefault, createForm } from '$lib/utils/form.utils';
import { tryCatch } from '$lib/utils/try-catch';
import { handleApiResultWithCallbacks } from '$lib/utils/api.util';
- import { defaultComposeTemplate } from '$lib/constants';
import { Textarea } from '$lib/components/ui/textarea/index.js';
import * as Dialog from '$lib/components/ui/dialog/index.js';
import TemplateSelectionDialog from '$lib/components/dialogs/template-selection-dialog.svelte';
@@ -46,7 +45,7 @@
let formData = $derived({
name: '',
- composeContent: data.defaultTemplate || defaultComposeTemplate,
+ composeContent: data.defaultTemplate || '',
envContent: data.envTemplate || ''
});
diff --git a/frontend/src/routes/projects/new/+page.ts b/frontend/src/routes/projects/new/+page.ts
index e1527dea2..e1119ddf8 100644
--- a/frontend/src/routes/projects/new/+page.ts
+++ b/frontend/src/routes/projects/new/+page.ts
@@ -1,21 +1,20 @@
-import { defaultComposeTemplate } from '$lib/constants';
import { templateService } from '$lib/services/template-service';
export const load = async () => {
- const [allTemplates, envTemplate] = await Promise.all([
+ const [allTemplates, defaultTemplates] = await Promise.all([
templateService.loadAll().catch((err) => {
console.warn('Failed to load templates:', err);
return [];
}),
- templateService.getEnvTemplate().catch((err) => {
- console.warn('Failed to load env template:', err);
- return '';
+ templateService.getDefaultTemplates().catch((err) => {
+ console.warn('Failed to load default templates:', err);
+ return { composeTemplate: '', envTemplate: '' };
})
]);
return {
composeTemplates: allTemplates,
- envTemplate,
- defaultTemplate: defaultComposeTemplate
+ envTemplate: defaultTemplates.envTemplate,
+ defaultTemplate: defaultTemplates.composeTemplate
};
};