Skip to content

feat: docker compose profiles #4606

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jr-k wants to merge 2 commits into
base: canary
Choose a base branch
from
Open

feat: docker compose profiles #4606

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b7ffa33
customizable compose workdir
jr-k Jun 8, 2026
b18f607
handle compose profiles
jr-k Jun 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
219 changes: 219 additions & 0 deletions apps/dokploy/components/dashboard/compose/advanced/add-profiles.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,219 @@
import { VALID_COMPOSE_PROFILE_REGEX } from "@dokploy/server/utils/compose/profiles";
import { standardSchemaResolver as zodResolver } from "@hookform/resolvers/standard-schema";
import { HelpCircle, X } from "lucide-react";
import { useEffect } from "react";
import { useForm } from "react-hook-form";
import { toast } from "sonner";
import { z } from "zod";
import { AlertBlock } from "@/components/shared/alert-block";
import { Badge } from "@/components/ui/badge";
import { Button } from "@/components/ui/button";
import {
Card,
CardContent,
CardDescription,
CardHeader,
CardTitle,
} from "@/components/ui/card";
import {
Form,
FormControl,
FormField,
FormItem,
FormLabel,
FormMessage,
} from "@/components/ui/form";
import { Input } from "@/components/ui/input";
import {
Tooltip,
TooltipContent,
TooltipProvider,
TooltipTrigger,
} from "@/components/ui/tooltip";
import { api } from "@/utils/api";

interface Props {
composeId: string;
}

const ProfilesSchema = z.object({
composeProfiles: z.array(
z
.string()
.regex(
VALID_COMPOSE_PROFILE_REGEX,
"Use only letters, digits, '-' and '_' (must start with a letter or digit)",
),
),
});

type ProfilesForm = z.infer<typeof ProfilesSchema>;

