>[danger] **棄用提醒:**
> *由于看云對于免費用戶的限制愈發嚴苛,本文檔已經遷移至語雀。本文檔將不做維護。*
> **語雀地址**:[https://www.yuque.com/a632079/nodebb](https://www.yuque.com/a632079/nodebb)
*****
# 使用
[TOC]
>[info] NodeBB v1.7.1 擴充了一些指令。文檔已經跟進,如您發現部分指令無法使用,請升級至 v1.7.1(截止 `11.26` 尚未發布)

目前,腳本提供了幾個選項參數:
```
-V, --version 輸出 NodeBB 版本號
--json-logging 以 JSON 的形式輸出日記
--log-level <level> 指定默認顯示的日記最低等級,如 `info`
-d, --dev 開發模式 (默認日記等級為: `verbose`)
-l, --log 同時將日記輸出到終端 (console) 中
-c, --config <value> 指定 config 文件的位置
-h, --help 輸出使用幫助
```
## NodeBB 指令
本小節講的是 NodeBB 中提供的不同操作指令
### 啟動 NodeBB
>
```
./nodebb start
```
### 停止 NodeBB

```
./nodebb stop
```
### 重啟 NodeBB
```
./nodebb restart
```
### 查看 NodeBB 運行狀態


```
./nodebb status
```
### 查看日記

通過該指令,你可以查看到 NodeBB 運行過程中記錄的一些事件,以及錯誤。為了方便排查問題,請在詢問問題前,附帶該界面的截圖!
```
./nodebb log
```
### 配置 NodeBB
該指令僅供初始化 NodeBB 時使用。如果您對 `config.json` 進行了修改,那么在執行這條指令時會移除相關的條目。
```
./nodebb setup
```
### 啟動 NodeBB 安裝服務


啟動 NodeBB 的 Web 安裝頁面來進行直觀得進行配置 NodeBB
```
./nodebb install
```
### 編譯靜態文件


```
./nodebb build [targets]
```
> 如果不指定對象,默認全部編譯
可指定的編譯對象:
```
對象 | 別名
--------------------------------------------------------------------------------------------------------------------------------------------
"plugin static dirs" # 插件靜態目錄 | staticdirs
"requirejs modules" # require載入的js模塊 | rjs, modules
"client js bundle" # 客戶端(瀏覽器)使用的js | clientjs, clientscript, clientscripts
"admin js bundle" # Admin面板使用的js | adminjs, adminscript, adminscripts
"javascript" # 全部的 js | js
"client side styles" # 客戶端樣式文件(less,css) | clientcss, clientless, clientstyles, clientstyle
"admin control panel styles" # Admin 面板的樣式文件 | admincss, adminless, adminstyles, adminstyle, acpcss, acpless, acpstyles, acpstyle
"styles" # 全部的樣式文件 | css, less, style
"templates" # tpl模板文件 | tpl
"languages" # 語言文件 | lang, i18n
"sounds" # 聲音文件 | sound
```
### 更新 NodeBB

>[warning] 該指令并不能直接升級 NodeBB ,僅僅是為了 在升級 NodeBB 后對于數據庫,本地結構的升級。
該條指令有以下功能:
* 更新 NodeBB 數據庫,本地文件結構
* 更新插件 (版本檢查 基于 packages.nodebb.org)
* 直接執行指定的升級腳本(用于解決未正確更新的問題)
你也可以只使用他的部分選項,以直接使用你想要的功能:
```
選項:
-m, --package 從 defaults 文件更新 package.json
-i, --install 更新基礎依賴
-p, --plugins 檢測插件更新
-s, --schema 更新 NodeBB 數據庫結構
-b, --build 重新編譯靜態資源
-h, --help 輸出使用幫助信息
```
```
./nodebb upgrade
```
### 查看環境信息

該指令用于查看當前系統安裝的 NodeBB 版本 以及數據庫(Redis,Mongodb)版本
```
./nodebb info
```
### 查看已啟用插件列表

```
./nodebb plugins
```
### 啟動的同時,查看日記

```
./nodebb slog
```
### 查看管理員操作事件(近10個)

通過該指令,可以很方便得觀察到管理員的操作事件,以便在特殊情況下排查是哪個成員,破壞/修改了程序。
```
./nodebb events
```
### 開發者模式 (1.7.1 起 不再是直接的指令)
該模式有如下特點:
* 直接啟動,附帶日記。日記更加詳細。
* 插件庫直接讀取,無需編譯。
* 信息更加詳細。
* 關閉窗口,進程終止。

**需要注意: 開發者模式中讀取的插件模板仍然是編譯過的模板,所以插件模板如果變動,請先編譯模板。**
```
./nodebb --dev start
```
同時,經過測試發現。依舊支持老版本的啟動方式:
```
./nodebb dev
```
### 重置功能

```
# 參數
使用 ./nodebb reset {-t|-p|-w|-s|-a}
-t 主題 [主題名]
-p 插件 [插件名]
-w 窗口部件
-s 設置
-a 以上所有
```
插件和主題的標識 (-p & -t) 可以禁用單一成員
例如: ./nodebb reset -p nodebb-plugin-mentions, ./nodebb reset -t nodebb-theme-persona
前綴是可選的,例如:. ./nodebb reset -p markdown, ./nodebb reset -t persona
#### 插件
* 停用所有插件
```
./nodebb reset -p
```
* 停用指定插件
```
./nodebb reset -p plugin-name
```
#### 主題
* 重置至默認主題
```
./nodebb reset -t
```
* 重置至指定主題(相當于切換主題)
```
./nodebb reset -t theme-name
```
#### 窗口部件
禁用所有的窗口部件
```
./nodebb reset -w
```
#### 設置
恢復默認設置
```
./nodebb reset -s
```
#### 重置所有
回到初始化狀態
```
./nodebb reset -a
```
### 激活插件

該指令將會在下一次NodeBB啟動時激活插件。
> [info] 前綴 `nodebb-plugin` 是可選的
```
./nodebb activate plugin-name
```
## 社區使用
>[info] 該塊暫未編輯。目前請各位自行摸索吧,挺簡單的。
--------------
>[info] 編寫: PA Team
維護: PA Team
審核: PA Team
最后更新: 2017.11.26
- 序
- 贊助
- 導言
- 安裝
- 通過操作系統
- Windows + Mongodb/Redis
- Ubuntu/Debian + Redis/Mongodb
- CentOS + Redis
- CentOS + Mongodb
- FreeBSD/OpenBSD + Redis
- Arch Linux + Redis
- OSX + Redis
- 通過云服務
- 通過主機面板安裝
- AppNode
- CPanel
- 寶塔
- 使用
- FAQ
- 高級
- 運行 NodeBB
- 配置 Config.json
- 配置 Nginx
- 配置 MongoDB
- 更新 NodeBB
- 設置 Widgets
- 安裝 Yarn
- 更新 MongoDB
- 數據庫備份與恢復
- 重置管理員密碼
- 讓 NodeBB 支持搜索
- 優化
- 優化配置,提升NodeBB處理能力
- Google字體庫 -> 360公共前端庫
- Google字體庫 -> 中科大鏡像
- 海外VPS提升NodeBB訪問速度
- 通過 NodeBB API 自動發帖
- 開發
- 準備
- 常用方法 & 變量
- 插件制作
- 使用工具包編寫一個插件
- 主題制作
- 使用工具包編寫一個主題
- 部件制作
- 國際化
- 鉤子(hook)使用說明