使用内网穿透配置公网地址随时随地远程访问本地搭建的paperless-ngx服务

目录

前言

1. 部署Paperless-ngx

2. 本地访问Paperless-ngx

3. Linux安装Cpolar

4. 配置公网地址

5. 远程访问

6. 固定Cpolar公网地址

7. 固定地址访问


前言

   作者简介: 懒大王敲代码,计算机专业应届生

       今天给大家聊聊使用内网穿透配置公网地址随时随地远程访问本地搭建的paperless-ngx服务,希望大家能觉得实用!欢迎大家点赞 👍 收藏 ⭐ 加关注哦!💖💖  

个人主页:

懒大王敲代码-优快云博客icon-default.png?t=N7T8https://blog.youkuaiyun.com/weixin_58070962?type=blog

其他专栏:

技术分享专栏icon-default.png?t=N7T8http://t.csdnimg.cn/LVrbCjava专栏icon-default.png?t=N7T8http://t.csdnimg.cn/bw2Thubantu与C语言学习专栏icon-default.png?t=N7T8http://t.csdnimg.cn/A8yIivue3项目实战专栏icon-default.png?t=N7T8http://t.csdnimg.cn/vP2no内网穿透专栏icon-default.png?t=N7T8http://t.csdnimg.cn/GJZJA懒大王闲谈专栏icon-default.png?t=N7T8http://t.csdnimg.cn/KxzqY

本文主要介绍如何在Linux系统本地部署Paperless-ngx开源文档管理系统,并结合cpolar内网穿透工具解决本地部署后因为没有公网IP受到局域网访问限制,在异地也能随时远程访问的困扰。

Paperless-ngx是一个开源的文档管理系统,可以将物理文档转换成可搜索的在线档案,从而减少纸张的使用。它内置了OCR功能,可以自动对上传的扫描文档执行OCR,识别文档中的文字,并将其转换为可编辑和可搜索的文本格式。然后,系统会对文档进行分类和索引,以便用户可以随时搜索查阅。

cpolar是一款强大的内网穿透软件,它能够在多个操作系统上无缝运行,包括Windows、MacOS和Linux,因此无论您使用哪种操作系统,都可以轻松将本地内网服务器的HTTP、HTTPS、TCP协议端口映射为公网地址端口,使得公网用户可以轻松访问您的内网服务,无需部署至公网服务器.

本例采用Docker部署,首先设备需要提前安装好Docker 和Docker compose,如没有安装,可以参考docker 官方教程进行安装:Docker 官方安装教程

Paperless-ngx 部署需要用到非常多外部服务,如数据库等,采用docker compose方式,可以一次性把所有的服务全部部署好,简化安装过程,下面开始进行安装。

1. 部署Paperless-ngx

在Linux 中创建一个文件夹,创建后进入该文件夹

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

在该文件夹下创建docker-compose.yml 文件

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

把下面参数复制进去docker-compose.yml 文件里面,

version: "3.6"
services:
  broker:
    image: docker.io/library/redis:7
    restart: unless-stopped
    volumes:
      - redisdata:/data
​
  db:
    image: docker.io/library/mariadb:10
    restart: unless-stopped
    volumes:
      - dbdata:/var/lib/mysql
    environment:
      MARIADB_HOST: paperless
      MARIADB_DATABASE: paperless
      MARIADB_USER: paperless
      MARIADB_PASSWORD: paperless
      MARIADB_ROOT_PASSWORD: paperless
​
  webserver:
    image: ghcr.io/paperless-ngx/paperless-ngx:latest
    restart: unless-stopped
    depends_on:
      - db
      - broker
    ports:
      - "8000:8000"
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:8000"]
      interval: 30s
      timeout: 10s
      retries: 5
    volumes:
      - data:/usr/src/paperless/data
      - media:/usr/src/paperless/media
      - ./export:/usr/src/paperless/export
      - ./consume:/usr/src/paperless/consume
    environment:
      PAPERLESS_REDIS: redis://broker:6379
      PAPERLESS_DBENGINE: mariadb
      PAPERLESS_DBHOST: db
      PAPERLESS_DBUSER: paperless 
      PAPERLESS_DBPASS: paperless 
      PAPERLESS_DBPORT: 3306
​
volumes:
  data:
  media:
  dbdata:
  redisdata:
​

复制进去后记得保存

image-20240321121301825

然后运行下面命令进行启动,执行后等待运行完成,如果卡顿或者卡主不动,可以ctrl+c 退出 重新执行下面命令

docker compose up -d

运行后,输入docker ps 命令,即可看到我们运行的Paperless-ngx服务,对外访问端口为8000

image-20240321121453596

