update documentation #2909

pmauduit · 2020-01-29T10:57:14Z

documentation update:

debian 10 (buster)
tomcat9
openjdk8 from adoptopenjdk (not available in buster)
fiddling with systemd instead of regular initscripts
documenting some tomcat specific behaviour (in regards to geoserver / wicket)
adding a short explanation on how to get the generic wars from packages.g.o
removing contents which were not relevant anymore

Tests: the guide has been followed from scratch into a vagrant debian buster VM. Of course, every features have not been tested thoroughly, but I finished with a running georchestra (login onto CAS / SP OK, geoserver along with integrated geofence OK, GN OK - MD editing tested ...).

We can use the unofficial adoptopenjdk packages instead.

* "systemd-ifies" the doc, no longer using /etc/init.d * the tomcat9-instance-create does not the full job and it still requires some operations to be made by hand. TODO: I wonder if a SSL connector on the tomcat9-proxycas is still needed and why. I expect it is due to some geoserver behaviours which could be worked around.

so that the doc to setup the ldap tree is coherent.

* tomcat * apache * short explanation on how to deploy generic wars Tests: the documentation has been followed in a debian buster vagrant VM.

fvanderbiest · 2020-01-29T11:28:05Z

docs/setup/apache.md

@@ -115,6 +115,10 @@ AddType application/vnd.ogc.context+xml .wmc

 ErrorDocument 502 /errors/50x.html
 ErrorDocument 503 /errors/50x.html
+
+# redirects onto the viewer by default
+RewriteRule ^/$ https://%{SERVER_NAME}/mapfishapp/ [R=301,L]


This is handled by the SP IIRC
https://github.com/georchestra/datadir/blob/6eb3dd3f3c09098804a1728de3aa493480a2ce4a/security-proxy/security-proxy.properties#L131-L134

by default, I had a directory listing from apache2. If nothing handles the '/', apache2 will handle it, regardless of the SP configuration.

But for sure, if you hit the SP directly, it will suggest a redirection to the default target.

fvanderbiest · 2020-01-29T11:45:22Z

docs/setup/tomcat.md

 verify the list of keys in keystore:
 ```
 keytool -keystore /etc/tomcat9/keystore -list
 ```

+## geOrchestra datadir
+
+Since the 15.12 version, geOrchestra allows its main configuration settings to be done into a specific directory, the "georchestra Datadir".


More than "allows", it is now required.

you're right, at the begining of the geor datadir, it was not mandatory though.

fvanderbiest · 2020-01-29T11:45:47Z

docs/setup/tomcat.md

+
+Since the 15.12 version, geOrchestra allows its main configuration settings to be done into a specific directory, the "georchestra Datadir".
+
+By convention, we will consider that the path `/etc/georchestra` will be dedicated to this datadir. We can bootstrap a default datadir by


/can/have to/

strictly speaking, the datadir could be elsewhere (that is what we do for our customers), I'd prefer to stay less restrictive than "have to", maybe a future ("we will bootstrap") would be more appropriate.

fvanderbiest · 2020-01-29T15:59:04Z

docs/setup/tomcat.md


-In that same file, a few lines below :
-replace
 ```


diff syntax ?

fvanderbiest · 2020-01-29T16:02:35Z

docs/setup/tomcat.md

 ```
+JAVA_HOME=/usr/lib/jvm/adoptopenjdk-8-hotspot-amd64
 JAVA_OPTS="-Djava.awt.headless=true -XX:+UseConcMarkSweepGC"


GC availability/relevance to be double checked

fvanderbiest · 2020-01-29T16:04:30Z

docs/setup/tomcat.md

@@ -251,52 +334,24 @@ JAVA_OPTS="$JAVA_OPTS \
              -Djava.util.prefs.userRoot=/tmp \
              -Djava.util.prefs.systemRoot=/tmp"
 ```
-This allocates 2Gb of your server RAM to all geOrchestra webapps (except proxy, cas and geoserver).
+This allocates 2GB of your server RAM to all geOrchestra webapps (except proxy, cas and geoserver, which are located in other tomcat instances).


Probably insufficient nowadays ...

I would propose 6 by default.

fvanderbiest · 2020-01-29T16:05:19Z

docs/setup/tomcat.md

@@ -305,7 +360,7 @@ JAVA_OPTS="$JAVA_OPTS \
              -Dgeonetwork.jeeves.configuration.overrides.file=/etc/georchestra/geonetwork/config/config-overrides-georchestra.xml"
 ```

-Note: You can also override every geonetwork sub-data-directories by modifying
+Note: You can also overide every geonetwork sub-data-directories by modifying


fvanderbiest · 2020-01-29T16:08:30Z

