Skip to content

Commit 35cfd9e

Browse files
committed
Clarify installation method for plugins variant
1 parent 12b4a67 commit 35cfd9e

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

plugins/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
# Email OAuth 2.0 Proxy plugins
22
Plugins are an advanced Email OAuth 2.0 Proxy feature that enable the use of separate scripts to modify IMAP/POP/SMTP commands when they are received from the client or server before passing through to the other side of the connection.
33
This allows a wide range of additional capabilities or triggers to be added the proxy, as demonstrated in the examples below.
4-
See the [sample configuration file](../emailproxy.config#L42) for further application examples and documentation.
4+
5+
Currently, this version of the proxy is only available by cloning or or [downloading](https://github.com/simonrob/email-oauth2-proxy/archive/refs/heads/plugins.zip) the [plugins branch](https://github.com/simonrob/email-oauth2-proxy/tree/plugins), then running `python -m pip install -r requirements-core.txt -r requirements-gui.txt` to install requirements, and `python emailproxy.py` to launch.
6+
7+
See the [sample configuration file](../emailproxy.config) for further application examples and documentation about integrating plugins into IMAP/POP/SMTP servers.
58

69

710
## Sample plugins

0 commit comments

Comments
 (0)