Skip to content

Commit

Permalink
Change md files
Browse files Browse the repository at this point in the history
  • Loading branch information
zhishufei committed Nov 28, 2023
1 parent 780a314 commit d5dbe5b
Show file tree
Hide file tree
Showing 6 changed files with 59 additions and 27 deletions.
14 changes: 9 additions & 5 deletions Docker_install.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
# How to install docker and docker-compose

## Windows

- You are in WSL system,you need to adjust the local motherboard virtualization options
Press the del key to enter Bios, go to the advanced options "Intel (VMX) Virtualization Technology" or "Intel (VMX) Virtualization Technology" or "AMD-V", and set "enable on", then restart the computer (or like this picture).
- ![bios.png](user_manual/cn/img/bios.png)

- You can install WSL through https://learn.microsoft.com/en-us/windows/wsl/install or through the Microsoft Store, or by running the following command in the administrator command line:
```
WSL --install
```

- ![cmd.jpg](user_manual/cn/img/cmd.jpg)
- Now, you are in WSL system,you need to adjust the local motherboard virtualization options
Press the del key to enter Bios, go to the advanced options "Intel (VMX) Virtualization Technology" or "Intel (VMX) Virtualization Technology" or "AMD-V", and set "enable on", then restart the computer (or like this picture).
- ![bios.png](user_manual/cn/img/bios.png)