下面我们进行设置登录的用户名和密码,运行下面命令

docker compose run --rm webserver createsuperuser

然后按提示设置用户名,邮箱,密码,本例设置的用户名为jon,具体可以自己设置,然后按提示输入邮箱,和设置用户名对应的密码,设置后回车提示successful表示成功,下面我们进行访问

image-20240321122249821

2. 本地访问Paperless-ngx

上面运行服务且设置好登录用户名密码后,我们使用Linux局域网IP加端口8000,即可看到Paperless-ngx登录界面

image-20240321122500585

输入我们上面设置的用户名密码即可登录成功,本地访问成功了,下面我们安装cpolar内网穿透工具,实现远程也可以访问!

image-20240321122707059

3. Linux安装Cpolar

上面在本地Docker中成功部署了Paperless-ngx服务,并局域网访问成功,下面我们在Linux安装Cpolar内网穿透工具,通过Cpolar 转发本地端口映射的http公网地址,我们可以很容易实现远程访问,而无需自己注册域名购买云服务器.下面是安装cpolar步骤

cpolar官网地址: cpolar官网-安全的内网穿透工具 | 无需公网ip | 远程访问 | 搭建网站

  • 使用一键脚本安装命令

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

  • 安装完成后,可以通过如下方式来操作cpolar服务,首先执行加入系统服务设置开机启动,然后再启动服务

# 加入系统服务设置开机启动
sudo systemctl enable cpolar
​
# 启动cpolar服务
sudo systemctl start cpolar
​
# 重启cpolar服务
sudo systemctl restart cpolar
​
# 查看cpolar服务状态
sudo systemctl status cpolar
​
# 停止cpolar服务
sudo systemctl stop cpolar
​

Cpolar安装和成功启动服务后,内部或外部浏览器上通过局域网IP加9200端口即:【http://192.168.xxx.xxx:9200】访问Cpolar管理界面,使用Cpolar官网注册的账号登录,登录后即可看到cpolar web 配置界面,接下来在web 界面配置即可

image-20240220142041422

4. 配置公网地址

点击左侧仪表盘的隧道管理——创建隧道,创建一个paperless-ngx的公网http地址隧道!

  • 隧道名称:可自定义命名,注意不要与已有的隧道名称重复

  • 协议:选择http

  • 本地地址:8000(本地访问的地址)

  • 域名类型:免费选择随机域名

  • 地区:选择China

点击创建

image-20240321124339200

隧道创建成功后,点击左侧的状态——在线隧道列表,查看所生成的公网访问地址,有两种访问方式,一种是http 和https,下面进行远程访问

image-20240321125356804

5. 远程访问

使用上面Cpolar生成的 http公网地址,在任意设备的浏览器进行访问,即可成功看到我们Paperless-ngx的界面,无需云服务器,无需公网IP即可实现远程访问!

image-20240321125613760

小结

为了更好地演示,我们在前述过程中使用了cpolar生成的隧道,其公网地址是随机生成的。

这种随机地址的优势在于建立速度快,可以立即使用。然而,它的缺点是网址由随机字符生成,不太容易记忆(例如:3ad5da5.r10.cpolar.top)。另外,这个地址在24小时内会发生随机变化,更适合于临时使用。

我一般会使用固定二级子域名,原因是我希望将网址发送给同事或客户时,它是一个固定、易记的公网地址(例如:paperless-ngx.cpolar.cn),这样更显正式,便于流交协作。

6. 固定Cpolar公网地址

由于以上使用cpolar所创建的隧道使用的是随机公网地址,24小时内会随机变化,不利于长期远程访问。因此我们可以为其配置二级子域名,该地址为固定地址,不会随机变化【ps:cpolar.cn已备案】

注意需要将cpolar套餐升级至基础套餐或以上,且每个套餐对应的带宽不一样。【cpolar.cn已备案】

登录cpolar官网,点击左侧的预留,选择保留二级子域名,设置一个二级子域名名称,点击保留,保留成功后复制保留的二级子域名名称

image-20240321131458218

保留成功后复制保留成功的二级子域名的名称

image-20240321131528933

返回登录cpolar web UI管理界面,点击左侧仪表盘的隧道管理——隧道列表,找到所要配置的隧道,点击右侧的编辑

image-20240321131737819

修改隧道信息,将保留成功的二级子域名配置到隧道中

  • 域名类型:选择二级子域名

  • Sub Domain:填写保留成功的二级子域名

点击更新(注意,点击一次更新即可,不需要重复提交)

image-20240321131809109

更新完成后,打开在线隧道列表,此时可以看到公网地址已经发生变化,地址二级名称变成了我们自己设置的二级子域名名称

