Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
ojhdt committed Dec 22, 2022
1 parent 651b021 commit f080378
Showing 1 changed file with 48 additions and 35 deletions.
83 changes: 48 additions & 35 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,24 +1,31 @@
########################################################################
EFB Parabox Master Channel:EFB Parabox 主端(EPM)
########################################################################

.. image:: https://img.shields.io/pypi/v/efb-parabox-master.svg
:target: https://pypi.org/project/efb-parabox-master/
:alt: PyPI release

.. image:: https://pepy.tech/badge/efb-parabox-master/month
:target: https://pepy.tech/project/efb-parabox-master
:alt: Downloads per month


**信道 ID**: ``ojhdt.parabox``

EPM 是一个用于 EH Forwarder Bot 的 Parabox 主端。需结合 Parabox WS 扩展 `parabox-extension-ws`_\ 使用。
EPM 是一个用于 EH Forwarder Bot 的 Parabox 主端。需结合 Parabox WS 扩展 `parabox-extension-ws`_\ 使用。

.. _parabox-extension-ws: https://github.com/Parabox-App/parabox-extension-ws

本项目的大量代码修改自 `efb-telegram-master`_\

.. _efb-telegram-master: https://github.com/ehForwarderBot/efb-telegram-master

`使用教程`_\

.. _使用教程: https://blog.ojhdt.com/20221221/efb-parabox-master/


依赖
====

Expand All @@ -33,53 +40,59 @@ EPM 是一个用于 EH Forwarder Bot 的 Parabox 主端。需结合 Parabox WS

2. 安装 EPM

::
pip3 install -U git+https://github.com/ojhdt/efb-parabox-master.git
.. code:: bash
pip3 install -U git+https://github.com/ojhdt/efb-parabox-master.git
::
pip3 install efb-parabox-master

.. code:: bash
pip3 install efb-parabox-master
3. 使用 *EFB 配置向导* 启用和配置 EPM,或在配置档案的 ``config.yaml`` 中手动启用。

根据您的个人配置档案,目录路径可能有所不同。
根据您的个人配置档案,目录路径可能有所不同。

.. code:: bash
::
efb-wizard
efb-wizard
4. 配置主端(手动配置说明如下)

手动配置
========
配置文件存储在 ``<配置档案目录>/ojhdt.parabox/config.yaml`` 上。
::
# ======================================
# EFB Parabox Master Configuration file
# ======================================
#
# This file configures how EFB Parabox Master Channel (EPM) works, and
# Who it belongs to.
#
# Required items
# --------------
#
# [Server Host]
# By default the 127.0.0.1 is used which allows connections only from the current machine. If you wish to allow all network machines to connect, you need to pass 0.0.0.0 as hostname.
host: 0.0.0.0

# [Server Port]
# The port clients will need to connect to.

port: 8000

# [Connection Token]
# The token used for verification.

token: abcdefghij
配置文件存储在 ``<配置档案目录>/ojhdt.parabox/config.yaml`` 上。

.. code:: yaml
# ======================================
# EFB Parabox Master Configuration file
# ======================================
#
# This file configures how EFB Parabox Master Channel (EPM) works, and
# Who it belongs to.
#
# Required items
# --------------
#
# [Server Host]
# By default the 127.0.0.1 is used which allows connections only from the current machine. If you wish to allow all network machines to connect, you need to pass 0.0.0.0 as hostname.
host: 0.0.0.0
# [Server Port]
# The port clients will need to connect to.
port: 8000
# [Connection Token]
# The token used for verification.
token: abcdefghij
已知问题
======
=========

以下问题为在测试中发现,并可能于后续版本修复的问题:

* 高频率发送 ``图片`` 将导致部分图片丢失。
Expand Down

0 comments on commit f080378

Please sign in to comment.