提案: 在 README.md 新增 Quick Start 教學

[unknowntpo]

我遇到了一個問題，
在 執行程式時缺少許多 config file, 但我不知道該看哪個文件來了解他們的命名規則，以及該如何設定這些 config file。

$ ./Ptt-backend
2021/01/28 20:25:34 server start
2021/01/28 20:25:34 load default config
2021/01/28 20:25:34 apply config
2021/01/28 20:25:34 read config bbs.home: /home/bbs
2021/01/28 20:25:34 read config networking.listen_port: 8081
2021/01/28 20:25:34 read config security.access_token_private_key
2021/01/28 20:25:34 read config security.access_token_public_key
2021/01/28 20:25:34 read config security.access_token_expires_at: 24h
2021/01/28 20:25:34 load user config
2021/01/28 20:25:34 load custom config error: open config.toml: no such file or directory
2021/01/28 20:25:34 path: /home/bbs/.PASSWDS
2021/01/28 20:25:34 open /home/bbs/.PASSWDS: no such file or directory
2021/01/28 20:25:34 bbs: get user rec error: open /home/bbs/.PASSWDS: no such file or directory
2021/01/28 20:25:34 get user rec error: open /home/bbs/.PASSWDS: no such file or directory
2021/01/28 20:25:34 path: /home/bbs/.BRD
2021/01/28 20:25:34 open /home/bbs/.BRD: no such file or directory
2021/01/28 20:25:34 bbs: get user rec error: open /home/bbs/.BRD: no such file or directory
2021/01/28 20:25:34 get board header error: open /home/bbs/.BRD: no such file or directory
2021/01/28 20:25:34 listen port on 8081

是否能在 README.md 新增能讓程式快速跑起來的教學呢？
e.g. docker/compose

[PichuChen]

這個不是缺少 config file, 而是缺少 bbs home 的檔案

bbs home 的檔案是實際上 BBS 的文章以及使用者資料等等的檔案

可以到這邊下載
http://pttapp.cc/data-archives/

或是走以下指令

wget http://pttapp.cc/data-archives/bbs_backup_lastest.tar
tar -C ./ -xf ./bbs_backup_lastest.tar

然後修改 default config 把 BBS Home 設定到 ./home/bbs 或者是cp default config 成 config.toml 把 BBSHome 設定下去。

[PichuChen]

https://github.com/Ptt-official-app/Ptt-backend/blob/development/FOR_DEVELOPERS.md

做了一個暫時的版本，請 @unknowntpo 幫忙確認有沒有需要補充的。

[PichuChen]

@unknowntpo 可以幫忙確認一下有沒有什麼需要補充的嗎？否則會先關掉這個 ISSUE 喔

[SivWatt]

我自己實際的go through是這樣：

1. Clone Project
2. 下載測試伺服器資料
   1. 我的OS是 Windows 10 這邊我是下載 bbs_backup_lastest.tar 然後直接 WinRar or 7zip 解開
   2. 因為最後面她會去link symbol，目前不知道為什麼會找不到位置所以fail 然後跳 Warning 不過看似是不影響
3. 複製 home 到 ~\Ptt-backend\ 正下方，因為有ignore 所以不用擔心會不小心 commit 進 branch
4. go build (Ptt-backend)
5. run Ptt-backend.exe

Log 大概會長這樣

2021/02/12 14:23:29 server start
2021/02/12 14:23:29 load default config
2021/02/12 14:23:29 apply rawConfig
2021/02/12 14:23:29 read rawConfig bbs.home: ./home/bbs
2021/02/12 14:23:29 read rawConfig networking.listen_port: 8081
2021/02/12 14:23:29 read rawConfig security.access_token_private_key
2021/02/12 14:23:29 read rawConfig security.access_token_public_key
2021/02/12 14:23:29 read rawConfig security.access_token_expires_at: 24h
2021/02/12 14:23:29 load user config
2021/02/12 14:23:29 path: ./home/bbs/.PASSWDS
2021/02/12 14:23:29 path: ./home/bbs/.BRD
2021/02/12 14:23:29 loaded 0 SYSOP
2021/02/12 14:23:29 loaded 1 1...........
2021/02/12 14:23:29 loaded 2 junk
2021/02/12 14:23:29 loaded 3 Security
2021/02/12 14:23:29 loaded 4 2...........
2021/02/12 14:23:29 loaded 5 ALLPOST
2021/02/12 14:23:29 loaded 6 deleted
2021/02/12 14:23:29 loaded 7 Note
2021/02/12 14:23:29 loaded 8 Record
2021/02/12 14:23:29 loaded 9 WhoAmI
2021/02/12 14:23:29 loaded 10 EditExp
2021/02/12 14:23:29 loaded 11 ALLHIDPOST
2021/02/12 14:23:29 loaded 12 ptt_app
2021/02/12 14:23:29 loaded 13 test
2021/02/12 14:23:29 loaded 14 test1216
2021/02/12 14:23:29 listen port on 8081