image-20240321131841491

7. 固定地址访问

最后,我们使用固定的公网http地址访问,可以看到同样访问成功,这样一个固定且永久不变的公网地址就设置好了,随时随地都可以远程访问本地paperless-ngx服务,无需公网IP,无需云服务器!

image-20240321132417574

<think>好的,我现在需要帮助用户找到paperless-ngx的安装配置使用指南。首先,用户的问题是关于如何安装、配置使用这个文档管理系统的。根据用户提供的引用内容,我需要整合这些信息,并按照系统级指令的要求来组织回答。 首先,我需要回顾用户提供的引用内容。引用1提到了paperless.conf.example作为示例配置文件,用户需要创建paperless.conf并根据需求修改。引用3指出需要安装Docker和Docker Compose,并参考官方文档。引用4提到这是一个基于Django的系统,可以将纸质文档转换为可搜索的存档。引用2补充了部署方法,包括使用docker compose和安装脚本,以及迁移指南和依赖项安装。 接下来,我需要按照用户的要求,将回答结构化为步骤,包括安装、配置使用。同时,需要遵循系统指令中的格式要求,比如行内数学表达式使用$...$,但这里可能用不上数学公式。不过需要注意中文回答,生成相关问题,并在引用处添加标识符。 首先,安装部分需要指导用户安装Docker和Docker Compose,这引用自引用3和引用2。然后配置部分需要说明如何修改paperless.conf,引用1和引用4的信息。使用部分可能需要启动容器、访问界面、扫描文档等步骤。此外,用户可能还需要了解如何迁移数据或进行翻译,引用2提到了迁移指南和Crowdin翻译。 需要注意的是,用户提供的引用中没有直接的使用教程链接,但提到了文档的存在,所以可能需要引导用户查阅官方文档。同时,用户可能需要优化配置,如OCR设置或存储路径,这些可能来自引用1的配置选项注释。 最后,生成相关问题时要围绕安装、配置使用、优化和迁移等方面提问,确保问题相关且有依据。需要确保所有引用都正确标注,例如引用[^1]、[^2]等,并检查是否符合LaTeX格式要求,不过在这个回答中可能用不到数学表达式,所以可能不需要使用$...$或$$...$$。 总结步骤: 1. 安装Docker和Docker Compose(引用3、2) 2. 下载Paperless-ngx配置(引用1、4) 3. 修改配置文件(引用1) 4. 启动服务(引用3、2) 5. 访问Web界面和使用(引用4、2) 6. 其他功能如迁移和翻译(引用2) 生成的问题应涵盖这些步骤的细节,比如安装前的准备、配置选项、使用场景、优化方法、迁移步骤等。</think>### Paperless-ngx 安装配置使用指南 #### 一、安装步骤 1. **安装 Docker 和 Docker Compose** Paperless-ngx 依赖容器化部署,需先安装 Docker 和 Docker Compose。若未安装,可参考官方文档[^3]完成。 - 验证安装: ```bash docker --version && docker compose version ``` 2. **获取 Paperless-ngx 代码** 克隆仓库或下载压缩包: ```bash git clone https://github.com/paperless-ngx/paperless-ngx.git cd paperless-ngx ``` 3. **配置环境文件** 复制示例配置文件并重命名: ```bash cp docker-compose.env.example docker-compose.env cp paperless.conf.example paperless.conf ``` 修改 `paperless.conf` 以自定义参数(如OCR语言、存储路径)。 --- #### 二、启动服务 1. **通过 Docker Compose 部署** 运行以下命令启动容器: ```bash docker compose up -d ``` 服务启动后,默认可通过 `http://localhost:8000` 访问 Web 界面。 2. **初始化管理员账户** 首次访问需创建管理员账号: ```bash docker compose exec webserver createsuperuser ``` --- #### 三、基本使用 1. **文档上传与处理** - **扫描纸质文档**:将文件放入 `./consume` 目录,系统会自动处理并存入数据库[^4]。 - **手动上传**:通过 Web 界面上传 PDF、图片等格式文件。 2. **文档检索与管理** - 支持全文搜索(基于 OCR 结果)、标签分类和自定义过滤规则。 - 可编辑元数据(如标题、日期、关联标签)。 --- #### 四、进阶配置 1. **优化 OCR 性能** 修改 `paperless.conf` 中的 `OCR_LANGUAGE` 参数(例如 `chi_sim` 表示简体中文)。 2. **数据持久化** 默认将数据库、媒体文件存储于 `./data` 目录,建议定期备份。 3. **多语言支持** 通过 Crowdin 平台可参与翻译或下载语言包[^2]。 ---
评论 41
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值