分类
公众号「0加1」

《树莓派4B家庭服务器搭建指南》第十期:在树莓派部署TiddlyWiki完成读写权限分离,开放到公网,建立自己的个人知识库


title: 《树莓派4B家庭服务器搭建指南》第十期:在树莓派部署TiddlyWiki完成读写权限分离,开放到公网,建立自己的个人知识库

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 

查看Node.js安装位置和版本

安装TiddlyWiki

npm install -g tiddlywiki

安装成功

  • 查看安装版本
tiddlywiki --version

查看安装版本

创建Wiki

  • 初始化Wiki文件夹
cd /opt
tiddlywiki wiki --init server

wiki

初始化成功后, /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服务

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:out@wiki.v2fy.com

页面刷新

回到游客状态

小结

zhaoolee用过各种各样的笔记软件,但超过一定容量,就要付费,而且用户数据安全也难有保障,而TiddlyWiki免费开源,通过读写权限的其妙组合,既可以当私人笔记用,也可以当公共便签用,界面优雅,适合长期使用。

本文永久更新地址(欢迎来读留言,写评论):

https://www.v2fy.com/p/2021-11-27-wiki-1637997854000

发表评论

电子邮件地址不会被公开。


The maximum upload file size: 2 MB.
You can upload: image, audio, video, document, spreadsheet, interactive, text, archive, code, other.
Links to YouTube, Facebook, Twitter and other services inserted in the comment text will be automatically embedded.