Feature | Add documentation of caddy control

.dockerignore

@@ -9,4 +9,6 @@ db/
 .idea/
 docker-compose.yml
 Dockerfile
-.next
+.next
+.contentlayer/
+docker-compose.*

.gitignore

@@ -43,4 +43,5 @@ next-env.d.ts
 db
 caddy_config
 caddy_data
-test
+test
+.contentlayer

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:20.14.0-alpine3.20 AS base
+FROM node:jod-bookworm-slim AS base
 RUN npm install -g pnpm
 WORKDIR /app
 
@@ -10,18 +10,22 @@ RUN pnpm install --frozen-lockfile
 # build stage
 FROM base AS builder
 WORKDIR /app
+RUN apt-get update -y && apt-get install -y openssl
 COPY --from=dependencies /app/node_modules ./node_modules
 COPY . .
 RUN pnpx prisma generate
+RUN pnpm run build:content
 RUN pnpm build
 
 # production stage
 FROM base AS runner
 WORKDIR /app
+RUN apt-get update -y && apt-get install -y openssl
 COPY --from=builder /app/prisma ./prisma
 COPY --from=builder /app/public ./public
 COPY --from=builder /app/.next/standalone ./
 COPY --from=builder /app/.next/static ./.next/static
+COPY --from=builder /app/.contentlayer ./.contentlayer
 COPY --from=builder /app/start.sh ./start.sh
 RUN chmod +x /app/start.sh
 

Makefile

@@ -0,0 +1,9 @@
+DOCKER_REPO := ttl.sh
+DOCKER_IMAGE := caddycontrol
+DOCKER_TAG := 5m
+
+push:
+	docker build --platform linux/amd64 -t $(DOCKER_REPO)/$(DOCKER_IMAGE):$(DOCKER_TAG) .
+	docker push $(DOCKER_REPO)/$(DOCKER_IMAGE):$(DOCKER_TAG)
+
+.PHONY: push

README.md

@@ -15,8 +15,8 @@ This project was born out of the need to build a custom domain service with auto
 - [x] Rest API Access
 - [x] Proxy management dashboard
 - [x] API Keys management dashboard
-- [ ] Domain redirection option
-- [ ] Multi user support
+- [x] Domain redirection option
+- [x] Multi user support
 
 ## Screenshots
 

config/meta.tsx

@@ -0,0 +1,48 @@
+export const meta = {
+  metadataBase: new URL('https://caddy-control.vercel.app'),
+  title: 'Caddy Control - Documentation',
+  description:
+    'Open-source solution for domain routing and proxy management! 🚀',
+  authors: [
+    { name: 'Mukesh Kumar Chaudhary', url: 'https://mukesh.name.np' },
+    { name: 'Avash Ghimire', url: 'https://avashghimire.com.np' }
+  ],
+  keywords: [
+    'Caddy Control',
+    'Next.js',
+    'Proxy',
+    'Caddy',
+    'Documentation',
+  ],
+  publisher: 'Mukesh Kumar Chaudhary',
+  creator: 'Mukesh Kumar Chaudhary',
+  openGraph: {
+    type: 'website',
+    title: 'Caddy Control - Documentation',
+    description:
+      'Open-source solution for domain routing and proxy management! 🚀',
+    images: [
+      {
+        url: '/logo.png',
+        width: 1200,
+        height: 630,
+        alt: 'Caddy Control Documentation',
+      },
+    ],
+  },
+  twitter: {
+    card: 'summary_large_image',
+    title: 'Caddy Control - Documentation',
+    description:
+      'Open-source solution for domain routing and proxy management! 🚀',
+    images: ['/logo.png'],
+    creator: '@mukezhz',
+  },
+  alternates: {
+    canonical: 'https://caddy-control.vercel.app',
+  },
+  robots: 'index, follow',
+  hreflang: {
+    en: 'https://caddy-control.vercel.app',
+  },
+};

config/sidebar.tsx

@@ -0,0 +1,42 @@
+import { BookOpen, Code, FileCode, Rocket } from 'lucide-react';
+
+export const sidebarNav = [
+  {
+    title: 'Getting Started',
+    icon: <Rocket className="h-5 w-5" />,
+    defaultOpen: true,
+    pages: [
+      {
+        title: 'Introduction',
+        href: '/docs/getting-started/introduction',
+      },
+      {
+        title: 'Installation',
+        href: '/docs/getting-started/installation',
+      },
+      {
+        title: 'Quick Start',
+        href: '/docs/getting-started/quick-start',
+      },
+    ],
+  },
+  {
+    title: 'API Reference',
+    icon: <Code className="h-5 w-5" />,
+    defaultOpen: true,
+    pages: [
+      {
+        title: 'Overview',
+        href: '/docs/api/overview',
+      },
+      {
+        title: 'Authentication',
+        href: '/docs/api/authentication',
+      },
+      {
+        title: 'Endpoints',
+        href: '/docs/api/endpoints',
+      },
+    ],
+  },
+];

config/toc.tsx

