---
title: 加密
author: pengzhanbo
createTime: 2024/03/04 15:58:48
permalink: /guide/features/encryption/
---

## 加密

在本主题中，支持 **全站加密** 和 **部分加密** 等多种灵活的加密方式。

::: warning 提示
由于 `vuepress` 是静态站点，其自身限制的原因，**加密** 仅仅只是 看起来 看不到内容，
并且在 编译时，不再将 内容 预渲染到 `html` 中，但实际上 还是能够从 站点源文件 中获取到内容。
因此，不建议将 **加密** 功能 认为是 安全可靠的。

请尽量避免将 **加密功能** 应用于需要 **严格保密** 的内容 中。
:::

**已解锁的文章，仅在当前会话中可见。**

## 启用加密功能

在 主题配置中，添加 `encrypt` 选项。

```ts
import { defineUserConfig } from 'vuepress'
import { themePlume } from 'vuepress-theme-plume'

export default defineUserConfig({
  theme: themePlume({
    encrypt: {
      // more options...
    }
  })
})
```

## 全站加密

有些情况下，你可能 需要对 全站进行加密。
因此，你可以通过 `encrypt.global` 选项配置全站加密。
然后，通过配置 `encrypt.admin` 选项，设置一个或多个密码。

```ts
export default defineUserConfig({
  theme: themePlume({
    encrypt: {
      global: true,
      admin: ['123456'],
    }
  })
})
```

## 部分加密

大多数情况下，你可能只需需要 加密 某一篇文章、某一个目录 等。
因此，你可以通过 `encrypt.rules` 选项配置部分加密。

```ts
export default defineUserConfig({
  theme: themePlume({
    encrypt: {
      rules: {
        // 可以是 md 文件的相对路径，对该文件加密
        '前端/基础.md': '123456',
        // 可以是 文件夹的路径，对该目录下所有文章加密
        '/notes/vuepress-theme-plume/': '123456',
        // 可以是 访问地址的请求路径，对该访问路径下所有文章加密
        '/vuepress-theme-plume/': '123456',
        // 可以是 具体的某个页面的请求路径，对该页面加密
        '/article/f8dnci3/': '123456',
        // 如果是 `^` 开头，则匹配该正则表达式的页面也会加密
        '^/(a|b)/': '123456',
      }
    }
  })
})
```

`encrypt.rules` 的 **键** 将作为 匹配规则，**值** 将作为 该规则对应的密码，可以设置 一个或多个密码。

:::tip 说明
- 密码 必须是 普通的字符串。
- 如果是 加密的是 整个目录，解锁时也是解锁整个目录，而不是解锁该目录下的某个文章。
- `encrypt.admin` 也可用于解锁 **部分加密** 的页面。
- 使用 `encrypt.admin` 解锁后，被认为是管理员访问，其它未解锁页面也默认解锁。
:::

## 相关配置

以下配置支持在多语言配置中使用。

### encryptGlobalText

- **类型**： `string`
- **默认值**： `'Only password can access this site'`
- **说明**： 

  全站加密时，提示信息。支持 HTML。如果你期望为访客提供获取密码的联系方式，你可能会需要这个配置。

### encryptPageText

- **类型**： `string`
- **默认值**： `'Only password can access this page'`
- **说明**： 

  部分加密时，提示信息。支持 HTML。如果你期望为访客提供获取密码的联系方式，你可能会需要这个配置。

### encryptButtonText

- **类型**： `string`
- **默认值**： `'Confirm'`
- **说明**： 确认按钮的文本

### encryptPlaceholder

- **类型**： `string`
- **默认值**： `'Enter password'`
- **说明**： 密码输入框的占位符

### 示例

```ts
import { defineUserConfig } from 'vuepress'
import { themePlume } from 'vuepress-theme-plume'

export default defineUserConfig({
  theme: themePlume({
    locales: {
      '/': {
        encryptButtonText: 'Confirm',
        encryptPlaceholder: 'Enter password',
        encryptGlobalText: 'Only password can access this site',
        encryptPageText: 'Only password can access this page',
      }
    }
  })
})
```