BookStack靠欢，基于MinDoc廊敌，使用Beego開發(fā)的在線文檔管理系統(tǒng)，基于Apache開源協(xié)議门怪，功能類似Gitbook和看云骡澈。

開源地址：

Github: https://github.com/TruthHun/BookStack

Gitee:https://gitee.com/truthhun/BookStack

下面我們來介紹使用Ubuntu搭建站點。

安裝寶塔控制面板(非必須)

如果你已經(jīng)有l(wèi)nmp環(huán)境了掷空，則不需要安裝肋殴。

寶塔官網(wǎng)：http://www.bt.cn

安裝命令：

wget -O install.sh http://download.bt.cn/install/install-ubuntu.sh && sudo bash install.sh

安裝完寶塔控制面板之后囤锉，登錄面板，安裝"lnmp"（Linux护锤、Nginx官地、MySQL、PHP）

安裝默認的即可

安裝寶塔面板烙懦，主要是為了方便管理站點驱入，如反向代理、SSL等

安裝中文字體（非必須氯析，但是建議安裝）

有的Linux服務(wù)器并沒有支持中文字體亏较，需要手動安裝。

安裝命令：

apt install ttf-wqy-zenhei
apt install fonts-wqy-microhei

安裝中文字體支持掩缓，主要是為了避免Linux系統(tǒng)不支持中文的時候雪情，導(dǎo)致導(dǎo)出文檔的時候出現(xiàn)亂碼。

安裝calibre

calibre官網(wǎng)：https://www.calibre-ebook.com/

安裝命令：

sudo -v && wget -nv -O- https://download.calibre-ebook.com/linux-installer.py | sudo python -c "import sys; main=lambda:sys.stderr.write('Download failed\n'); exec(sys.stdin.read()); main()"

執(zhí)行下面命令你辣，能看到版本號巡通，表示安裝成功。

ebook-convert --version

注意：

• 這里要安裝最新版的calibre舍哄，執(zhí)行上述命令扁达，安裝的就是最新版的了。
• 如果出現(xiàn)warning的提示蠢熄，直接不用理會即可;error級別的提示跪解，網(wǎng)上搜下看下如何解決

calibre主要用于將文檔導(dǎo)出生成pdf、epub签孔、mobi文檔叉讥。

本人已經(jīng)使用Go語言對calibre導(dǎo)出pdf、epub饥追、mobi文檔進行了一層封裝图仓，歡迎大家給個star ==》https://github.com/TruthHun/converter

測試

隨便創(chuàng)建一個txt文件

echo "Hello BookStack。你好但绕，書棧救崔。" > test.txt

轉(zhuǎn)成pdf

ebook-covert test.txt test.pdf

查看測試的轉(zhuǎn)化效果，主要看下轉(zhuǎn)化的過程中有沒有報錯捏顺，以及轉(zhuǎn)化后的文檔有沒有出現(xiàn)中文亂碼六孵。

安裝Chrome

直接使用命令一鍵安裝：

apt install chromium-browser

執(zhí)行以下命令，如果能打印百度頁面代碼幅骄，則表示安裝成功劫窒。

chromium-browser --headless --disable-gpu --dump-dom --no-sandbox https://www.baidu.com

這個主要用于在發(fā)布文檔的時候，渲染未被渲染的markdown文檔拆座，以及強力模式下的網(wǎng)頁采集主巍。

安裝supervisor

安裝命令：

apt install supervisor

判斷是否安裝成功:

supervisord --version

顯示版本號冠息，即表示安裝成功。

supervisor主要用于將程序加入到系統(tǒng)守護進程

Supervisord 安裝完成后有兩個可用的命令行 supervisord 和 supervisorctl孕索，命令使用解釋如下：

• supervisord逛艰，初始啟動 Supervisord，啟動搞旭、管理配置中設(shè)置的進程散怖。
• supervisorctl stop programxxx，停止某一個進程(programxxx)选脊，programxxx 為 [program:beepkg] 里配置的值，這個示例就是 beepkg脸甘。
• supervisorctl start programxxx恳啥，啟動某個進程
• supervisorctl restart programxxx，重啟某個進程
• supervisorctl stop groupworker: 丹诀，重啟所有屬于名為 groupworker 這個分組的進程(start,restart 同理)
• supervisorctl stop all钝的，停止全部進程，注：start铆遭、restart硝桩、stop 都不會載入最新的配置文件。
• supervisorctl reload枚荣，載入最新的配置文件碗脊，停止原有進程并按新的配置啟動、管理所有進程橄妆。
• supervisorctl update衙伶，根據(jù)最新的配置文件，啟動新配置或有改動的進程害碾，配置沒有改動的進程不會受影響而重啟矢劲。