- Open the administrator command line and log into WSL.<br>
Run the command``` wsl``` or ```wsl -u [username]``` username is the username you installed before.
Expand All @@ -33,8 +36,9 @@ sudo update-alternatives --set ip6tables /usr/sbin/ip6tables-legacy
```
- Install docker-compose
```
sudo curl -L https://download.fastgit.org/docker/compose/releases/download/1.27.4/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
sudo apt-get install docker-compose
sudo rm /usr/local/bin/docker-compose
sudo ln -s /usr/bin/docker-compose /usr/local/bin/docker-compose
```
- After installing docker, give permissions to the current logged-in user. ```sudo usermod -aG docker $USER```
- Start the docker command ```sudo service docker start```
Expand Down
41 changes: 27 additions & 14 deletions Docker_install_CN.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,19 @@
## Windows

- 需要调整本地主板虚拟化选项<br>
首先重启电脑,重启电脑时不断按“F1”和“F2”和“DEL”这三个键进入Bios(因为大部分主板是这三个按键的其中一个,所以一起按,另外注意笔记本是按“ESC”键)<br>
![bios.png](user_manual/cn/img/bios1.png)
![bios.png](user_manual/cn/img/bios2.jpg)


- 你可以通过 https://learn.microsoft.com/en-us/windows/wsl/install 或者在微软商店进行安装 WSL
或者通过管理员命令行安装
```
- 然后在管理员命令行运行
```
WSL --install
```
```
- ![cmd.jpg](user_manual/cn/img/cmd.jpg)

- 如果出现,下面的提示
```
版权所有(c) Microsoft Corporation。保留所有权利。
Expand All @@ -20,12 +29,8 @@
运行: wsl --list --online 查看可以安装的版本
然后运行: wsl --install -d Ubuntu-20.04 # 这里的Ubuntu-20.04 就是版本号
```
- 然后在管理员命令行运行

- ![cmd.jpg](user_manual/cn/img/cmd.jpg)
- 需要调整本地主板虚拟化选项
电脑按del键进入Bios,进入高级选项"Intel (VMX) Virtualization Technology" or "Intel (VMX) Virtualization Technology" or "AMD-V" ,并设置"enable on",然后重启电脑" (或像下图)<br>
![bios.png](user_manual/cn/img/bios.png)


- 打开管理员命令行,登录 WSL
- 运行命令```wsl```或者 ```wsl -u [username]``` username 是你之前安装的用户名
Expand All @@ -45,17 +50,18 @@
- 启动 docker 命令```sudo service docker start```
- 检查docker 运行状态 ```service docker status``` 为 "active (running)" 或者 "Docker is running" 则为正常
- 如果遇到```Docker is not running```
- 解决方案
- 解决方案,运行下命令
```
sudo update-alternatives --set iptables /usr/sbin/iptables-legacy
sudo update-alternatives --set ip6tables /usr/sbin/ip6tables-legacy
```
- 安装 docker-compose
```
sudo curl -L https://download.fastgit.org/docker/compose/releases/download/2.23.3/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
sudo apt-get install docker-compose
sudo rm /usr/local/bin/docker-compose
sudo ln -s /usr/bin/docker-compose /usr/local/bin/docker-compose
```

- 上面安装完毕docker ,以后就不用再次安装
- 安装网络管理 命令: ```sudo apt install net-tools```
- 运行命令 ```service docker status``` 确认docker是在运行 "active (running)" <br>
- 获取本机内网IP地址,记录下来,一般是192.168.1.xxx,稍后可以用在安装路径下 如下图:<br>
Expand All @@ -65,7 +71,7 @@ sudo chmod +x /usr/local/bin/docker-compose

- (1)直接下载压做包 (推荐)
- 在WSL命令行中运行命令 : ```pwd``` 你会看到你目前的文件夹地址 比如 ```/mnt/c/Windows/system32```
- 切换到桌面,点击”<a href="https://github.com/DeepThought-AI/Holmes" target='_blank'>链接</a>“通过网页下载我们的代码 如下图
- 点击”<a href="https://github.com/DeepThought-AI/Holmes" target='_blank'>链接</a>“通过网页下载我们的代码 如下图
- ![download.png](user_manual/cn/img/download.png)
- 解压后的文件夹 "Holmes" 移动到 C:/Windows/system32 (也就是上面看到的文件夹地址,c表示C盘)
- 回到WSL命令行,运行命令```cd Holmes ```进入项目文件夹
Expand All @@ -79,8 +85,15 @@ sudo chmod +x /usr/local/bin/docker-compose
- 进入项目文件夹 ```cd Holmes ```
- 修改权限 ```sudo chmod +x ./Install.sh```
- 运行命令```sudo ./Install_cn.sh ``` 开始安装<br>
安装结束后会有一个网址提示,直接浏览器访问即可

- 安装结束后会有一个网址提示,直接浏览器访问即可<br>
(注意*关闭命令符窗口将无法访问属于Holmes网址
再次使用Holmes,打开“命令提示符”窗口“以管理员身份运行”
```
1.运行“wsl”命令
2.运行“cd Holmes”命令
3.运行“sudo docker-compose start”命令
```
就可以去浏览器中打开自己Holmes网址了【网址都是http://‘本机内网IP地址’:8338】


# Ubuntu 安装docker
Expand Down
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,6 @@ The database connections supported by Holmes are:
- Default port: 8338 8339
- Web access: http://ip:8338

## Docker command
- Enter project Holmes dir:
```
docker-compose start # start Holmes servie
docker-compose stop # stop Holmes servie
docker-compose ps # see Holmes servie states
```

## Ubuntu build
Install directly on the ubuntu system, you need to install redis, postgresql python3.8.17 environment.
Expand All @@ -82,6 +75,21 @@ Install directly on the ubuntu system, you need to install redis, postgresql pyt
- Web access: http://ip:8338


## Holmes command
- Enter project Holmes dir:
```
docker-compose start # start Holmes servie
docker-compose stop # stop Holmes servie
docker-compose ps # see Holmes servie states
```
- If it appears... PermissionError ... ' or ' Permission denied', please add 'sudo' before executing the command
```
sudo docker-compose start # start Holmes servie
sudo docker-compose stop # stop Holmes servie
sudo docker-compose ps # see Holmes servie states
```


## 📑 Other
- We have tested on Mac OS 12.7/13.X /14.1.1, Ubuntu 20.04/22.04, and Windows11 WSL 22.04. <br>If you have any question, please contact us at [email protected]
- <a href="https://github.com/DeepThought-AI/Holmes/issues">Issue</a>
Expand Down
9 changes: 8 additions & 1 deletion README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,14 +69,21 @@ Holmes 支持的数据库连接有:
完成安装后, 请看上面的使用说明进行设置和使用
- 查看本机IP ```ifconfig | grep -Eo 'inet (addr:)?([0-9]*\.){3}[0-9]*' | grep -vE '^inet 127(\.[0-9]{1,3}){3}'```

## docker命令 或 Ubuntu 启动后命令
## Holmes 命令

- 进入项目目录后运行命令:
```
docker-compose start # 启动Holmes 服务
docker-compose stop # 停止Holmes 服务
docker-compose ps # 查看 Holmes 服务
```
- 如果出现 ```... PermissionError ...``` 或者 ```... Permission denied ...``` 请在执行命令前 加sudo
```
sudo docker-compose start # 启动Holmes 服务
sudo docker-compose stop # 停止Holmes 服务
sudo docker-compose ps # 查看 Holmes 服务
```




Expand Down
Binary file added user_manual/cn/img/bios1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added user_manual/cn/img/bios2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d5dbe5b

Please sign in to comment.