add backup database manually

Author: xc2f

README.md

@@ -85,7 +85,7 @@ APP_CMD=start
 
 ## Troubleshooting
 
-- On first startup, you may encounter an error indicating that `xc2f_pgdata` was not found. You can resolve this by commenting out the `volumes.pgdata.external` and `volumes.pgdata.name` lines in `docker-compose.yml`. If you keep these options, you can customize the pgdata name. See [Change Postgres volume name](#change-postgres-volume-name) for details.
+- On first startup, you may encounter an error indicating that `external volume "xc2f_pgdata" not found`. You can resolve this by commenting out the `volumes.pgdata.external` and `volumes.pgdata.name` lines in `docker-compose.yml`. Or you can create the xc2f_pgdata volume by running `docker volume create xc2f_pgdata`.
 - On first startup or after new table structures are added, enter the payload container to run `pnpm payload migrate:create` and `pnpm payload migrate`.
 
 ## Commands

src/app/(payload)/admin/importMap.js

@@ -28,6 +28,7 @@ import { RowLabel as RowLabel_1f6ff6ff633e3695d348f4f3c58f1466 } from '@/Footer/
 import { default as default_1a7510af427896d367a49dbf838d2de6 } from '@/components/BeforeDashboard'
 import { default as default_8a7ab0eb7ab5c511aba12e68480bfe5e } from '@/components/BeforeLogin'
 import { S3ClientUploadHandler as S3ClientUploadHandler_f97aa6c64367fa259c5bc0567239ef24 } from '@payloadcms/storage-s3/client'
+import { default as default_739e6b432caad92cc3d7bab1ebeedbb4 } from '../../../views/System'
 import { CollectionCards as CollectionCards_ab83ff7e88da8d3530831f296ec4756a } from '@payloadcms/ui/rsc'
 
 export const importMap = {
@@ -61,5 +62,6 @@ export const importMap = {
   "@/components/BeforeDashboard#default": default_1a7510af427896d367a49dbf838d2de6,
   "@/components/BeforeLogin#default": default_8a7ab0eb7ab5c511aba12e68480bfe5e,
   "@payloadcms/storage-s3/client#S3ClientUploadHandler": S3ClientUploadHandler_f97aa6c64367fa259c5bc0567239ef24,
+  "./views/System#default": default_739e6b432caad92cc3d7bab1ebeedbb4,
   "@payloadcms/ui/rsc#CollectionCards": CollectionCards_ab83ff7e88da8d3530831f296ec4756a
 }

src/components/BeforeDashboard/index.tsx

@@ -12,12 +12,14 @@ const BeforeDashboard: React.FC = () => {
         <h4>Welcome to your dashboard!</h4>
       </Banner>
       <div className="row">
+        <a href="/admin/system">Go to system</a>
+        <span>|</span>
         <a href="/" target="_blank">
-          visit your website
+          Visit your website
         </a>
         <span>|</span>
         <a href="https://payloadcms.com/docs/getting-started/what-is-payload" target="_blank">
-          visit payload docs
+          Visit payload docs
         </a>
       </div>
     </div>

src/endpoints/index.ts

@@ -0,0 +1,14 @@
+import type { Endpoint } from 'payload'
+
+import { backupDatabaseTask } from '../tasks/backupDatabase'
+
+export const endpoints: Endpoint[] = [
+  {
+    path: '/backup/database',
+    method: 'get',
+    handler: async () => {
+      const result = await backupDatabaseTask()
+      return Response.json(result)
+    },
+  },
+]

src/payload.config.ts

@@ -27,6 +27,7 @@ import { backupDatabaseTask } from './tasks/backupDatabase'
 import { en } from '@payloadcms/translations/languages/en'
 import { zh } from '@payloadcms/translations/languages/zh'
 
+import { endpoints } from './endpoints'
 import { migrations } from './migrations'
 
 const filename = fileURLToPath(import.meta.url)
@@ -35,12 +36,14 @@ const dirname = path.dirname(filename)
 export default buildConfig({
   admin: {
     components: {
-      // The `BeforeLogin` component renders a message that you see while logging into your admin panel.
-      // Feel free to delete this at any time. Simply remove the line below.
       beforeLogin: ['@/components/BeforeLogin'],
-      // The `BeforeDashboard` component renders the 'welcome' block that you see after logging into your admin panel.
-      // Feel free to delete this at any time. Simply remove the line below.
       beforeDashboard: ['@/components/BeforeDashboard'],
+      views: {
+        system: {
+          Component: './views/System',
+          path: '/system',
+        },
+      },
     },
     importMap: {
       baseDir: path.resolve(dirname),
@@ -169,4 +172,5 @@ export default buildConfig({
     ],
     defaultLocale: 'zh',
   },
+  endpoints,
 })

src/views/System/Backup.tsx

@@ -0,0 +1,25 @@
+'use client'
+import React from 'react'
+import { Gutter, Button, toast } from '@payloadcms/ui'
+
+const Backup = () => {
+  const handleBackup = async () => {
+    const loading = toast.loading('备份中...')
+    const res = await fetch('/api/backup/database')
+    toast.dismiss(loading)
+    if (res.ok) {
+      toast.success('备份成功！')
+    }
+  }
+
+  return (
+    <Gutter>
+      <h1>System</h1>
+      <Button onClick={handleBackup}>Backup Database</Button>
+    </Gutter>
+  )
+}
+
+Backup.propTypes = {}
+
+export default Backup

src/views/System/index.tsx

@@ -0,0 +1,33 @@
+import type { AdminViewServerProps } from 'payload'
+import { DefaultTemplate } from '@payloadcms/next/templates'
+import { Gutter } from '@payloadcms/ui'
+import Backup from './Backup'
+
+const System = async ({ initPageResult, params, searchParams }: AdminViewServerProps) => {
+  const {
+    req: { user },
+  } = initPageResult
+
+  if (!user) {
+    return <p>You must be logged in to view this page.</p>
+  }
+
+  return (
+    <DefaultTemplate
+      i18n={initPageResult.req.i18n}
+      locale={initPageResult.locale}
+      params={params}
+      payload={initPageResult.req.payload}
+      permissions={initPageResult.permissions}
+      searchParams={searchParams}
+      user={initPageResult.req.user || undefined}
+      visibleEntities={initPageResult.visibleEntities}
+    >
+      <Gutter>
+        <Backup />
+      </Gutter>
+    </DefaultTemplate>
+  )
+}
+
+export default System