部署程序

下載Linux版的程序

https://github.com/TruthHun/BookStack/releases

在本地解壓，修改配置文件

配置文件在conf目錄慌随。

配置數(shù)據(jù)庫和文檔導(dǎo)出項

把app.conf.example命名為app.conf,并根據(jù)提示芬沉，修改配置。這里主要修改MySQL數(shù)據(jù)庫的配置以及生成下載文檔的配置阁猜。其他項能不改就不改丸逸。

# 程序名稱
appname = BookStack

# 程序版本
version = v1.0.0

# 監(jiān)聽端口
httpport = 8181

# 運行模式。開發(fā)時剃袍，請設(shè)置為開發(fā)模式"dev"椭员，即development；部署時笛园，請設(shè)置為產(chǎn)品模式"prod"隘击，即product侍芝。dev模式下，會打印各種調(diào)試信息
runmode = dev

# 是否開啟session埋同，這個必須開啟州叠，否則沒法玩了。
sessionon = true

# session名稱凶赁，這個你自己定咧栗。
sessionname = bookstack
copyrequestbody = true

# 啟動gzip壓縮，則設(shè)置為true虱肄，否則設(shè)置為false致板。建議啟動
EnableGzip=true

# 要壓縮的靜態(tài)文件擴展名，其中.xml是sitemap站點地圖壓縮咏窿。建議按照這個來就行了
StaticExtensionsToGzip = .css, .js, .xml


# 默認Session生成Key的秘鑰
beegoserversessionkey=bookstack

########Session儲存方式##############
#以文件方式儲存
sessionprovider=file
sessionproviderconfig=store/session

# 靜態(tài)目錄斟或。這個是站點地圖的靜態(tài)目錄
StaticDir = sitemap:sitemap

#生成下載文檔的時間間隔。也就是距離用戶第一次點擊生成下載文檔到第二次點擊生成下載文檔的時間間隔集嵌，避免用戶頻繁點擊生成下載文檔而導(dǎo)致大量耗費服務(wù)器資源導(dǎo)致服務(wù)器宕機
GenerateInterval=300

# 站點可直接訪問的靜態(tài)文件【注意萝挤，這里千萬不能配置.conf文件擴展名，否則會把.conf文件當(dāng)做靜態(tài)文件而被外部訪問根欧，導(dǎo)致數(shù)據(jù)庫賬號密碼等泄露怜珍。按照默認的來即可】
StaticExt=.txt,.xml,.ico,.png,.jpg,.jpeg,.gif,.html

#評論時間間隔，每次發(fā)表評論凤粗，限定間隔秒數(shù)酥泛，避免被惡意刷評論
CommentInterval=10

# 生成下載文檔時導(dǎo)出pdf文檔的配置，這里建議把關(guān)于bookstack.cn的信息替換成你自己的就行嫌拣，其他的建議不要動
exportHeader=<p style='color:#8E8E8E;font-size:12px;'>_SECTION_</p>
exportFooter=<p style='color:#8E8E8E;font-size:12px;'>本文檔使用 <a  style='text-decoration:none;color:#1abc9c;font-weight:bold;'>書棧(BookStack.CN)</a> 構(gòu)建 <span style='float:right'>- _PAGENUM_ -</span></p>
exportFontSize=14
exportPaperSize=a4
exportCreator=書棧(BookStack.CN)
exportMarginLeft=72
exportMarginRight=72
exportMarginTop=72
exportMarginBottom=72

#時區(qū)設(shè)置
timezone = Asia/Shanghai

####################MySQL 數(shù)據(jù)庫配置###########################
db_adapter=mysql

# 您的數(shù)據(jù)庫host
db_host=

#您的數(shù)據(jù)庫端口
db_port=3306

#您的數(shù)據(jù)庫用戶名
db_username=

# 您的數(shù)據(jù)庫密碼
db_password=

#您使用的數(shù)據(jù)庫
db_database=bookstack



# 靜態(tài)資源域名揭璃，沒有則留空。比如你將static目錄下的所有靜態(tài)資源都放到了專門的服務(wù)器上亭罪，那么這個域名就行用來訪問你的靜態(tài)資源的域名瘦馍。
static_domain=http://static.bookstack.cn

# 谷歌瀏覽器，用于發(fā)布內(nèi)容的時候渲染未被渲染的markdown应役。建議安裝最新版的Chrome瀏覽器情组，并把Chrome瀏覽器加入系統(tǒng)環(huán)境變量。
# 使用Chrome的headless去處理箩祥。之前考慮使用phantomjs的院崇，但是phantomjs有些小問題，不如Chrome強大袍祖。
chrome=chromium-browser

