Craft-Scripts 使用指南

Craft-Scripts 使用指南

craft-scriptsShell scripts to manage database backups, asset backups, file permissions, asset syncing, cache clearing, and database syncing between Craft CMS environments项目地址:https://gitcode.com/gh_mirrors/cr/craft-scripts

Craft-Scripts 是一套专为 Craft CMS 设计的 shell 脚本集合，旨在简化数据库备份、资产备份、文件权限设置、资产同步、缓存清理以及不同 Craft CMS 环境间的数据库同步等任务。这套工具兼容 Craft 2.x 和 Craft 3.x，并支持 MySQL 与 PostgreSQL 数据库。

1. 项目目录结构及介绍

Craft-Scripts 的主要目录结构通常包括以下部分：

• scripts: 这是核心脚本存放目录，包含了执行各种管理任务的shell脚本文件。
• example.env: 提供了一个环境变量示例文件，用于配置脚本运行时需要的环境信息，实际使用时需重命名为 .env 并调整相应设置。
• 可能还包括其他辅助或说明性文档，如 README 文件，用于详细描述如何使用这些脚本。

重要脚本简介:

• set_perms.sh: 设置Craft CMS安装文件的权限，以增强安全性。
• clear_caches.sh: 清理Craft CMS的缓存，包括文件系统缓存和数据库中的模板缓存。

2. 项目的启动文件介绍

Craft-Scripts 不涉及传统的“启动文件”，因为它是基于命令行的工具集，通过直接调用各个脚本来执行特定任务。例如，若要激活某个功能（如设置文件权限），用户需在终端中直接运行相应的脚本命令，比如 ./scripts/set_perms.sh。这意呀着“启动”实际上指的是执行具体的脚本命令。

3. 项目的配置文件介绍

配置主要是通过一个 .env 文件进行，这个文件基于提供的 example.env 示例文件创建。.env 中应包含必要的环境变量，例如数据库连接信息、路径设置等，确保脚本可以在特定环境中正确运行。关键是要将 REPLACE_ME 类似的占位符替换为真实的值。请注意，为了安全起见，此文件不应被纳入版本控制，通常会被添加到 .gitignore 文件中，避免敏感信息泄露。

---

通过遵循以上指导，开发者可以有效地管理和自动化Craft CMS的相关维护任务，提升开发和运维效率。务必在操作前了解每个脚本的具体作用，避免误操作导致的问题。

craft-scriptsShell scripts to manage database backups, asset backups, file permissions, asset syncing, cache clearing, and database syncing between Craft CMS environments项目地址:https://gitcode.com/gh_mirrors/cr/craft-scripts