@@ -0,0 +1,150 @@
+type TocPage = {
+  title: string;
+  href: string;
+};
+
+type TocSection = {
+  title: string;
+  href: string;
+  pages?: TocPage[];
+};
+
+type TocData = {
+  [key: string]: TocSection[];
+};
+
+// TOC Data for Caddy Control documentation
+export const TocData: TocData = {
+  'getting-started/introduction': [
+    {
+      title: 'Welcome to Caddy Control',
+      href: '/docs/getting-started/introduction#welcome-to-caddy-control',
+      pages: [
+        {
+          title: 'Why Choose Caddy Control',
+          href: '/docs/getting-started/introduction#why-choose-caddy-control',
+        },
+        {
+          title: 'Features',
+          href: '/docs/getting-started/introduction#features',
+        },
+        {
+          title: 'Technologies',
+          href: '/docs/getting-started/introduction#technologies-behind-caddy-control',
+        },
+      ],
+    },
+  ],
+  'getting-started/installation': [
+    {
+      title: 'Installation Guide',
+      href: '/docs/getting-started/installation#installation-guide',
+      pages: [
+        {
+          title: 'Local Development Setup',
+          href: '/docs/getting-started/installation#local-development-setup',
+        },
+        {
+          title: 'Production Deployment with Docker',
+          href: '/docs/getting-started/installation#production-deployment-with-docker',
+        },
+        {
+          title: 'Verifying Your Installation',
+          href: '/docs/getting-started/installation#verifying-your-installation',
+        },
+      ],
+    },
+  ],
+  'getting-started/quick-start': [
+    {
+      title: 'Quick Start Guide',
+      href: '/docs/getting-started/quick-start#quick-start-guide',
+      pages: [
+        {
+          title: 'Managing Domains',
+          href: '/docs/getting-started/quick-start#managing-domains',
+        },
+        {
+          title: 'Next Steps',
+          href: '/docs/getting-started/quick-start#next-steps',
+        },
+      ],
+    },
+  ],
+  'api/overview': [
+    {
+      title: 'API Overview',
+      href: '/docs/api/overview#api-overview',
+      pages: [
+        {
+          title: 'Base URL',
+          href: '/docs/api/overview#base-url',
+        },
+        {
+          title: 'Authentication',
+          href: '/docs/api/overview#authentication',
+        },
+        {
+          title: 'Response Format',
+          href: '/docs/api/overview#response-format',
+        },
+        {
+          title: 'Rate Limiting',
+          href: '/docs/api/overview#rate-limiting',
+        },
+        {
+          title: 'Best Practices',
+          href: '/docs/api/overview#best-practices',
+        },
+      ],
+    },
+  ],
+  'api/authentication': [
+    {
+      title: 'API Authentication',
+      href: '/docs/api/authentication#api-authentication',
+      pages: [
+        {
+          title: 'API Key Authentication',
+          href: '/docs/api/authentication#api-key-authentication',
+        },
+        {
+          title: 'Managing API Keys',
+          href: '/docs/api/authentication#managing-api-keys',
+        },
+        {
+          title: 'Best Practices',
+          href: '/docs/api/authentication#best-practices-for-api-key-management',
+        },
+      ],
+    },
+  ],
+  'api/endpoints': [
+    {
+      title: 'API Endpoints',
+      href: '/docs/api/endpoints#api-endpoints',
+      pages: [
+        {
+          title: 'Domain Management',
+          href: '/docs/api/endpoints#domain-management',
+        },
+        {
+          title: 'Caddy Configuration',
+          href: '/docs/api/endpoints#caddy-configuration',
+        },
+        {
+          title: 'API Key Management',
+          href: '/docs/api/endpoints#api-key-management',
+        },
+        {
+          title: 'Error Codes',
+          href: '/docs/api/endpoints#error-codes',
+        },
+        {
+          title: 'Pagination',
+          href: '/docs/api/endpoints#pagination',
+        },
+      ],
+    },
+  ],
+};

content/button.mdx

@@ -0,0 +1 @@
+# This doc will show button component

content/installation.mdx

@@ -0,0 +1 @@
+# Welcome to installation

contentlayer.config.ts

@@ -0,0 +1,38 @@
+// contentlayer.config.ts
+import { defineDocumentType, makeSource } from "contentlayer2/source-files";
+import remarkGfm from "remark-gfm";
+import { codeImport } from "remark-code-import";
+import rehypeSlug from "rehype-slug";
+import highlight from "rehype-highlight";
+
+export const Post = defineDocumentType(() => ({
+  name: "Docs",
+  contentType: "mdx",
+  filePathPattern: `**/*.mdx`,
+  markdown: { fileExtensions: ["mdx", "md"] }, // Ensure it watches these files
+  fields: {
+    title: { type: "string", required: true },
+    description: { type: "string", required: false },
+    date: { type: "date", required: false },
+  },
+  computedFields: {
+    url: {
+      type: "string",
+      resolve: (post) => `/docs/${post._raw.flattenedPath}`,
+    },
+    slug: {
+      type: "string",
+      resolve: (doc) => doc._raw.flattenedPath,
+    },
+  },
+}));
+
+export default makeSource({
+  contentDirPath: "docs",
+  documentTypes: [Post],
+  mdx: {
+    remarkPlugins: [remarkGfm, codeImport],
+    rehypePlugins: [rehypeSlug, highlight],
+  },
+  disableImportAliasWarning: true,
+});

docker-compose.system.yml

@@ -0,0 +1,15 @@
+services:
+  caddycontrol:
+    image: itbeeazy/caddy-control:1.0.0
+    container_name: caddycontrol
+    restart: unless-stopped
+    volumes:
+      - ./db:/app/db
+    environment:
+      - NODE_ENV=production
+      - APP_HOST=demo.example.com
+      - CADDY_SERVER_IP=127.0.0.1
+      - CADDY_ADMIN_URL=http://localhost:2019
+      - JWT_SECRET=alksdlaksdjasd
+    network_mode: host
+