You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Proxxi supports configuring its working directory via an environment variable.
56
58
57
59
```shell
58
-
export PROXXI_DIR="<ABSOLUTE_OR_RELATIVE_PATH>"
60
+
export PROXXI_DIR="<PATH>"
59
61
```
60
62
61
63
(If your shell is PowerShell on Windows, use `$env:PROXXI_DIR="..."`.)
@@ -71,7 +73,7 @@ You can manage plugins using the `plugin` command and its subcommands:
71
73
-`plugin <PLUGIN-ID> enable` - Enable a plugin
72
74
-`plugin <PLUGIN-ID> disable` - Disable a plugin
73
75
-`plugin <PLUGIN-ID> parameter <NAME> [VALUE]` - Set or remove a parameter for a plugin
74
-
-`parameters` - List parameters for a plugin
76
+
-`plugin <PLUGIN-ID> parameters` - List parameters for a plugin
75
77
76
78
You can also use the `plugins` command to list all installed plugins.
77
79
@@ -104,20 +106,23 @@ A plugin exposes one or more proxy sources, and the CLI orchestrates:
104
106
105
107
### Adding plugins
106
108
107
-
1.**Choose your Proxxi directory** (optional but recommended for predictable paths):
108
-
```shell
109
-
export PROXXI_DIR="<PATH_TO_PROXXI_DIR>"
110
-
```
111
-
2. **Run proxxi**for initial `PROXXI_DIR` and subfolders and files (if is first run):
112
-
```shell
113
-
./proxxi --help
114
-
```
115
-
3. **Copy the plugin** into the `plugins` directory. Typically, this is the plugin `.dll` plus any required dependency
109
+
For automatic adding plugins from `.pxp` package use the command:
110
+
111
+
```shell
112
+
./proxxi install <PATH_TO_PLUGIN_PACKAGE>.pxp
113
+
```
114
+
115
+
> This command unpackage `.pxp` package in to the plugins directory, and register in the plugins
116
+
> configuration `plugins.json`.
117
+
118
+
#### Manual adding plugins
119
+
120
+
1.**Copy the plugin** into the `plugins` directory. Typically, this is the plugin `.dll` plus any required dependency
116
121
files that ship with it (keep every plugin in its own folder for simplicity and conflict prevention):
117
122
```shell
118
-
cp -r <PLUGIN>"$PROXXI_DIR/plugins/"
123
+
cp -r <PLUGIN_FOLDER>"$PROXXI_DIR/plugins/"
119
124
```
120
-
4. **Register/enable the plugin**in the Proxxi plugin configuration (JSON) under the Proxxi directory.
125
+
2. **Register/enable the plugin**in the plugins configuration `plugins.json` under the Proxxi directory.
121
126
```json5
122
127
[
123
128
{
@@ -135,7 +140,8 @@ A plugin exposes one or more proxy sources, and the CLI orchestrates:
135
140
]
136
141
```
137
142
138
-
> Tip: If a plugin is not discovered, ensure the plugin and its dependencies are present in the plugins folder and that the plugin is added/enabled in the JSON config.
143
+
> Tip: If a plugin is not discovered, ensure the plugin and its dependencies are present in the plugins folder and that
0 commit comments