Skip to content

Commit

Permalink
Update: 增加Nemo安装及使用文档
Browse files Browse the repository at this point in the history
  • Loading branch information
hanc00l committed Jul 10, 2023
1 parent 6366c80 commit dd28672
Show file tree
Hide file tree
Showing 10 changed files with 938 additions and 450 deletions.
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# ChangeLog

## 2.9.4

2023-07-10

### Updated

- Nemo安装及使用文档v1.0;

### Fix

- v2.9.3的release包里,thirdparty/fingerprinthub目录里没有打包二进制文件

## 2.9.3

2023-06-21
Expand Down
26 changes: 3 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Nemo

**[快速上手](docs/quickstart.md)****[安装手册](docs/install.md)****[使用手册](docs/usage.md)****[常见问题](docs/question.md)****[CHANGELOG](CHANGELOG.md)**

**Nemo**是用来进行自动化信息收集的一个简单平台,通过集成常用的信息收集工具和技术,实现对内网及互联网资产信息的自动收集,提高隐患排查和渗透测试的工作效率。

<img src="docs/image/index.png" alt="login" />
Expand Down Expand Up @@ -70,34 +72,12 @@
- Docker支持
- 资产流程化扫描(XSCAN)

## Docker

```shell
mkdir nemo;tar xvf nemo_linux_amd64.tar -C nemo;cd nemo
docker-compose up -d
```

**Docker方式建议用作体验或临时测试,持续使用建议在虚拟机或VPS中安装和使用。**

[更多Docker使用方式](docs/docker.md)

## 安装

Tested on [ubuntu18.04/20.04/22.04 LTS](docs/install_linux.md)[macOS](docs/install_mac.md)、Windows(Test In Win10)

## 使用

- 默认监听端口为5000,默认用户**nemo(超级管理员)**、密码 **nemo** ;通过“Config--配置管理”更改默认密码,通过“System--User“创建和管理用户权限。
- 用户角色分为superadmin、admin和guest三种; **superadmin(超级管理员)** 可管理用户和工作空间,**admin(管理员)** 可管理资源、任务和参数配置,**guest(普通用户)** 只有资源和任务的查看权限。
- 工作空间对资源(IP、Domain、任务、组织及漏洞)进行隔离,每个工作空间可分配给不同的用户访问权限。
## 演示页面

<img src="docs/demo.gif" />



## [CHANGELOG](CHANGELOG.md)


## 参考

- [jeffzh3ng](https://github.com/jeffzh3ng/fuxi)
Expand Down
Loading

0 comments on commit dd28672

Please sign in to comment.