前言

本文主要介紹如何在Linux系統(tǒng)本地部署Paperless-ngx開源文檔管理系統(tǒng)，并結(jié)合cpolar內(nèi)網(wǎng)穿透工具解決本地部署后因為沒有公網(wǎng)IP受到局域網(wǎng)訪問限制，在異地也能隨時遠程訪問的困擾。

Paperless-ngx是一個開源的文檔管理系統(tǒng)，可以將物理文檔轉(zhuǎn)換成可搜索的在線檔案，從而減少紙張的使用。它內(nèi)置了OCR功能，可以自動對上傳的掃描文檔執(zhí)行OCR，識別文檔中的文字，并將其轉(zhuǎn)換為可編輯和可搜索的文本格式。然后，系統(tǒng)會對文檔進行分類和索引，以便用戶可以隨時搜索查閱。

cpolar是一款強大的內(nèi)網(wǎng)穿透軟件，它能夠在多個操作系統(tǒng)上無縫運行，包括Windows、MacOS和Linux，因此無論您使用哪種操作系統(tǒng)，都可以輕松將本地內(nèi)網(wǎng)服務(wù)器的HTTP、HTTPS、TCP協(xié)議端口映射為公網(wǎng)地址端口，使得公網(wǎng)用戶可以輕松訪問您的內(nèi)網(wǎng)服務(wù)，無需部署至公網(wǎng)服務(wù)器.

本例采用Docker部署,首先設(shè)備需要提前安裝好Docker 和Docker compose,如沒有安裝,可以參考下方教程進行安裝：

在終端中執(zhí)行下方命令安裝docker：

sudo curl -fsSL https://github.com/tech-shrimp/docker_installer/releases/download/latest/linux.sh| bash -s docker --mirror Aliyun

如果上邊命令中訪問不了Github，可以使用Gitee的鏈接安裝：

sudo curl -fsSL https://gitee.com/tech-shrimp/docker_installer/releases/download/latest/linux.sh| bash -s docker --mirror Aliyun

然后啟動Docker

sudo systemctl start docker

下載docker-compose文件

sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

給他一個執(zhí)行權(quán)限

sudo chmod +x /usr/local/bin/docker-compose

Paperless-ngx 部署需要用到非常多外部服務(wù)，如數(shù)據(jù)庫等，采用docker compose方式，可以一次性把所有的服務(wù)全部部署好，簡化安裝過程，下面開始進行安裝。

1. 部署Paperless-ngx

在Linux 中創(chuàng)建一個文件夾,創(chuàng)建后進入該文件夾

mkdir -p /usr/local/ngx && cd /usr/local/ngx

在該文件夾下創(chuàng)建docker-compose.yml 文件

sudo vim /usr/local/ngx/docker-compose.yml

把下面參數(shù)復(fù)制進去docker-compose.yml 文件里面,

version: "3.6"
services:broker:image: docker.io/library/redis:7restart: unless-stoppedvolumes:- redisdata:/datadb:image: docker.io/library/mariadb:10restart: unless-stoppedvolumes:- dbdata:/var/lib/mysqlenvironment:MARIADB_HOST: paperlessMARIADB_DATABASE: paperlessMARIADB_USER: paperlessMARIADB_PASSWORD: paperlessMARIADB_ROOT_PASSWORD: paperlesswebserver:image: ghcr.io/paperless-ngx/paperless-ngx:latestrestart: unless-stoppeddepends_on:- db- brokerports:- "8000:8000"healthcheck:test: ["CMD", "curl", "-f", "http://localhost:8000"]interval: 30stimeout: 10sretries: 5volumes:- data:/usr/src/paperless/data- media:/usr/src/paperless/media- ./export:/usr/src/paperless/export- ./consume:/usr/src/paperless/consumeenvironment:PAPERLESS_REDIS: redis://broker:6379PAPERLESS_DBENGINE: mariadbPAPERLESS_DBHOST: dbPAPERLESS_DBUSER: paperless PAPERLESS_DBPASS: paperless PAPERLESS_DBPORT: 3306volumes:data:media:dbdata:redisdata:

復(fù)制進去后記得保存

然后運行下面命令進行啟動,執(zhí)行后等待運行完成,如果卡頓或者卡主不動,可以ctrl+c 退出 重新執(zhí)行下面命令

docker compose up -d

運行后,輸入docker ps 命令,即可看到我們運行的Paperless-ngx服務(wù),對外訪問端口為8000

下面我們進行設(shè)置登錄的用戶名和密碼,運行下面命令

docker compose run --rm webserver createsuperuser

然后按提示設(shè)置用戶名,郵箱,密碼,本例設(shè)置的用戶名為jon,具體可以自己設(shè)置,然后按提示輸入郵箱,和設(shè)置用戶名對應(yīng)的密碼,設(shè)置后回車提示successful表示成功,下面我們進行訪問

2. 本地訪問Paperless-ngx

上面運行服務(wù)且設(shè)置好登錄用戶名密碼后,我們使用Linux局域網(wǎng)IP加端口8000,即可看到Paperless-ngx登錄界面

輸入我們上面設(shè)置的用戶名密碼即可登錄成功,本地訪問成功了,下面我們安裝cpolar內(nèi)網(wǎng)穿透工具,實現(xiàn)遠程也可以訪問!

