datocms-plugin-signifly-backups 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +53 -0
- package/package.json +3 -2
package/README.md
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
# Automatic Environment Backups @ Vercel
|
|
4
|
+
|
|
5
|
+
A DatoCMS plugin by [Signifly](https://signifly.com) that automatically creates scheduled backups of your environments with full history tracking and configurable retention policies.
|
|
6
|
+
|
|
7
|
+
## Features
|
|
8
|
+
|
|
9
|
+
- **Scheduled Backups** - Daily, weekly, and monthly backup schedules with configurable cron expressions
|
|
10
|
+
- **Backup History** - Full history with status, duration, and timestamps
|
|
11
|
+
- **Manual Backups** - Trigger on-demand backups from the plugin UI
|
|
12
|
+
- **Retention Policies** - Automatically clean up old backups based on retention counts
|
|
13
|
+
- **One-Click Deploy** - Deploy the backend service to Vercel with a single click
|
|
14
|
+
|
|
15
|
+
## Quick Start
|
|
16
|
+
|
|
17
|
+
### 1. Deploy the Backend to Vercel
|
|
18
|
+
|
|
19
|
+
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fsignifly%2Fdatocms-backup-api-template&project-name=datocms-backup-api&env=CRON_SECRET,API_SECRET&envDescription=CRON_SECRET%3A%20Secret%20for%20cron%20endpoint.%20API_SECRET%3A%20Secret%20for%20API%20endpoints.%20Generate%20both%20with%3A%20openssl%20rand%20-hex%2032&stores=%5B%7B%22type%22%3A%22kv%22%7D%5D)
|
|
20
|
+
|
|
21
|
+
During deployment:
|
|
22
|
+
1. Set `CRON_SECRET` and `API_SECRET` (generate with `openssl rand -hex 32`)
|
|
23
|
+
2. Vercel KV storage will be automatically provisioned
|
|
24
|
+
|
|
25
|
+
### 2. Install the Plugin
|
|
26
|
+
|
|
27
|
+
Install from the [DatoCMS marketplace](https://www.datocms.com/marketplace/plugins/i/datocms-plugin-signifly-backups) or add manually by npm package name.
|
|
28
|
+
|
|
29
|
+
### 3. Configure
|
|
30
|
+
|
|
31
|
+
1. Enter your Vercel deployment URL
|
|
32
|
+
2. Provide a DatoCMS Full-Access API token
|
|
33
|
+
3. Configure your backup schedules
|
|
34
|
+
|
|
35
|
+
## Environment Variables
|
|
36
|
+
|
|
37
|
+
| Variable | Required | Description |
|
|
38
|
+
|----------|----------|-------------|
|
|
39
|
+
| `CRON_SECRET` | Yes | Secret for cron endpoint authentication |
|
|
40
|
+
| `API_SECRET` | Yes | Secret for API endpoint authentication |
|
|
41
|
+
|
|
42
|
+
## Support
|
|
43
|
+
|
|
44
|
+
- [GitHub Issues](https://github.com/signifly/datocms-plugin-signifly-backups/issues)
|
|
45
|
+
- [Documentation](https://github.com/signifly/datocms-plugin-signifly-backups)
|
|
46
|
+
|
|
47
|
+
## About Signifly
|
|
48
|
+
|
|
49
|
+
[Signifly](https://signifly.com) is a digital agency specializing in strategy, design, and technology. We build digital products and experiences that make a difference.
|
|
50
|
+
|
|
51
|
+
## License
|
|
52
|
+
|
|
53
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "datocms-plugin-signifly-backups",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "Automatically backup your DatoCMS environments on a schedule. Deploy your own backend to Vercel and configure daily, weekly, and monthly backups with customizable retention policies.",
|
|
6
6
|
"homepage": "https://github.com/signifly/datocms-plugin-signifly-backups",
|
|
@@ -32,7 +32,8 @@
|
|
|
32
32
|
},
|
|
33
33
|
"files": [
|
|
34
34
|
"dist",
|
|
35
|
-
"docs"
|
|
35
|
+
"docs",
|
|
36
|
+
"README.md"
|
|
36
37
|
],
|
|
37
38
|
"type": "module",
|
|
38
39
|
"scripts": {
|