#項目默認封面
cover=/static/images/book.png

#默認頭像
avatar=/static/images/avatar.png

#默認閱讀令牌長度
token_size=12

#上傳文件的后綴
upload_file_ext=txt|doc|docx|xls|xlsx|ppt|pptx|pdf|7z|rar|jpg|jpeg|png|gif

####################郵件配置######################
#是否啟用郵件
enable_mail=true
#每小時限制指定郵箱郵件發(fā)送次數(shù)
mail_number=5
#smtp服務(wù)用戶名
smtp_user_name=
#smtp服務(wù)器地址
smtp_host=
#smtp密碼
smtp_password=
#端口號
smtp_port=25
#發(fā)送郵件的顯示名稱
form_user_name=

#接收回件的郵箱底瓣。留空則表示使用發(fā)送郵件的郵箱作為接收回件郵箱
reply_user_name=

#郵件有效期30分鐘
mail_expired=30


################Active Directory/LDAP################
#是否啟用ldap
ldap_enable=false
#ldap主機名
ldap_host=ad.example.com
#ldap端口
ldap_port=3268
#ldap內(nèi)哪個屬性作為用戶名
ldap_attribute=sAMAccountName
#搜索范圍
ldap_base=DC=example,DC=com
#第一次綁定ldap用戶dn
ldap_user=CN=ldap helper,OU=example.com,DC=example,DC=com
#第一次綁定ldap用戶密碼
ldap_password=superSecret
#自動注冊用戶角色：0 超級管理員 /1 管理員/ 2 普通用戶 
ldap_user_role=2
#ldap搜索filter規(guī)則,AD服務(wù)器: objectClass=User, openldap服務(wù)器: objectClass=posixAccount ,也可以定義為其他屬性,如: title=mindoc
ldap_filter=objectClass=posixAccount


include "oss.conf"
include "oauth.conf"

配置OSS

1、登錄你的阿里云，進入OSS捐凭，創(chuàng)建一個只讀Bucket拨扶。
2、在本地隨便創(chuàng)建一個txt文檔茁肠，將下面兩行粘貼進去：

styleName:cover,styleBody:image/resize,m_fill,w_175,h_230,limit_0/auto-orient,1/quality,q_100
styleName:avatar,styleBody:image/resize,m_fill,w_100,h_100,limit_0/auto-orient,1/quality,q_90

3患民、在OSS的圖片處理-導(dǎo)入樣式中，將該txt文檔導(dǎo)入

1516802da0987a00.png

4垦梆、將oss.conf.example修改成oss.conf匹颤，并根據(jù)您的阿里云OSS，配置該文件托猩。

# 阿里云OSS配置
[oss]

# 是否是內(nèi)網(wǎng)印蓖，如果您的阿里云服務(wù)器和OSS是同一內(nèi)網(wǎng)，請設(shè)置為true京腥，這樣能更快地將文件移到oss上赦肃，否則設(shè)置為false。
# 一般情況下绞旅，在開發(fā)階段摆尝，設(shè)置為false
IsInternal=false

# 內(nèi)網(wǎng)Endpoint,如：oss-cn-hongkong-internal.aliyuncs.com
EndpointInternal=

# 外網(wǎng)Endpoint温艇，如：oss-cn-hongkong.aliyuncs.com
EndpointOuter=


# 您的阿里云AccessKeyId
AccessKeyId=

# 您的阿里云AccessKeySecret
AccessKeySecret=

# 只讀狀態(tài)的Bucket因悲，不要私有的，也不要公共讀寫的
Bucket=

# oss中綁定的域名勺爱，如果您沒有綁定域名晃琳，則使用阿里云oss的自帶域名也行
Domain=

配置第三方登錄

將oauth.conf.example重命名成oauth.conf,并根據(jù)提示修改配置。

# 第三方登錄配置
[oauth]

##### Gitee(碼云) ####
# 申請地址（需要先登錄）：https://gitee.com/oauth/applications

# 您的ClientId
giteeClientId=

# 您的ClientSecret
giteeClientSecret=

# 回調(diào)地址琐鲁，把下面的bookstack.cn的域名換成你的即可
giteeCallback=http://www.bookstack.cn/login/gitee

# 下面這兩項不要動
giteeAccesstoken=https://gitee.com/oauth/token
giteeUserInfo=https://gitee.com/api/v5/user



######## GitHub ########
# 申請地址(需要先登錄你的GitHub)：https://github.com/settings/developers

# 您的ClientId
githubClientId=