3. Linux安裝Cpolar

上面在本地Docker中成功部署了Paperless-ngx服務(wù),并局域網(wǎng)訪問成功,下面我們在Linux安裝Cpolar內(nèi)網(wǎng)穿透工具,通過Cpolar 轉(zhuǎn)發(fā)本地端口映射的http公網(wǎng)地址,我們可以很容易實現(xiàn)遠程訪問,而無需自己注冊域名購買云服務(wù)器.下面是安裝cpolar步驟

cpolar官網(wǎng)地址: https://www.cpolar.com

• 使用一鍵腳本安裝命令

curl -L https://www.cpolar.com/static/downloads/install-release-cpolar.sh | sudo bash

• 安裝完成后,可以通過如下方式來操作cpolar服務(wù),首先執(zhí)行加入系統(tǒng)服務(wù)設(shè)置開機啟動,然后再啟動服務(wù)

# 加入系統(tǒng)服務(wù)設(shè)置開機啟動
sudo systemctl enable cpolar# 啟動cpolar服務(wù)
sudo systemctl start cpolar# 重啟cpolar服務(wù)
sudo systemctl restart cpolar# 查看cpolar服務(wù)狀態(tài)
sudo systemctl status cpolar# 停止cpolar服務(wù)
sudo systemctl stop cpolar

Cpolar安裝和成功啟動服務(wù)后，內(nèi)部或外部瀏覽器上通過局域網(wǎng)IP加9200端口即:【http://192.168.xxx.xxx:9200】訪問Cpolar管理界面，使用Cpolar官網(wǎng)注冊的賬號登錄,登錄后即可看到cpolar web 配置界面,接下來在web 界面配置即可

4. 配置公網(wǎng)地址

點擊左側(cè)儀表盤的隧道管理——創(chuàng)建隧道，創(chuàng)建一個paperless-ngx的公網(wǎng)http地址隧道!

• 隧道名稱：可自定義命名，注意不要與已有的隧道名稱重復(fù)
• 協(xié)議：選擇http
• 本地地址：8000(本地訪問的地址)
• 域名類型：免費選擇隨機域名
• 地區(qū)：選擇China

點擊創(chuàng)建

隧道創(chuàng)建成功后，點擊左側(cè)的狀態(tài)——在線隧道列表,查看所生成的公網(wǎng)訪問地址，有兩種訪問方式,一種是http 和https,下面進行遠程訪問

5. 遠程訪問

使用上面Cpolar生成的 http公網(wǎng)地址,在任意設(shè)備的瀏覽器進行訪問,即可成功看到我們Paperless-ngx的界面,無需云服務(wù)器,無需公網(wǎng)IP即可實現(xiàn)遠程訪問!

小結(jié)

為了更好地演示，我們在前述過程中使用了cpolar生成的隧道，其公網(wǎng)地址是隨機生成的。

這種隨機地址的優(yōu)勢在于建立速度快，可以立即使用。然而，它的缺點是網(wǎng)址由隨機字符生成，不太容易記憶（例如：3ad5da5.r10.cpolar.top）。另外，這個地址在24小時內(nèi)會發(fā)生隨機變化，更適合于臨時使用。

我一般會使用固定二級子域名，原因是我希望將網(wǎng)址發(fā)送給同事或客戶時，它是一個固定、易記的公網(wǎng)地址（例如：paperless-ngx.cpolar.cn），這樣更顯正式，便于流交協(xié)作。

6. 固定Cpolar公網(wǎng)地址

由于以上使用cpolar所創(chuàng)建的隧道使用的是隨機公網(wǎng)地址，24小時內(nèi)會隨機變化，不利于長期遠程訪問。因此我們可以為其配置二級子域名，該地址為固定地址，不會隨機變化.

注意需要將cpolar套餐升級至基礎(chǔ)套餐或以上，且每個套餐對應(yīng)的帶寬不一樣?！綾polar.cn已備案】

登錄cpolar官網(wǎng)，點擊左側(cè)的預(yù)留，選擇保留二級子域名，設(shè)置一個二級子域名名稱，點擊保留,保留成功后復(fù)制保留的二級子域名名稱

保留成功后復(fù)制保留成功的二級子域名的名稱

返回登錄cpolar web UI管理界面，點擊左側(cè)儀表盤的隧道管理——隧道列表，找到所要配置的隧道，點擊右側(cè)的編輯

修改隧道信息，將保留成功的二級子域名配置到隧道中

• 域名類型：選擇二級子域名
• Sub Domain：填寫保留成功的二級子域名

點擊更新(注意,點擊一次更新即可,不需要重復(fù)提交)

更新完成后,打開在線隧道列表,此時可以看到公網(wǎng)地址已經(jīng)發(fā)生變化,地址二級名稱變成了我們自己設(shè)置的二級子域名名稱

7. 固定地址訪問

最后,我們使用固定的公網(wǎng)http地址訪問,可以看到同樣訪問成功,這樣一個固定且永久不變的公網(wǎng)地址就設(shè)置好了,隨時隨地都可以遠程訪問本地paperless-ngx服務(wù),無需公網(wǎng)IP,無需云服務(wù)器!