---
# System prepended metadata

title: '[CodiMD 2.4.0 - Papilio maraho](/qaQJuKLNRxqlU36Ow7WsSw) Install'

---

# [CodiMD 2.4.0 - Papilio maraho](/qaQJuKLNRxqlU36Ow7WsSw) Install

:::info 
:bulb: 安裝 CodiMD 2.4.0
:::


## :+1: 說明

:::success
描述 CodiMD 的一些資訊
:::

### :small_blue_diamond: 官方文件: [CodiMD 2.4.0 - Papilio maraho](/qaQJuKLNRxqlU36Ow7WsSw)
### :small_blue_diamond: 官方 source code: https://github.com/hackmdio/codimd
### :small_blue_diamond: 內存: http://10.78.26.44:30000/cloud_infra2/codimd

## 📈  安裝方法

:::success
這邊描述了以 helm install 方式來手動安裝 codimd 的這部份
:::

 - Step1 從 git下載 code
```
root@henrydu7:~# git clone ssh://git@10.78.26.44:30001/cloud_infra2/codimd.git
Cloning into 'codimd'...
remote: Enumerating objects: 132, done.
remote: Counting objects: 100% (132/132), done.
remote: Compressing objects: 100% (90/90), done.
remote: Total 135 (delta 59), reused 91 (delta 35), pack-reused 3
Receiving objects: 100% (135/135), 27.42 KiB | 359.00 KiB/s, done.
Resolving deltas: 100% (59/59), done.

```
- Step2 進入 codimd 的 helm chart 目錄
```
root@henrydu7:~# cd codimd/helm-chart
root@henrydu7:~/codimd/helm-chart# ls -la
total 28
drwxr-xr-x 3 root root 4096 Apr  6 01:22 .
drwxr-xr-x 4 root root 4096 Apr  6 01:22 ..
-rw-r--r-- 1 root root 1399 Apr  6 01:22 Chart.yaml
drwxr-xr-x 2 root root 4096 Apr  6 01:22 templates
-rw-r--r-- 1 root root 6896 Apr  6 01:22 values-argocd.yaml
-rw-r--r-- 1 root root 3936 Apr  6 01:22 values-production.yaml

```
- Step3 建立一個 kubernetes 的 namespace,這是可自訂成想要的名字，這邊就取名做 codimd
```
root@henrydu7:~/codimd# kubectl create ns codimd
namespace/codimd created
```

- Step4 使用 helm install 來安裝 codimd
```
root@henrydu7:~/codimd/helm-chart# helm install codimd -ncodimd -f values-production.yaml .

```
## :100: 安裝完畢後的檢查項目

:::success
這裡列出安裝完畢後的檢查項目
:::
        
1. 顯示出 codimd 的頁面，可用瀏覽器查看 http://<k8s_ip>:31012/s/user-guide
2. 

## 🤔 排解可能遇到的狀況和其他補充事項

:::success
將遇到的狀況持續補充在這裡
:::

### 1. 以 helm install 的 codimd 需安裝在 kubernetes 的 server 上，因此 port 和版本跟 kubernetes 本身有一些相關性

解決方法: kubernetes 的 server 版本需大於 1.14 以上，並且 service port 範圍需在 30000-32767  

### 2. 由於 codimd 2.4.0 以上有 fix 了 XSS 的 security issue, 用 2.4.0 之前的版本去做弱點掃描是會出現 XSS security severity 的問題

XSS security issue fix 的相關連結:<br> https://github.com/hackmdio/codimd/pull/1650  

### 3. 
解決方法:  
