bookstack教學

bookstack相關資訊

安裝

安裝

Prerequisite(前提條件)

  1. 準備好Linux OS
  2. 準備好容器主機
    RockyLinux安裝Docker
    RockyLinux安裝Podman
  3. 準備好mariadb 資料庫容器
    RockyLinux安裝mariadb
安裝

實戰(使用docker)

設定容器volume

docker volume create bookstack_config

我通常能不用Dockerfile就不用，習慣直接下指令

docker run --restart=always -d --name=bookstack -e PUID=1000 -e PGID=1000 -e TZ=Asia/Taipei \
-v /usr/share/fonts:/usr/share/fonts -e APP_URL=https://<網址需要https>   \
-e DB_HOST=<mariadb 資料庫ip>   -e DB_PORT=3306   -e DB_USER=<帳號>   -e DB_PASS=<密碼>   -e DB_DATABASE=bookstackapp  \
-e QUEUE_CONNECTION= `#optional` -p 6875:80 -v bookstack_config:/config --restart unless-stopped   lscr.io/linuxserver/bookstack:v23.10.4-ls119

上面指令需要注意:

1. APP_URL 必須為https請準備好反向代理程式，當然也可以是ip，ip就不需要https

2. DB_HOST、DB_PORT、DB_USER、DB_PASS 以及 DB_DATABASE 都是mariadb database連線資訊

3. 6875:80 將本體主機的6875拿來對應到容器的80

4. /usr/share/fonts使用本體的字型，這樣就不浪費空間了
fonts目錄下，需再另外存放中文檔案，以下是免費豆腐自型

請到此下載中文字型
https://fonts.google.com/noto/specimen/Noto+Sans+SC
https://fonts.google.com/noto/specimen/Noto+Sans+TC


5.  容器 Image  lscr.io/linuxserver/bookstack:v23.10.4-ls119 

請參考   https://github.com/BookStackApp/BookStack


6. TZ=Asia/Taipei  系統時間

請參考 https://worldtimeapi.org/timezone/

安裝完畢後，請自行測試，預設帳號 admin@admin.com 密碼 password
登入後請修改email，修改後的email即為登入帳號；登入後請立即修改密碼

修改讓匯出pdf不會有亂碼

我後來發現匯出PDF功能只是將html轉為PDF檔案，並無特別排版，所以有點雞肋，但強迫症讓我必須解決中文亂碼文提

### 進入容器
docker exec -it bookstack bash

### 刪除預設的qt5
apk del qt5-qtbase

### 修改repositories 
vi /etc/apk/repositories
### 將 3.18改成3.14
http://dl-cdn.alpinelinux.org/alpine/v3.14/main
http://dl-cdn.alpinelinux.org/alpine/v3.14/community
###

# 套用
apk update
apk upgrade
apk add wkhtmltopdf

### 測試-無法產生test.pdf 則代表失敗 
wkhtmltopdf test.html test.pdf

### 修改 .env 檔案
vi /app/www/.env
###
WKHTMLTOPDF=/usr/bin/wkhtmltopdf
ALLOW_UNTRUSTED_SERVER_FETCHING=true
###

離開容器並且重啟，就能正常匯出中文PDF

隱藏最近更新足跡

管理帳號登入後，請在
Settings->Customization->Custom HTML Head Content
(設定->自訂->自訂 HTML 標題內容) 
加上以下控制碼即可

<style>
  .tri-layout-left { visibility: hidden; }
  .tri-layout-right { visibility: hidden; }
</style>
<script>
	window.addEventListener('DOMContentLoaded', (event) => {
		const loginShowing = document.querySelector('a[href$="/login"]') == null;
		const leftPanel = document.querySelector("div.tri-layout-left");
		const rightPanel = document.querySelector("div.tri-layout-right");
		if (loginShowing) {
			leftPanel.style.visibility = 'visible';
			rightPanel.style.visibility = 'visible';
		}
	});
</script>

預設展開「章節」內容

管理帳號登入後，請在
Settings->Customization->Custom HTML Head Content
(設定->自訂->自訂 HTML 標題內容) 
加上以下控制碼即可

<style>
    .chapter-contents-toggle {
        display: none !important;
    }
    .inset-list {
        display: block !important;
    }
</style>

隱藏書本封面

管理帳號登入後，請在
Settings->Customization->Custom HTML Head Content
(設定->自訂->自訂 HTML 標題內容) 
加上以下控制碼即可

<style> 
.entity-list-item-image.bg-book { background-image: none !important; width: 5px; } .entity-list-item-image.bg-book * { display: none !important; }

.bg-book.featured-image-container-wrap .featured-image-container {
    height: 2px;
    min-height: 2px;
    background-image: none !important; 
}
.bg-book.featured-image-container-wrap *:not(.featured-image-container) {
    display: none !important;
}
</style>

安裝

整合網域主控站(Active Directory)

1. 綁定管理者角色

網域主控站新增一個群組「BookStackAdmin」