export const AddProfilesCompose = ({ composeId }: Props) => {
const utils = api.useUtils();
const { data, refetch } = api.compose.one.useQuery(
{ composeId },
{ enabled: !!composeId },
);

const { mutateAsync, isPending } = api.compose.update.useMutation();

const form = useForm<ProfilesForm>({
defaultValues: {
composeProfiles: [],
},
resolver: zodResolver(ProfilesSchema),
});

useEffect(() => {
if (data) {
form.reset({
composeProfiles: data.composeProfiles ?? [],
});
}
}, [data, form]);

const isStack = data?.composeType === "stack";

const addProfile = (raw: string) => {
const value = raw.trim();
if (!value) return;
if (!VALID_COMPOSE_PROFILE_REGEX.test(value)) {
toast.error(
"Invalid profile name (allowed: letters, digits, '-', '_')",
);
return;
}
const current = form.getValues("composeProfiles") ?? [];
if (current.includes(value)) return;
form.setValue("composeProfiles", [...current, value], {
shouldDirty: true,
});
};

const onSubmit = async (values: ProfilesForm) => {
await mutateAsync({
composeId,
composeProfiles: values.composeProfiles,
})
.then(async () => {
toast.success("Compose profiles updated");
await refetch();
await utils.compose.one.invalidate({ composeId });
await utils.compose.getDefaultCommand.invalidate({ composeId });
})
.catch(() => {
toast.error("Error updating compose profiles");
});
};

return (
<Card className="bg-background">
<CardHeader className="flex flex-row justify-between">
<div>
<CardTitle className="text-xl">Compose Profiles</CardTitle>
<CardDescription>
Activate one or more docker compose profiles. Only services that
belong to an activated profile (or no profile at all) will be
deployed.
</CardDescription>
</div>
</CardHeader>
<CardContent className="flex flex-col gap-4">
{isStack && (
<AlertBlock type="warning">
Compose profiles are not supported by Docker Swarm{" "}
<strong>stack deploy</strong>. Switch the compose type to{" "}
<strong>docker-compose</strong> for profiles to take effect.
</AlertBlock>
)}
<Form {...form}>
<form
onSubmit={form.handleSubmit(onSubmit)}
className="grid w-full gap-4"
>
<FormField
control={form.control}
name="composeProfiles"
render={({ field }) => (
<FormItem>
<div className="flex items-center gap-2">
<FormLabel>Active Profiles</FormLabel>
<TooltipProvider>
<Tooltip>
<TooltipTrigger asChild>
<HelpCircle className="size-4 text-muted-foreground hover:text-foreground transition-colors cursor-pointer" />
</TooltipTrigger>
<TooltipContent className="max-w-[320px]">
<p>
Each profile name passed here is forwarded to docker
compose as <code>--profile &lt;name&gt;</code>.
Services declared with a matching <code>profiles:</code>{" "}
entry will be started; services with no profile are
always started. Leave empty to deploy all services.
</p>
</TooltipContent>
</Tooltip>
</TooltipProvider>
</div>
<div className="flex flex-wrap gap-2 mb-2">
{field.value?.map((profile, index) => (
<Badge key={`${profile}-${index}`} variant="secondary">
{profile}
<X
className="ml-1 size-3 cursor-pointer"
onClick={() => {
const next = [...(field.value ?? [])];
next.splice(index, 1);
form.setValue("composeProfiles", next, {
shouldDirty: true,
});
}}
/>
</Badge>
))}
</div>
<FormControl>
<div className="flex gap-2">
<Input
placeholder="e.g. frontend, debug, gpu"
onKeyDown={(e) => {
if (e.key === "Enter" || e.key === ",") {
e.preventDefault();
const input = e.currentTarget;
addProfile(input.value);
input.value = "";
}
}}
/>
<Button
type="button"
variant="secondary"
onClick={(e) => {
const input = (
e.currentTarget.previousSibling as HTMLInputElement | null
);
if (!input) return;
addProfile(input.value);
input.value = "";
}}
>
Add
</Button>
</div>
</FormControl>
<FormMessage />
</FormItem>
)}
/>
<div className="flex justify-end">
<Button isLoading={isPending} type="submit" className="w-fit">
Save
</Button>
</div>
</form>
</Form>
</CardContent>
</Card>
);
};
43 changes: 42 additions & 1 deletion .../dokploy/components/dashboard/compose/general/generic/save-bitbucket-provider-compose.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { VALID_BRANCH_REGEX } from "@dokploy/server/utils/git-branch-validation";
import { standardSchemaResolver as zodResolver } from "@hookform/resolvers/standard-schema";
import { CheckIcon, ChevronsUpDown, X } from "lucide-react";
import { CheckIcon, ChevronsUpDown, HelpCircle, X } from "lucide-react";
import Link from "next/link";
import { useEffect } from "react";
import { useForm } from "react-hook-form";
Expand Down Expand Up @@ -51,6 +51,7 @@ import { api } from "@/utils/api";

