Skip to content

Commit

Permalink
README: add info about 3.6.x.
Browse files Browse the repository at this point in the history
  • Loading branch information
@etj
etj committed Oct 12, 2022
1 parent 74066d4 commit c68eac8
Showing 1 changed file with 29 additions and 41 deletions.
70 changes: 29 additions & 41 deletions README.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,21 @@ Architecture

**GeoFence** can be run either as a standalone Java web application, or embedded into GeoServer.

The **GeoFence** *standalone application* provides a graphical user interface to administer GeoServer users and authorization rules. Furthermore, a quite complete [REST API](https://github.com/geoserver/geofence/wiki/REST-API) allows the programmatic administration of the rules and their ancillary data.
In this configuration GeoServer needs a module (the **probe**) that will send authorization queries to GeoFence using a configurable protocol (by default it uses Spring remoting over HTTP).
The **GeoFence** *standalone application* run as a java service, and can be queried for auth by one or more GeoServer instances.
It provides a graphical user interface to administer GeoServer users and authorization rules.
Furthermore, a quite complete [REST API](https://github.com/geoserver/geofence/wiki/REST-API) allows the programmatic administration of the rules and their ancillary data.
In this configuration GeoServer needs a module (the [GeoFence client plugin](https://github.com/geoserver/geoserver/tree/main/src/extension/geofence/geofence)) that will send authorization queries to GeoFence using a configurable protocol (by default it uses Spring remoting over HTTP).

The *embedded* configuration will make the GeoFence engine run within GeoServer itself. The administration GUI will be seamlessly embedded into GeoServer.
The *embedded* configuration will make the GeoFence engine run within GeoServer itself. The administration GUI will be seamlessly embedded into GeoServer. The embedded GeoFence should be installed as a [GeoServer plugin](https://github.com/geoserver/geoserver/tree/main/src/extension/geofence/geofence-server) as well.

**GeoFence** provides the authorization services using the interface described in [GSIP 57](http://geoserver.org/display/GEOS/GSIP+57+-+Improving+GeoServer+authorization+framework).


License
==================================================
**GeoFence** core modules and GUI, as well as the part of **GeoFence** that shall be installed as a module into GeoServer (either the **probe** or the **embedded** logic), are free and Open Source software, released under the GPL license, (which is [GPL v2.0](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html)), as it implements a GeoServer Java API.

**GeoFence** core modules and GUI, as well as the **GeoFence** plugins in GeoServer, are free and Open Source software, released under the GPL license (which is [GPL v2.0](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html)), as it implements a GeoServer Java API.


Getting GeoFence
==================================================
Expand All @@ -36,52 +40,36 @@ Since there are two different ways to run **GeoFence**, you'll need different se

<dl>
<dt>Standalone</dt>
<dd>You'll need the <em>GeoFence</em> .war file, and the probe module to be deployed into GeoServer.</dd>
<dd>You'll need the <em>GeoFence</em> .war file, and the <code>geofence</code> plugin to be deployed into GeoServer.</dd>

<dt>Embedded</dt>
<dd>You'll only need to deploy the linked embedded module into GeoServer. The embedded version is only available starting from the 3.0 version.</dd>
<dd>You'll only need to deploy the <code>geofence-server</code> plugin into GeoServer.</dd>
</dl>


Since GeoFence and GeoServer run side to side, every change of the API in either side requires a change on the other one.
Here's a compatibility table for the versions of both applications:

Here's a compatibility table for the most recent versions of both applications (you may also want to refer to the [comprehensive compatibility matrix](https://github.com/geoserver/geofence/wiki/GS-GF-Compatibility-matrix)):

| GeoFence | GeoServer | Main changes |
|------------------|------------|---------------------------------------|
| master branch: <br/>- stable: [3.4.1] <br/>- nightly: [3.4.x] | | JTS Version update <br/> Minor DTO changes |
| 3.3.x branch: <br/>- stable: [3.3.0] <br/>- nightly: [3.3.x] | | LDAP improvements <br/> Minor DTO changes |
| 3.2.x branch: <br/>- stable: [3.2.3] <br/>- nightly: [3.2.x] | 2.12 ([probe][2.12_probe]) ([embedded][2.12_embedded]) <br/> 2.11 ([probe][2.11_probe]) ([embedded][2.11_embedded]) <br/> 2.10 ([probe][2.10_probe]) ([embedded][2.10_embedded]) <br/> 2.9 ([probe][2.9_probe]) ([embedded][2.9_embedded]) | Spring 4, JDK 8 |
| 3.1.x branch: <br/>- stable: [3.1.0] <br/>- nightly: [3.1.x] | >=2.8.2 ([probe][2.8_probe]) ([embedded][2.8_embedded]) | Handle Workspace admin <br/> (feature for embedded version only)
| 3.0.x | 2.8.0, 2.8.1 | GeoFence embedded into GeoServer <br/>(Only for older 2.8 releases; Not recommended)
| 2.2.x branch: <br/>- stable: [2.2.0] <br/>- nightly: [2.2.x] | 2.7 ([probe][2.7])<br/> 2.6 ([probe][2.6]) |

[3.4.x]: http://build.geoserver.org/geofence/master/geofence-master-latest-war.zip
[3.4.1]: http://build.geoserver.org/geofence/3.4.x/release-v3.4.1-geofence-war.zip
[3.3.x]: http://build.geoserver.org/geofence/3.3.x/geofence-3.3.x-latest-war.zip
[3.3.0]: http://build.geoserver.org/geofence/3.3.x/release-v3.3.0-geofence-war.zip
[3.2.0]: http://build.geoserver.org/geofence/3.2.x/release-v3.2.0-geofence-war.zip
[3.2.1]: http://build.geoserver.org/geofence/3.2.x/release-v3.2.1-geofence-war.zip
[3.2.2]: http://build.geoserver.org/geofence/3.2.x/release-v3.2.2-geofence-war.zip
[3.2.3]: http://build.geoserver.org/geofence/3.2.x/release-v3.2.3-geofence-war.zip
[3.2.x]: http://build.geoserver.org/geofence/3.2.x/geofence-3.2.x-latest-war.zip
[3.1.0]: http://build.geoserver.org/geofence/3.1.x/release-v3.1.0-geofence-war.zip
[3.1.x]: http://build.geoserver.org/geofence/3.1.x/geofence-3.1.x-latest-war.zip
[2.2.0]: http://build.geoserver.org/geofence/2.2.x/geofence-release-v2.2.0-war.zip
[2.2.x]: http://build.geoserver.org/geofence/2.2.x/geofence-2.2.x-latest-war.zip

[2.6]: http://ares.boundlessgeo.com/geoserver/2.6.x/community-latest/geoserver-2.6-SNAPSHOT-geofence-plugin.zip
[2.7]: http://ares.boundlessgeo.com/geoserver/2.7.x/community-latest/geoserver-2.7-SNAPSHOT-geofence-plugin.zip
[2.8_probe]: http://ares.boundlessgeo.com/geoserver/2.8.x/community-latest/geoserver-2.8-SNAPSHOT-geofence-plugin.zip
[2.8_embedded]: http://ares.boundlessgeo.com/geoserver/2.8.x/community-latest/geoserver-2.8-SNAPSHOT-geofence-server-plugin.zip
[2.9_probe]: http://ares.boundlessgeo.com/geoserver/2.9.x/community-latest/geoserver-2.9-SNAPSHOT-geofence-plugin.zip
[2.9_embedded]: http://ares.boundlessgeo.com/geoserver/2.9.x/community-latest/geoserver-2.9-SNAPSHOT-geofence-server-plugin.zip
[2.10_probe]: http://ares.boundlessgeo.com/geoserver/2.10.x/community-latest/geoserver-2.10-SNAPSHOT-geofence-plugin.zip
[2.10_embedded]: http://ares.boundlessgeo.com/geoserver/2.10.x/community-latest/geoserver-2.10-SNAPSHOT-geofence-server-plugin.zip
[2.11_probe]: http://build.geoserver.org/geoserver/2.11.x/community-latest/geoserver-2.11-SNAPSHOT-geofence-plugin.zip
[2.11_embedded]: http://build.geoserver.org/geoserver/2.11.x/community-latest/geoserver-2.11-SNAPSHOT-geofence-server-plugin.zip
[2.12_probe]: http://build.geoserver.org/geoserver/2.12.x/community-latest/geoserver-2.12-SNAPSHOT-geofence-plugin.zip
[2.12_embedded]: http://build.geoserver.org/geoserver/2.12.x/community-latest/geoserver-2.12-SNAPSHOT-geofence-server-plugin.zip

| [3.6.x][3.6.x] | 2.22.x ([client][2.22_client]) ([embedded][2.22_embedded]) | DTO changes (#226 - subfield) |
| [3.5.x][3.5.x] | 2.19.x ([client][2.19_client]) ([embedded][2.19_embedded]) | DTO changes (#163 - restricted area, clip) |
| 3.5.1 | 2.20.6 - 2.20.x <br/> 2.21.x| #222: Improve filtering by role <br/> #87: Exclude JPA1 dep |
| 3.5.0 | 2.19.0 - 2.19.6 <br/> 2.20.0 - 2.20.5 <br/> 2.21.0 - 2.21.1| DTO changes (#163 - restricted area, clip) |
| 3.4.x<br/>- stable: [3.4.6.1] | 2.18.x <br/> 2.17.x | #166: JTS Version update <br/> Minor DTO changes |

[3.6.x]: https://build.geoserver.org/geofence/nightly/3.6.x/geofence-3.6.x-latest-war.zip
[3.5.x]: https://build.geoserver.org/geofence/nightly/3.5.x/geofence-3.5.x-latest-war.zip
[3.4.x]: https://build.geoserver.org/geofence/3.4.x/geofence-3.4.x-latest-war.zip
[3.4.6]: https://github.com/geoserver/geofence/releases/download/v3.4.6/geofence.war
[3.4.6.1]: https://github.com/geoserver/geofence/releases/download/v3.4.6.1/geofence.war


[2.22_client]: https://build.geoserver.org/geoserver/2.22.x/ext-latest/geoserver-2.22-SNAPSHOT-geofence-plugin.zip
[2.22_embedded]: https://build.geoserver.org/geoserver/2.22.x/ext-latest/geoserver-2.22-SNAPSHOT-geofence-server-plugin.zip
[2.19_client]: https://build.geoserver.org/geoserver/2.19.x/ext-latest/geoserver-2.19-SNAPSHOT-geofence-plugin.zip
[2.19_embedded]: https://build.geoserver.org/geoserver/2.19.x/ext-latest/geoserver-2.19-SNAPSHOT-geofence-server-plugin.zip

Once you have downloaded the resources you need, please follow the instructions on the [GeoFence installation](https://github.com/geoserver/geofence/wiki/GeoFence-installation) wiki page.

Expand Down

0 comments on commit c68eac8

Please sign in to comment.