1 Star 1 Fork 0

cf3b5 / moonraker-remote-manager

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

moonraker-remote-manager

介绍

moonraker的远程控制component组件,该组件利用printer.cf3b5.com网站的隧道及P2P点对点的通讯协议,将原本内网的moonraker服务API暴露至外网,并通过https://printer.cf3b5.com/fluidd 网站连接该API,从而通过可以通过外网直接访问和管理家中的打印机

注意:printer.cf3b5.com服务只涉及隧道及P2P的信令交互,账号等功能,打印机的安全性由moonraker自己的账号和认证体系来保证,printer.cf3b5.com不对打印机本身安全负责

如何使用这个组件

安装

先进入树莓派终端,执行下列命令,克隆组件的源代码仓库到本地,运行安装脚本

cd ~/
git clone https://gitee.com/cf3b5/moonraker-remote-manager.git
./moonraker-remote-manager/install.sh

安装完成后,应该会提示类似于下面的内容

-------------------------------
Here is your key. Please copy it to printer.cf3b5.com for use
-------------------------------
ssh-rsa AAAAB3........E5bn02e+ovl8SctgoCxF+vvNwT65GwjNgb pi@raspberrypi
-------------------------------

这是第一次安装时,自动生成新的密钥,并主动显示其中公钥的信息。 复制ssh-rsa开头(包括ssh-rsa)这段公钥内容到printer.cf3b5.com中的新增打印机密钥

如果需要再次更改密钥,可以重新执行install.sh -f

注册并增加打印机

去网站 https://printer.cf3b5.com/ ,注册一个账号,添加打印机得时候,填写上面得密钥 输入图片说明

配置

安装完成并在printer.cf3b5.com上注册添加完打印机后,需要在moonraker中启用该组件

启用组件

在moonraker.conf文件中增加下面的段落,以启用该组件

# moonraker.conf
[remote_manager]
# 摄像头视频串流得地址,要用内网地址
webcam: http://localhost:8080?action=stream

自动更新

下面配置内容是模块的版本检查更新功能,非必要,建议增加,同样增加进moonraker.conf文件中

# moonraker.conf

[update_manager remote_manager]
type: git_repo
primary_branch: develop
path: ~/moonraker-remote-manager
origin: https://gitee.com/cf3b5/moonraker-remote-manager.git

安全配置

一旦开启远程访问功能,moonraker的接口安全性必须要重视起来,具体可以参考下面的配置内容说明


打开强制登陆选项前一定要先用fluidd建立登陆账号和密码,否则打开后会没有密码账号登陆,如果忘记这个步骤,就手工修改配置文件关闭强制登陆功能后在建立

[authorization]
# True = 强制登陆,打开后无论是否在trusted_clients可信客户端IP中的IP,都会强制要求登陆
# False = 不强制登陆,只有不在trusted_clients可信客户端IP列表中的IP,才会要求登陆
force_logins: False

# 授权跨站域名列表,也就是允许这些域名下的网站连接API接口
cors_domains:
  # 需要同意printer.cf3b5.com域名的跨站请求,https://printer.cf3b5.com/fluidd 才能访问
  *://printer.cf3b5.com 
  *://app.fluidd.xyz
  *://my.mainsail.xyz

# 重要:可信客户端IP列表,只有在列表中的客户端IP访问API接口时,可以不需要登陆(强制登陆未打开情况),所以请确保列表中的IP都是可信的内网IP
trusted_clients:
  192.168.0.0/24
  10.0.0.0/8
  127.0.0.0/8
  169.254.0.0/16
  172.16.0.0/12
  FE80::/10
  ::1/128

上述操作都确认完成无误后,记得重启moonraker完成后,这时候可以去 https://printer.cf3b5.com/printer/index 页面,查看打印机是否连接成功 输入图片说明

使用

在登陆状态下,访问 https://printer.cf3b5.com/fluidd/ 就可以打开fluidd的打印机管理界面,或者提取 https://xxxx.printer.cf3b5.com/ 这个Moonraker API地址到你自己的安装的fluidd/mainsial网站上使用即可

打开摄像头

只要moonraker.conf文件中的webcam的摄像头地址配置是正确的,remote-manager组件支持将摄像头的视频串流通过WebRTC的点对点的方式推送至访问的浏览器,但该功能fluidd官方版本客户端暂未支持,所以现阶段只有 https://printer.cf3b5.com/fluidd/ 这个网址中的fluidd客户端支持WebRTC视频直播功能。

去fluidd的设置页面,将摄像头类型改成WebRTC即可 输入图片说明

香橙派等非树莓派系统安装注意事项

在测试过程中,我发现非树莓派系统,有些第三方python的库需要Rust进行本地编译,所以如果出现“Can‘t find Rust compiler”这类的报错,尝试先安装一下Rust https://www.rust-lang.org/tools/install ,安装完rust之后,在重新执行install.sh安装脚本

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

moonraker的component组件,通过该组件,可以远程连接服务器开启隧道暴露moonraker的服务端口 展开 收起
Python 等 2 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Python
1
https://gitee.com/cf3b5/moonraker-remote-manager.git
git@gitee.com:cf3b5/moonraker-remote-manager.git
cf3b5
moonraker-remote-manager
moonraker-remote-manager
develop

搜索帮助