const BitbucketProviderSchema = z.object({
composePath: z.string().min(1),
composeWorkingDir: z.string().optional(),
repository: z
.object({
repo: z.string().min(1, "Repo is required"),
Expand Down Expand Up @@ -84,6 +85,7 @@ export const SaveBitbucketProviderCompose = ({ composeId }: Props) => {
const form = useForm({
defaultValues: {
composePath: "./docker-compose.yml",
composeWorkingDir: "",
repository: {
owner: "",
repo: "",
Expand Down Expand Up @@ -141,6 +143,7 @@ export const SaveBitbucketProviderCompose = ({ composeId }: Props) => {
slug: data.bitbucketRepositorySlug || "",
},
composePath: data.composePath,
composeWorkingDir: data.composeWorkingDir || "",
bitbucketId: data.bitbucketId || "",
watchPaths: data.watchPaths || [],
enableSubmodules: data.enableSubmodules ?? false,
Expand All @@ -156,6 +159,7 @@ export const SaveBitbucketProviderCompose = ({ composeId }: Props) => {
bitbucketOwner: data.repository.owner,
bitbucketId: data.bitbucketId,
composePath: data.composePath,
composeWorkingDir: data.composeWorkingDir ?? "",
composeId,
sourceType: "bitbucket",
composeStatus: "idle",
Expand Down Expand Up @@ -413,6 +417,43 @@ export const SaveBitbucketProviderCompose = ({ composeId }: Props) => {
</FormItem>
)}
/>
<FormField
control={form.control}
name="composeWorkingDir"
render={({ field }) => (
<FormItem>
<div className="flex items-center gap-2">
<FormLabel>Working Directory</FormLabel>
<TooltipProvider>
<Tooltip>
<TooltipTrigger asChild>
<HelpCircle className="size-4 text-muted-foreground hover:text-foreground transition-colors cursor-pointer" />
</TooltipTrigger>
<TooltipContent className="max-w-[320px]">
<p>
Optional subdirectory (relative to the repository
root) from which docker compose will be launched.
Useful when the compose file relies on a local .env,
build contexts or volumes that are colocated inside
a subfolder. Leave empty to run from the repository
root.
</p>
</TooltipContent>
</Tooltip>
</TooltipProvider>
</div>
<FormControl>
<Input
placeholder="e.g. apps/my-app"
{...field}
value={field.value ?? ""}
/>
</FormControl>

<FormMessage />
</FormItem>
)}
/>
<FormField
control={form.control}
name="watchPaths"
Expand Down
41 changes: 41 additions & 0 deletions apps/dokploy/components/dashboard/compose/general/generic/save-git-provider-compose.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ import { api } from "@/utils/api";

const GitProviderSchema = z.object({
composePath: z.string().min(1),
composeWorkingDir: z.string().optional(),
repositoryURL: z.string().min(1, {
message: "Repository URL is required",
}),
Expand Down Expand Up @@ -69,6 +70,7 @@ export const SaveGitProviderCompose = ({ composeId }: Props) => {
branch: "",
repositoryURL: "",
composePath: "./docker-compose.yml",
composeWorkingDir: "",
sshKey: undefined,
watchPaths: [],
enableSubmodules: false,
Expand All @@ -83,6 +85,7 @@ export const SaveGitProviderCompose = ({ composeId }: Props) => {
branch: data.customGitBranch || "",
repositoryURL: data.customGitUrl || "",
composePath: data.composePath,
composeWorkingDir: data.composeWorkingDir || "",
watchPaths: data.watchPaths || [],
enableSubmodules: data.enableSubmodules ?? false,
});
Expand All @@ -97,6 +100,7 @@ export const SaveGitProviderCompose = ({ composeId }: Props) => {
composeId,
sourceType: "git",
composePath: values.composePath,
composeWorkingDir: values.composeWorkingDir ?? "",
composeStatus: "idle",
watchPaths: values.watchPaths || [],
enableSubmodules: values.enableSubmodules,
Expand Down Expand Up @@ -225,6 +229,43 @@ export const SaveGitProviderCompose = ({ composeId }: Props) => {
</FormItem>
)}
/>
<FormField
control={form.control}
name="composeWorkingDir"
render={({ field }) => (
<FormItem>
<div className="flex items-center gap-2">
<FormLabel>Working Directory</FormLabel>
<TooltipProvider>
<Tooltip>
<TooltipTrigger asChild>
<HelpCircle className="size-4 text-muted-foreground hover:text-foreground transition-colors cursor-pointer" />
</TooltipTrigger>
<TooltipContent className="max-w-[320px]">
<p>
Optional subdirectory (relative to the repository
root) from which docker compose will be launched.
Useful when the compose file relies on a local .env,
build contexts or volumes that are colocated inside a
subfolder. Leave empty to run from the repository
root.
</p>
</TooltipContent>
</Tooltip>
</TooltipProvider>
</div>
<FormControl>
<Input
placeholder="e.g. apps/my-app"
{...field}
value={field.value ?? ""}
/>
</FormControl>

<FormMessage />
</FormItem>
)}
/>
<FormField
control={form.control}
name="watchPaths"
Expand Down
Loading