-
- 
-
-
-
-
-
-
-
-
+
+
+ 
-Join us on Discord for help, feedback, and discussions!
+
+
+
+
+ Join us on Discord for help, feedback, and discussions!
-
-
+
+
+ Join us on Discord for help, feedback, and discussions!
+
+
+### [Tuple, the premier screen sharing app for developers](https://tuple.app/dokploy)
+[Available for MacOS & Windows](https://tuple.app/dokploy)
-
-
- 
-
-
- 
-
-
- 
-
-
-
+
+
-
+
-
- 
-
+### Premium Supporters ๐ฅ
+
+
-
-
-
-
-
-
-
-
+### Elite Contributors ๐ฅ
+
+ 
-
-
+
+
+
-## Contributing
+## ๐ค Contributing
Check out the [Contributing Guide](CONTRIBUTING.md) for more information.
diff --git a/apps/api/package.json b/apps/api/package.json
index 65f9d4ad95..dfc2a355d1 100644
--- a/apps/api/package.json
+++ b/apps/api/package.json
@@ -9,25 +9,30 @@
"typecheck": "tsc --noEmit"
},
"dependencies": {
+ "inngest": "3.40.1",
"@dokploy/server": "workspace:*",
- "@hono/node-server": "^1.12.1",
+ "@hono/node-server": "^1.14.3",
"@hono/zod-validator": "0.3.0",
"@nerimity/mimiqueue": "1.2.3",
- "dotenv": "^16.3.1",
- "hono": "^4.5.8",
+ "dotenv": "^16.4.5",
+ "hono": "^4.7.10",
"pino": "9.4.0",
"pino-pretty": "11.2.2",
"react": "18.2.0",
"react-dom": "18.2.0",
"redis": "4.7.0",
- "zod": "^3.23.4"
+ "zod": "^3.25.32"
},
"devDependencies": {
- "@types/node": "^20.11.17",
+ "@types/node": "^20.17.51",
"@types/react": "^18.2.37",
"@types/react-dom": "^18.2.15",
- "tsx": "^4.7.1",
- "typescript": "^5.4.2"
+ "tsx": "^4.16.2",
+ "typescript": "^5.8.3"
},
- "packageManager": "pnpm@9.5.0"
+ "packageManager": "pnpm@9.12.0",
+ "engines": {
+ "node": "^20.16.0",
+ "pnpm": ">=9.12.0"
+ }
}
diff --git a/apps/api/src/index.ts b/apps/api/src/index.ts
index 0db5659950..8ddb56dec0 100644
--- a/apps/api/src/index.ts
+++ b/apps/api/src/index.ts
@@ -2,21 +2,90 @@ import { serve } from "@hono/node-server";
import { Hono } from "hono";
import "dotenv/config";
import { zValidator } from "@hono/zod-validator";
-import { Queue } from "@nerimity/mimiqueue";
-import { createClient } from "redis";
+import { Inngest } from "inngest";
+import { serve as serveInngest } from "inngest/hono";
import { logger } from "./logger.js";
-import { type DeployJob, deployJobSchema } from "./schema.js";
+import {
+ cancelDeploymentSchema,
+ type DeployJob,
+ deployJobSchema,
+} from "./schema.js";
import { deploy } from "./utils.js";
const app = new Hono();
-const redisClient = createClient({
- url: process.env.REDIS_URL,
+
+// Initialize Inngest client
+export const inngest = new Inngest({
+ id: "dokploy-deployments",
+ name: "Dokploy Deployment Service",
});
+export const deploymentFunction = inngest.createFunction(
+ {
+ id: "deploy-application",
+ name: "Deploy Application",
+ concurrency: [
+ {
+ key: "event.data.serverId",
+ limit: 1,
+ },
+ ],
+ retries: 0,
+ cancelOn: [
+ {
+ event: "deployment/cancelled",
+ if: "async.data.applicationId == event.data.applicationId || async.data.composeId == event.data.composeId",
+ timeout: "1h", // Allow cancellation for up to 1 hour
+ },
+ ],
+ },
+ { event: "deployment/requested" },
+
+ async ({ event, step }) => {
+ const jobData = event.data as DeployJob;
+
+ return await step.run("execute-deployment", async () => {
+ logger.info("Deploying started");
+
+ try {
+ const result = await deploy(jobData);
+ logger.info("Deployment finished", result);
+
+ // Send success event
+ await inngest.send({
+ name: "deployment/completed",
+ data: {
+ ...jobData,
+ result,
+ status: "success",
+ },
+ });
+
+ return result;
+ } catch (error) {
+ logger.error("Deployment failed", { jobData, error });
+
+ // Send failure event
+ await inngest.send({
+ name: "deployment/failed",
+ data: {
+ ...jobData,
+ error: error instanceof Error ? error.message : String(error),
+ status: "failed",
+ },
+ });
+
+ throw error;
+ }
+ });
+ },
+);
+
app.use(async (c, next) => {
- if (c.req.path === "/health") {
+ if (c.req.path === "/health" || c.req.path === "/api/inngest") {
return next();
}
+
const authHeader = c.req.header("X-API-Key");
if (process.env.API_KEY !== authHeader) {
@@ -26,36 +95,97 @@ app.use(async (c, next) => {
return next();
});
-app.post("/deploy", zValidator("json", deployJobSchema), (c) => {
+app.post("/deploy", zValidator("json", deployJobSchema), async (c) => {
const data = c.req.valid("json");
- queue.add(data, { groupName: data.serverId });
- return c.json(
- {
- message: "Deployment Added",
- },
- 200,
- );
-});
+ logger.info("Received deployment request", data);
-app.get("/health", async (c) => {
- return c.json({ status: "ok" });
+ try {
+ // Send event to Inngest instead of adding to Redis queue
+ await inngest.send({
+ name: "deployment/requested",
+ data,
+ });
+
+ logger.info("Deployment event sent to Inngest", {
+ serverId: data.serverId,
+ });
+
+ return c.json(
+ {
+ message: "Deployment Added to Inngest Queue",
+ serverId: data.serverId,
+ },
+ 200,
+ );
+ } catch (error) {
+ console.log("error", error);
+ logger.error("Failed to send deployment event", error);
+ return c.json(
+ {
+ message: "Failed to queue deployment",
+ error: error instanceof Error ? error.message : String(error),
+ },
+ 500,
+ );
+ }
});
-const queue = new Queue({
- name: "deployments",
- process: async (job: DeployJob) => {
- logger.info("Deploying job", job);
- return await deploy(job);
+app.post(
+ "/cancel-deployment",
+ zValidator("json", cancelDeploymentSchema),
+ async (c) => {
+ const data = c.req.valid("json");
+ logger.info("Received cancel deployment request", data);
+
+ try {
+ // Send cancellation event to Inngest
+
+ await inngest.send({
+ name: "deployment/cancelled",
+ data,
+ });
+
+ const identifier =
+ data.applicationType === "application"
+ ? `applicationId: ${data.applicationId}`
+ : `composeId: ${data.composeId}`;
+
+ logger.info("Deployment cancellation event sent", {
+ ...data,
+ identifier,
+ });
+
+ return c.json({
+ message: "Deployment cancellation requested",
+ applicationType: data.applicationType,
+ });
+ } catch (error) {
+ logger.error("Failed to send deployment cancellation event", error);
+ return c.json(
+ {
+ message: "Failed to cancel deployment",
+ error: error instanceof Error ? error.message : String(error),
+ },
+ 500,
+ );
+ }
},
- redisClient,
+);
+
+app.get("/health", async (c) => {
+ return c.json({ status: "ok" });
});
-(async () => {
- await redisClient.connect();
- await redisClient.flushAll();
- logger.info("Redis Cleaned");
-})();
+// Serve Inngest functions endpoint
+app.on(
+ ["GET", "POST", "PUT"],
+ "/api/inngest",
+ serveInngest({
+ client: inngest,
+ functions: [deploymentFunction],
+ }),
+);
const port = Number.parseInt(process.env.PORT || "3000");
-logger.info("Starting Deployments Server โ
", port);
+logger.info("Starting Deployments Server with Inngest โ
", port);
serve({ fetch: app.fetch, port });
diff --git a/apps/api/src/schema.ts b/apps/api/src/schema.ts
index 609289bf70..5a4355956f 100644
--- a/apps/api/src/schema.ts
+++ b/apps/api/src/schema.ts
@@ -3,8 +3,8 @@ import { z } from "zod";
export const deployJobSchema = z.discriminatedUnion("applicationType", [
z.object({
applicationId: z.string(),
- titleLog: z.string(),
- descriptionLog: z.string(),
+ titleLog: z.string().optional(),
+ descriptionLog: z.string().optional(),
server: z.boolean().optional(),
type: z.enum(["deploy", "redeploy"]),
applicationType: z.literal("application"),
@@ -12,8 +12,8 @@ export const deployJobSchema = z.discriminatedUnion("applicationType", [
}),
z.object({
composeId: z.string(),
- titleLog: z.string(),
- descriptionLog: z.string(),
+ titleLog: z.string().optional(),
+ descriptionLog: z.string().optional(),
server: z.boolean().optional(),
type: z.enum(["deploy", "redeploy"]),
applicationType: z.literal("compose"),
@@ -22,8 +22,8 @@ export const deployJobSchema = z.discriminatedUnion("applicationType", [
z.object({
applicationId: z.string(),
previewDeploymentId: z.string(),
- titleLog: z.string(),
- descriptionLog: z.string(),
+ titleLog: z.string().optional(),
+ descriptionLog: z.string().optional(),
server: z.boolean().optional(),
type: z.enum(["deploy"]),
applicationType: z.literal("application-preview"),
@@ -32,3 +32,16 @@ export const deployJobSchema = z.discriminatedUnion("applicationType", [
]);
export type DeployJob = z.infer