HeavyScript 安装与使用指南

HeavyScript 安装与使用指南

heavy_scriptBash script for managing Truenas SCALE applications, automatically update applications, backup applications datasets, open a shell for containers.项目地址:https://gitcode.com/gh_mirrors/he/heavy_script

1. 项目目录结构及介绍

HeavyScript 是一个专为管理 TrueNAS SCALE 应用程序设计的bash脚本，简化了应用程序的自动更新、备份等任务。以下是项目的基本目录结构和关键文件简介：

• main: 这个目录通常包含了核心的脚本逻辑。
  • functions: 存放着各种功能函数，如更新、备份等的实现。
  • deploy.sh: 安装部署脚本，用于将HeavyScript安装到用户的系统上。
• config.ini: 自动生成的配置文件，存储用户自定义设置，如同步、备份频率等，默认情况下在用户的主目录下生成。
• README.md: 项目的主要说明文档，提供了快速入门指导和主要功能的概述。

2. 项目的启动文件介绍

HeavyScript没有传统意义上的单一“启动”文件，其操作通过命令行界面执行。主要通过运行heavyscript命令并附带不同的参数来控制。例如，要执行应用更新，你将在终端中输入：

heavyscript update --sync

update就是执行更新操作的关键字，而--sync是一个可选参数，指示同步操作。初次使用前，你需要通过安装脚本来确保heavyscript命令全局可用。

安装命令示例（非特权用户）:

curl -s https://raw.githubusercontent.com/Heavybullets8/heavy_script/main/functions/deploy.sh | bash && source "$HOME/bashrc" 2>/dev/null && source "$HOME/zshrc" 2>/dev/null

或（具有root权限）:

curl -s https://raw.githubusercontent.com/Heavybullets8/heavy_script/main/functions/deploy.sh | sudo bash && source "$HOME/bashrc" 2>/dev/null && source "$HOME/zshrc" 2>/dev/null

3. 项目的配置文件介绍

配置文件位于用户的家目录下，一般命名为~/heavy_script/config.ini。首次运行HeavyScript时自动生成。这个文件允许用户定制默认行为，比如是否开启同步更新(sync)、备份策略等。编辑此文件可以改变HeavyScript的默认操作行为，无需每次在命令行指定参数。例如：

[UPDATE]
sync = true

该段落表示更新应用时将会自动进行同步操作。若想在某次执行时不使用配置文件中的某些设置，可以通过命令行参数--no-config来忽略配置文件。

请注意，具体配置项可能会随项目版本更新而有所变化，务必参考最新的文档或源码中的注释以获取最准确的信息。

heavy_scriptBash script for managing Truenas SCALE applications, automatically update applications, backup applications datasets, open a shell for containers.项目地址:https://gitcode.com/gh_mirrors/he/heavy_script