TiddlyWiki 是一個「非線性個人 Web 筆記本」,由「 javascript + CSS 樣式 + HTML 語法 」組成 html 文檔,你用戶可以在瀏覽器中使用 wiki 語法直接編輯頁面內容。非常適合用作個人記錄想法、日記、備忘錄、知識管理,還可以創建任務清單、策劃安排項目等。
本文提供樹莓派部署TiddlyWiki方法,並開放到公網,完成Https證書申請和安裝, 完成遊客身份和管理員身份的設置。
我們本次使用的程序來自 https://github.com/Jermolene/TiddlyWiki5, 以下是部署安裝教程~
安裝Node.js
下載Node.js並解壓
cd /opt/
sudo wget https://nodejs.org/dist/v14.18.0/node-v14.18.0-linux-arm64.tar.xz
sudo tar xvf node-v14.18.0-linux-arm64.tar.xz
將Node.js添加到環境變量(如果你使用zsh, 將以下指令中的bashrc 替換爲zshrc即可~)
sudo echo "export NODE_HOME=/opt/node-v14.18.0-linux-arm64" >> ~/.bashrc
sudo echo "export PATH=\$NODE_HOME/bin:\$PATH" >> ~/.bashrc
source ~/.bashrc
查看Node.js安裝位置和版本
which node
node -v
安裝TiddlyWiki
npm install -g tiddlywiki
- 查看安裝版本
tiddlywiki --version
創建Wiki
- 初始化Wiki文件夾
cd /opt
tiddlywiki wiki --init server
初始化成功後, /opt/wiki
文件夾內會出現一個tiddlywiki.info文件
- 開啓服務
cd /opt
tiddlywiki wiki --listen host=0.0.0.0 port=8998
我樹莓派的內網ip爲 192.168.50.223 tiddlywiki的運行端口爲8998, 我只需訪問 192.168.50.223:8998 即可查看運行效果
使用pm2守護tiddlywiki運行,並設置爲開機運行
- 首先安裝pm2
npm install -g pm2
pm2 -v
- 設置tiddlywiki運行腳本
echo 'tiddlywiki /opt/wiki --listen host=0.0.0.0 port=8998' > /opt/start_tiddlywiki.sh
- 使用pm2 守護運行
pm2 start /opt/start_tiddlywiki.sh
pm2 save
- 設置pm2 開機自啓
pm2 startup
使用nginx代理8998端口的tiddlywiki端口服務
本系列的前一節 樹莓派4B家庭服務器搭建指南》第九期:用樹莓派低成本給熱心老哥搭個窩,在樹莓派建立BBS論壇flarum並映射到公網全攻略 已經完成通過frp,將樹莓派nginx 80端口的服務,轉發到服務端的8666端口, 具體配置請翻看上一節,這裏不再重複。
- 在樹莓派端, 創建代理8998端口的nginx配置文件
sudo touch /etc/nginx/conf.d/wiki.v2fy.com.conf
sudo chmod 777 /etc/nginx/conf.d/wiki.v2fy.com.conf
- 在wiki.v2fy.com.conf 中寫入以下內容
upstream wiki_v2fy_com { server 127.0.0.1:8998; }
server {
listen 80;
server_name wiki.v2fy.com;
location / {
proxy_pass http://wiki_v2fy_com;
proxy_set_header Host $host:80;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
}
}
- 重啓樹莓派的nginx
sudo nginx -t
sudo nginx -s reload
進入域名管理界面,將wiki.v2fy.com 解析到自己的雲主機ip
- 登錄有固定ip服務器
按照 [零依賴!使用acme.sh設置nginx多個https證書自動更新,無限續期https證書 https://www.v2fy.com/p/2021-06-27-nginx-https-1624774964000/] 教程獲得自動無限續期的證書
- 固定ip服務器,最終
/etc/nginx/conf.d/wiki.v2fy.com.conf
中的內容爲
upstream wiki_v2fy_com { server 127.0.0.1:8666; }
server {
server_name wiki.v2fy.com;
listen 80;
rewrite ^(.*)$ https://$host$1 permanent;
}
server {
listen 443 ssl http2;
listen [::]:443 ssl http2;
server_name wiki.v2fy.com;
location / {
proxy_pass http://wiki_v2fy_com;
proxy_set_header Host $host:443;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
}
ssl_certificate "/etc/nginx/ssl/wiki.v2fy.com/fullchain.cer";
ssl_certificate_key "/etc/nginx/ssl/wiki.v2fy.com/wiki.v2fy.com.key";
ssl_session_cache shared:SSL:1m;
ssl_session_timeout 10m;
ssl_ciphers HIGH:!aNULL:!MD5;
ssl_prefer_server_ciphers on;
# Load configuration files for the default server block.
error_page 404 /404.html;
location = /40x.html {
}
error_page 500 502 503 504 /50x.html;
location = /50x.html {
}
}
- 重啓固定ip服務器的Nginx
nignx -t
nginx -s reload
- 設置完成後,我們可以在公網,通過https://wiki.v2fy.com 訪問樹莓派的tiddlywiki服務
設置中文版界面
編輯 /opt/wiki/tiddlywiki.info
, 在其中添加中文語言配置
"languages": [
"zh-Hans"
],
- 重新啓動tiddlywiki
pm2 restart start_tiddlywiki
- 此時可以看到中文語言包加載成功
- 更換爲中文語言包
設置寫入權限
如果你想將Tiddly作爲個人知識庫來使用,就要創建賬號,來控制讀寫權限
touch /opt/wiki/users.csv
chmod 777 /opt/wiki/users.csv
在users.csv中寫入以下內容
username,password
zhaoolee,zhaoolee
zhaoolee002,zhaoolee002
修改啓動文件/opt/start_tiddlywiki.sh
內容爲
tiddlywiki /opt/wiki --listen host=0.0.0.0 port=8998 credentials=/opt/wiki/users.csv readers=zhaoolee,zhaoolee002 writers=zhaoolee
啓動文件裏,同時設置了讀寫的權限,zhaoolee 和 zhaoolee002 兩個賬戶都可以讀,zhaoolee可以寫入
如果你只是想控制寫入,允許任何人讀取,把 readers=zhaoolee,zhaoolee002
去掉即可~
- 重啓服務
pm2 restart start_tiddlywiki
- 打開頁面,輸入用戶名和密碼即可進入
- 新建筆記
擁有寫權限的用戶,頁面上會有一個加號,用於創建筆記,創建後的筆記主題名,可以成爲網址的一部分,分享給其它人。
https://wiki.v2fy.com/#zhaoolee基於樹莓派的網頁筆記
最後聊一下TiddlyWiki的用戶切換
TiddlyWiki 用了Basic Auth 的認證機制,這東西開發起來很方便,但用戶體驗很拉胯
當前場景:我將wiki.v2fy.com的權限設置爲,任何人可見,但只有特定人可修改。
對應的啓動命令是
tiddlywiki /opt/wiki --listen host=0.0.0.0 port=8998 credentials=/opt/wiki/users.csv writers=zhaoolee
打開wiki.v2fy.com頁面,遊客狀態顯示正常,當我需要以管理zhaoolee身份登錄時,需要先觸發logout功能
- 輸入用戶名密碼進行登錄
- 登錄成功
報錯也無所謂,不影響我們的正常使用。
- 如何登出?
https://log:[email protected]
小結
zhaoolee用過各種各樣的筆記軟件,但超過一定容量,就要付費,而且用戶數據安全也難有保障,而TiddlyWiki免費開源,通過讀寫權限的其妙組合,既可以當私人筆記用,也可以當公共便籤用,界面優雅,適合長期使用。