retracedhq/retraced
GitHub: retracedhq/retraced
Retraced 是一个开源的合规审计日志服务，提供可搜索可导出的事件记录和嵌入式查看 UI，帮助团队快速集成审计能力。
Stars: 447 | Forks: 35
# Retraced 审计日志
Retraced 是将合规审计日志集成到您的应用程序中的最简单方法。
它提供了可搜索、可导出的读/写事件记录。
提供了适用于 [Go](https://github.com/retracedhq/retraced-go) 和 [Javascript](https://github.com/retracedhq/retraced-js) 的客户端库。
## 文档
请前往 [https://github.com/retracedhq/docs](https://github.com/retracedhq/docs) 获取有关如何开始使用 Retraced 的详细文档。
- [分步教程视频](https://www.youtube.com/watch?v=4vBxw4kqdwE)
## 用法
### 使用 docker-compose 运行
**注意：** `ADMIN_ROOT_TOKEN` 已设置为 `dev`，以便您可以在本地测试设置。请务必在生产环境中更改此项（以及其他相关的敏感环境变量/密钥）。
### 运行示例以了解 Retraced 的工作原理
Git checkout Logs Viewer [仓库](https://github.com/retracedhq/logs-viewer)，运行 `npm i`，然后运行 `npm run dev` 以启动一个示例，该示例使用 Retraced 向您展示一些自动生成的事件。刷新几次 UI 即可触发自动生成的审计日志。您还可以使用以下 curl 命令导入一些自定义日志：-
```
curl -X POST -H "Content-Type: application/json" -H "Authorization: token=dev" -d '{
"action": "some.record.created",
"teamId": "boxyhq",
"group": {
"id": "dev",
"name": "dev"
},
"crud": "c",
"created": "2023-01-16T15:48:44.573Z",
"source_ip": "127.0.0.1",
"actor": {
"id": "jackson@boxyhq.com",
"name": "Jackson"
},
"target": {
"id": "100",
"name": "tasks",
"type": "Tasks"
}
}' http://localhost:3000/auditlog/publisher/v1/project/dev/event
```
您也可以使用 [管理门户](http://localhost:5225)，但需要设置 SMTP 环境变量，以便您可以使用 magic link 登录门户。我们正在努力支持其他形式的身份验证，并且非常乐意听取您希望我们接下来支持哪个提供商。
### 使用 Skaffold 运行
您也可以使用 Skaffold 来代替 docker-compose 在本地运行 Retraced。
## Swagger 文档
Swagger 规范是使用 [TSOA](https://github.com/lukeautry/tsoa) 从源代码生成的
默认情况下，Swagger 规范会作为 `npm run build` 的一部分进行构建，并由 express 在 `/publisher/v1/swagger.json` 路径提供服务。
#### 生成规范
要从 Typescript 源代码生成 swagger.json，请使用
```
npm run swagger
```
输出将写入到 build/swagger.json
## 支持
通过以下任一方式联系维护者：
- [GitHub Issues](https://github.com/retracedhq/retraced/issues)（Bug 报告、贡献）
## 社区
- [Discord](https://discord.gg/uyb7pYt4Pa)（用于与社区和 BoxyHQ 团队进行实时讨论）
- [Twitter](https://twitter.com/BoxyHQ)（快速获取新闻）
标签：CMS安全, Go, JavaScript, MITM代理, OISF, Ruby工具, 合规, 子域名突变, 审计日志, 日志管理, 自动化攻击, 请求拦截