agenix 项目使用教程

1. 项目的目录结构及介绍

agenix 项目的目录结构如下：

agenix/
├── LICENSE
├── README.md
├── flake.nix
├── modules
│   └── age.nix
├── pkgs
│   └── agenix
│       └── default.nix
└── secrets.nix

• LICENSE: 项目许可证文件，采用 CC0-1.0 许可证。
• README.md: 项目介绍和使用说明。
• flake.nix: 用于 Nix Flakes 的配置文件。
• modules/age.nix: NixOS 模块配置文件，用于管理加密的 secrets。
• pkgs/agenix/default.nix: agenix 命令行工具的打包配置文件。
• secrets.nix: 定义 secrets 的接收者公钥的配置文件。

2. 项目的启动文件介绍

agenix 项目的启动文件主要是 pkgs/agenix/default.nix，该文件定义了 agenix 命令行工具的打包配置。以下是该文件的部分内容：

{ stdenv, fetchFromGitHub, age, ... }:

stdenv.mkDerivation {
  pname = "agenix";
  version = "0.1.0";

  src = fetchFromGitHub {
    owner = "ryantm";
    repo = "agenix";
    rev = "main";
    sha256 = "...";
  };

  buildInputs = [ age ];

  installPhase = ''
    mkdir -p $out/bin
    cp agenix $out/bin/
  '';
}

该文件使用 stdenv.mkDerivation 来创建一个 Nix 包，并定义了包的名称、版本、源代码的获取方式以及安装阶段的操作。

3. 项目的配置文件介绍

agenix 项目的配置文件主要包括 flake.nix 和 secrets.nix。

flake.nix

flake.nix 文件用于 Nix Flakes 的配置，以下是该文件的部分内容：

{
  description = "age-encrypted secrets for NixOS and Home Manager";

  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs";
    agenix.url = "github:ryantm/agenix";
  };

  outputs = { self, nixpkgs, agenix }: {
    nixosConfigurations.yourhostname = nixpkgs.lib.nixosSystem {
      modules = [
        agenix.nixosModules.age
        ./configuration.nix
      ];
    };
  };
}

该文件定义了项目的描述、输入源以及输出配置。通过 nixosConfigurations 可以定义 NixOS 系统的配置。

secrets.nix

secrets.nix 文件定义了 secrets 的接收者公钥，以下是该文件的部分内容：

{
  "secret1.age".publicKeys = [
    "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILAD..."
  ];
}

该文件通过 publicKeys 属性定义了每个 secret 的接收者公钥。

以上是 agenix 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。