Skip to content

Commit 9c017cb

Browse files
pythysguusdk
authored andcommitted
add comment on how to enable this plugin
1 parent 55c91a7 commit 9c017cb

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

readme.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,13 @@ <h3 id="third-party">Third party</h3>
176176
</ul>
177177
<h2 id="installation">Installation</h2>
178178
<p>Copy restAPI.jar into the plugins directory of your Openfire server. The plugin will be automatically deployed. To upgrade to a newer version, overwrite the restAPI.jar file with the new one.</p>
179+
180+
<p>
181+
<b>Important Step:</b> To enable the plugin make sure to set the system property <code>adminConsole.access.allow-wildcards-in-excludes</code> to <code>true</code>.
182+
Without the above step the REST API plugin always <a href="https://discourse.igniterealtime.org/t/when-i-upload-to-4-7-5-the-restapi-always-redirect/92892">redirects to login</a>
183+
This was done in response to a <a href="https://discourse.igniterealtime.org/t/cve-2023-32315-openfire-administration-console-authentication-bypass/92869">security issue</a>
184+
</p>
185+
179186
<h2 id="explanation-of-rest">Explanation of REST</h2>
180187
<p>To provide a standard way of accessing the data the plugin is using REST.</p>
181188

readme.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,11 @@ REST API clients are implementations of the REST API in a specific programming l
4242

4343
Copy restAPI.jar into the plugins directory of your Openfire server. The plugin will be automatically deployed. To upgrade to a newer version, overwrite the restAPI.jar file with the new one.
4444

45+
*Important Step:* To enable the plugin make sure to set the system property `adminConsole.access.allow-wildcards-in-excludes` to `true`
46+
47+
Without the above step the REST API plugin always [redirects to login](https://discourse.igniterealtime.org/t/when-i-upload-to-4-7-5-the-restapi-always-redirect/92892).
48+
This was done in response to a [security issue](https://discourse.igniterealtime.org/t/cve-2023-32315-openfire-administration-console-authentication-bypass/92869).
49+
4550
## Explanation of REST
4651

4752
To provide a standard way of accessing the data the plugin is using REST.

0 commit comments

Comments
 (0)