我自己是覺得步驟可以寫得更仔細一點點，然後加上一些 step 之後的screenshot 幫助new comer 更快上手

[PichuChen]

我自己實際的go through是這樣：

1. Clone Project

2. 下載測試伺服器資料

   1. 我的OS是 Windows 10 這邊我是下載 bbs_backup_lastest.tar 然後直接 WinRar or 7zip 解開
   2. 因為最後面她會去link symbol，目前不知道為什麼會找不到位置所以fail 然後跳 Warning 不過看似是不影響

3. 複製 home 到 ~\Ptt-backend\ 正下方，因為有ignore 所以不用擔心會不小心 commit 進 branch

4. go build (Ptt-backend)

5. run Ptt-backend.exe

Log 大概會長這樣

2021/02/12 14:23:29 server start
2021/02/12 14:23:29 load default config
2021/02/12 14:23:29 apply rawConfig
2021/02/12 14:23:29 read rawConfig bbs.home: ./home/bbs
2021/02/12 14:23:29 read rawConfig networking.listen_port: 8081
2021/02/12 14:23:29 read rawConfig security.access_token_private_key
2021/02/12 14:23:29 read rawConfig security.access_token_public_key
2021/02/12 14:23:29 read rawConfig security.access_token_expires_at: 24h
2021/02/12 14:23:29 load user config
2021/02/12 14:23:29 path: ./home/bbs/.PASSWDS
2021/02/12 14:23:29 path: ./home/bbs/.BRD
2021/02/12 14:23:29 loaded 0 SYSOP
2021/02/12 14:23:29 loaded 1 1...........
2021/02/12 14:23:29 loaded 2 junk
2021/02/12 14:23:29 loaded 3 Security
2021/02/12 14:23:29 loaded 4 2...........
2021/02/12 14:23:29 loaded 5 ALLPOST
2021/02/12 14:23:29 loaded 6 deleted
2021/02/12 14:23:29 loaded 7 Note
2021/02/12 14:23:29 loaded 8 Record
2021/02/12 14:23:29 loaded 9 WhoAmI
2021/02/12 14:23:29 loaded 10 EditExp
2021/02/12 14:23:29 loaded 11 ALLHIDPOST
2021/02/12 14:23:29 loaded 12 ptt_app
2021/02/12 14:23:29 loaded 13 test
2021/02/12 14:23:29 loaded 14 test1216
2021/02/12 14:23:29 listen port on 8081

我自己是覺得步驟可以寫得更仔細一點點，然後加上一些 step 之後的screenshot 幫助new comer 更快上手

有具體要修改的位置嗎？
是說在 command 下面，windows 要執行 .exe 是怎麼下？感覺那邊應該有需要修改？

[PichuChen]

這個 ISSUE 目前還有在更新嗎？ 不然兩週後要把他先關掉了喔？

[karta0807913]

我覺得需要放一下系統管理員 SYSOP 的密碼之類的

[PichuChen]

我覺得需要放一下系統管理員 SYSOP 的密碼之類的

可以在slack 問

[karta0807913]

我覺得需要放一下系統管理員 SYSOP 的密碼之類的

可以在slack 問

那可能要在那篇裡面放一下 slack
我最後有測試表裡面找到密碼
我覺得目前的資訊太過分散了，剛來的要找東西不是很方便

[PichuChen]

不然如果把它放到 FOR_DEVELOPERS.md 的話呢？

[karta0807913]

不然如果把它放到 FOR_DEVELOPERS.md 的話呢？

我覺得很不錯，不然可能新來的（如我）剛開始的時候要花很多時間找尋資料