# 您的ClientSecret
githubClientSecret=

# 回調(diào)地址卫旱，把下面的bookstack.cn的域名換成你的即可
githubCallback=http://www.bookstack.cn/login/github

# 下面這兩項不要動
githubAccesstoken=https://github.com/login/oauth/access_token
githubUserInfo=https://api.github.com/user



#### QQ ####
# 申請地址（需要先登錄你的QQ）:https://connect.qq.com/manage.html

#ClientId，即 APP ID
qqClientId=

#ClientSecret围段，即 APP Key
qqClientSecret=

# 回調(diào)地址顾翼，把下面的bookstack.cn的域名換成你的即可
qqCallback=http://www.bookstack.cn/login/qq

# 下面這三項不要動
qqAccesstoken=https://graph.qq.com/oauth2.0/token
qqOpenId=https://graph.qq.com/oauth2.0/me
qqUserInfo=https://graph.qq.com/user/get_user_info

### TODO 微信和微博登錄，主要是我這邊忘記了以前注冊的個人開發(fā)者信息奈泪，當(dāng)前沒開發(fā)适贸，后續(xù)會開發(fā)出來 ####

上傳和部署

1、將修改和配置好了的程序壓縮涝桅，上傳到站點根目錄下拜姿，解壓。
2冯遂、執(zhí)行數(shù)據(jù)庫安裝蕊肥。程序安裝一些站點配置項、SEO項等蛤肌。命令：

./BookStack install

3壁却、配置反向代理
寶塔面板用戶批狱，直接在站點的設(shè)置里面配置反向代理，但是需要注意的是儒洛，需要修改緩存精耐，如把下面兩句注釋掉：

add_header X-Cache $upstream_cache_status;
        
expires 12h;

Nginx反向代理配置參考(寶塔的配置)：

server
{
    listen 80;
    server_name demo.bookstack.cn;
    index index.php index.html index.htm default.php default.htm default.html;
    root /www/wwwroot/demo.bookstack.cn;
    
    
    location / 
    {
        proxy_pass http://localhost:8181;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header REMOTE-HOST $remote_addr;
        
        #緩存相關(guān)配置
        #proxy_cache cache_one;
        #proxy_cache_key $host$request_uri$is_args$args;
        #proxy_cache_valid 200 304 301 302 1h;
        
        #持久化連接相關(guān)配置
        #proxy_connect_timeout 30s;
        #proxy_read_timeout 86400s;
        #proxy_send_timeout 30s;
        #proxy_http_version 1.1;
        #proxy_set_header Upgrade $http_upgrade;
        #proxy_set_header Connection "upgrade";
    }
    
    location ~ .*\.(php|jsp|cgi|asp|aspx|flv|swf|xml)?$
    {
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header REMOTE-HOST $remote_addr;
        proxy_pass http://localhost:8181;
        
    }
    #PROXY-END

    include enable-php-54.conf;
    #PHP-INFO-END
    
    #REWRITE-START URL重寫規(guī)則引用,修改后將導(dǎo)致面板設(shè)置的偽靜態(tài)規(guī)則失效
    include /www/server/panel/vhost/rewrite/demo.bookstack.cn.conf;
    #REWRITE-END
    
    #禁止訪問的文件或目錄
    location ~ ^/(\.user.ini|\.htaccess|\.git|\.svn|\.project|LICENSE|README.md)
    {
        return 404;
    }
    
    access_log  off;
}

加入系統(tǒng)守護進行

1、進入supervisor的配置目錄

cd /etc/supervisor/conf.d/

2琅锻、配置守護進程
創(chuàng)建bookstack.conf文件卦停，并配置。

[program:BookStack]
directory = 你的程序目錄
command =你的程序執(zhí)行命令
autostart = true
autorestart=true
user = 啟動該程序的用戶
redirect_stderr = true
stdout_logfile = 日志地址

配置示例：

[program:BookStack]
directory = /www/wwwroot/demo.bookstack.cn
command =/www/wwwroot/demo.bookstack.cn/BookStack
autostart = true
autorestart=true
user = root
redirect_stderr = true
stdout_logfile = /var/log/supervisor/BookStack.log

配置完成之后恼蓬，重啟supervisor

supervisorctl reload

總結(jié)

安裝BookStack惊完，需要先配置環(huán)境，安裝依賴：Nginx处硬、MySQL小槐、calibre、chorme（chromium-browser）荷辕、supervisor凿跳，然后修改配置文件，配置MySQL數(shù)據(jù)庫疮方、OSS和第三方登錄控嗜，然后上傳部署和配置反向代理以及加入守護進程。