image.png

BookStack選定Admin角色，在「外部身分驗證ID」輸入BookStackAdmin，與網域群組「BookStackAdmin」綁定

image.png

    網域使用者帳號，只要隸屬於BookStackAdmin角色，就會有BookStack系統管理者權限

    image.png

    2. 修改設定檔案，用以綁定網域帳號登，

    docker容器為例子， vi /app/www/.env

    AUTH_METHOD=ldap
LDAP_SERVER=<網域主控站IP>:389
LDAP_BASE_DN="DC=test,DC=com,DC=tw"
LDAP_DN="CN=book,CU=users,DC=test,DC=com,DC=tw"
LDAP_PASS="password"
LDAP_GROUP_ATTRIBUTE="memberOf"
LDAP_USER_FILTER=(&(sAMAccountName=${user}))
LDAP_VERSION=3
LDAP_ID_ATTRIBUTE=BIN;objectGUID
LDAP_EMAIL_ATTRIBUTE=mail
LDAP_DISPLAY_NAME_ATTRIBUTE=cn
LDAP_THUMBNAIL_ATTRIBUTE=thumbnailPhoto
LDAP_START_TLS=false
LDAP_USER_TO_GROUPS=true
LDAP_REMOVE_FROM_GROUPS=false

    以上設定值需調整：

    1. LDAP_SERVER
    2. LDAP_BASE_DN
    3. LDAP_DN
    4. LDAP_PASS

    重開服務，請使用有網域管理員Domain Admins的帳號登入，測試是否能正常登入，以及是否有管理權限

    安裝

    預設語系

    https://www.bookstackapp.com/docs/admin/language-config/

    以docker 為例子，修改.env 

    image.png

    加上 APP_LANG=zh_TW 就可以改成繁體中文了

    刪除頁面的「修改紀錄」

    1. 先確認revision號碼，然後再進資料表「page_revisions」將該紀錄刪除

    image.png

    2. 重新編排號碼

    因為刪除了#14這個修改紀錄，咱們需要連到資料庫，找到「page_revisions」這個Table，再搜尋到與該書本所有相關的修改紀錄，將這些紀錄的「revision_number」的欄位數值修改成正確的，例如#15改成#14、#16改成#15

    image.png

    3. 修正「修訂版本」數量

    image.png

    我們刪除紀錄，顯示出來的修改數量會錯誤，刪除了幾個，就要減少幾個。
    家人們需要連到資料庫，找到「pages」這個Table，，再搜尋到該書本，將欄位「revision_count」改成正確的數量

    image.png

    4. 刪除「稽核紀錄」

    兄弟我們需要連到資料庫，找到「activities」這個Table，將欄位「Type」裡面有字樣為"revision delete"的資料行刪除

    image.png

    為何想要「刪除修改紀錄」

    這個系統很適合拿來做成ISO線上查閱系統，也適合所有ISO文件雲端化，進而以web方式呈現；
    Web化的ISO文件需要幾件事情讓讓稽核員信服：

    1. 資通安全控管(防火牆，限定IP)
    2. 風險管控、軟體確效
    3. 主管確認流程、上架流程
    4. 修訂版本、差異

    第4項最麻煩，一般公司常常有些資料弄錯，我們需要神不知鬼不覺將資料修正，並且不讓稽核員發現記缺失，才會有刪除「修改紀錄」的需求。

    封面

    書本封面

    書本的封面為 440x250 ， 這個系統吃素不化妝的，建議設定封面會好看多了

    2023-12-14 09_41_09-About the World Book and Copyright Day in Brazil _ UNESCO.png

    bookstack好用功能「變動日誌」，可用來當作ISO文管系統了

    每次ISO稽核，稽核員一定會查核「文件的修訂紀錄」、「文件是否有回收機制」、「文件不可下載、列印」等功能

    令人驚艷的是bookstack居然有修訂紀錄的功能，而且使用上非常方便，只要在點選「儲存頁面」前，將編修原因寫在「設定變更日誌」就可以了。

     

    修改完畢，先點選下方圖示「設定變更日誌」，輸入「變更理由」。

    image.png

    下圖①為變更理由，輸入完畢按一下儲存頁面即可。

    image.png

    查看版本變動日誌

    image.png


     

    原本我以為沒有commit message這功能，還想說要自己來改程式。我以前寫過php 2、php 3，現在都8了，真的很不自量力。

    image.png

     

    bookstack如何崁入影片(撥放狀態)

    若沒有串流網站或是影片不放在YT，就只能上傳影片檔案，然後引用做成網頁撥放狀態

    1. 上傳影片檔案

      image.png

      image.png
      檔案上傳後，請複製檔案網址


      image.png



    2. 插入/編輯影片

      回到書本編輯狀態->找到「插入/編輯影片」功能

      image.png

       

      貼上步驟1複製的網路連結

      image.png
      切換到「Embed」->保存

      image.png


    3. 完成