docs/setup/tomcat.md

+
+```
+JAVA_OPTS="$JAVA_OPTS \
+	      -DGEOSERVER_XSTREAM_WHITELIST=org.geoserver.geoserver.authentication.auth.GeoFenceAuthenticationProviderConfig \


I do not see this option in https://github.com/georchestra/georchestra/blob/master/geoserver/webapp/src/docker/Dockerfile

fvanderbiest · 2020-01-29T16:10:00Z

docs/setup/tomcat.md

+GeoWebCache can be used either as a standalone webapp or integrated to GeoServer. If we want to go for the first option, we will also require the following JAVA_OPTS options:
+
+```
+	JAVA_OPTS="$JAVA_OPTS -DGEOWEBCACHE_CACHE_DIR=/opt/ "


fvanderbiest · 2020-01-29T16:11:06Z

docs/setup/tomcat.md

+## Be careful
+
+Remember that the geOrchestra binaries must be built according to the tomcat configuration described above.
+By default, forking the template configuration should guarantee this.


That was already present in the documentation, even if it appears in the diff, I have not touched this part. We can probably get rid of the paragraph, though.

fvanderbiest

Some bits to change ... huge improvement, thanks !

pmauduit added 12 commits January 29, 2020 11:52

docs - removing yum (unmaintained on the Jenkins CI)

571bb93

docs - kdu compilation not specific to docker setups ?

ebc9480

docs - debian buster does not include openjdk8

f1bf495

We can use the unofficial adoptopenjdk packages instead.

ldap - adding a symlink to openssh.ldif

e46a455

so that the doc to setup the ldap tree is coherent.

doc - missing georchestraSchema

f15c356

docs - git will be used in the doc, so advise to install it

817a6ac

doc - rewrite setting up apache

c815b6a

doc - systemd-ification

a5b396b

docs - native libs - libgdal1 is not available anymore on buster

af3ae3a

docs - apache - advise a default redirect to mapfishapp

c8a712c

docs - rewrite

9ab0b99

* tomcat * apache * short explanation on how to deploy generic wars Tests: the documentation has been followed in a debian buster vagrant VM.

pmauduit requested a review from fvanderbiest January 29, 2020 10:57

fvanderbiest added this to the 19.12 milestone Jan 29, 2020

fvanderbiest added this to In progress in Geo2France via automation Jan 29, 2020

docs - gs & tomcat - CSRF doc

ba8df18

fvanderbiest reviewed Jan 29, 2020

View reviewed changes

docs/setup/tomcat.md Outdated

In that same file, a few lines below :

replace

```

Copy link

Member

fvanderbiest Jan 29, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

diff syntax ?

fvanderbiest reviewed Jan 29, 2020

View reviewed changes

fvanderbiest requested changes Jan 29, 2020

View reviewed changes

Geo2France automation moved this from In progress to Needs review Jan 29, 2020

fvanderbiest assigned pmauduit Jan 31, 2020

doc - remove references to jai / imageio

1abc317

fixing own remarks

00156fb

fvanderbiest merged commit 82d2c1f into master Jan 31, 2020

Geo2France automation moved this from Needs review to Done Jan 31, 2020

fvanderbiest deleted the setup-middleware-doc-rewrite-19.12 branch January 31, 2020 12:40

landryb mentioned this pull request Dec 21, 2023

Docker: switch to adoptium docker images for java - oracle licensing issue #4127

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

update documentation #2909

update documentation #2909

pmauduit commented Jan 29, 2020

fvanderbiest Jan 29, 2020

pmauduit Jan 29, 2020 •

edited

fvanderbiest Jan 29, 2020

pmauduit Jan 29, 2020

fvanderbiest Jan 29, 2020

pmauduit Jan 29, 2020

fvanderbiest Jan 29, 2020

fvanderbiest Jan 29, 2020

fvanderbiest Jan 29, 2020

fvanderbiest Jan 31, 2020

fvanderbiest Jan 29, 2020

fvanderbiest Jan 29, 2020

fvanderbiest Jan 29, 2020

fvanderbiest Jan 29, 2020

pmauduit Jan 29, 2020

fvanderbiest left a comment


		Since the 15.12 version, geOrchestra allows its main configuration settings to be done into a specific directory, the "georchestra Datadir".

		By convention, we will consider that the path `/etc/georchestra` will be dedicated to this datadir. We can bootstrap a default datadir by

update documentation #2909

update documentation #2909

Conversation

pmauduit commented Jan 29, 2020

Choose a reason for hiding this comment

pmauduit Jan 29, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fvanderbiest left a comment

Choose a reason for hiding this comment

pmauduit Jan 29, 2020 •

edited