-
Notifications
You must be signed in to change notification settings - Fork 62
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
improvements around installation in maintainer guide #122
Conversation
Signed-off-by: Jody Garnett <jody.garnett@gmail.com>
Signed-off-by: Jody Garnett <jody.garnett@gmail.com>
Signed-off-by: Jody Garnett <jody.garnett@gmail.com>
GeoNetwork uses a database to persist aspects such as metadata records, privileges and configurations. | ||
The database default structure is created by the application on initial startup. Subsequent releases of GeoNetwork | ||
will update the database structure automatically. For this reason the database user initially needs create privileges on the database. | ||
A number of database dialects are supported; PostGreSQL, Oracle, SQL server, H2. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
think you intend a paragraph break here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correction SQL Server
.
Note I prefer:
A number of database dialects are supported; :command:`PostGreSQL`, :command:`Oracle`, :command:`SQL Server`, :command:`H2`.
|
||
By default, an `H2 <http://www.h2database.com/html/main.html>`_ database is configured | ||
and created when the application first start. The H2 database named ``geonetwork.h2.db`` | ||
and created when the application first starts. The H2 database file named ``gn.h2.db`` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use file directive (rather than basic markup):
The H2 database file named :file:`gn.h2.db`
--------------------------------------- | ||
|
||
The database dialect to use is configured in ``/WEB-INF/config-node/srv.xml``. Comment H2 and uncomment the dialect to use. | ||
Verify that a jdbc driver is available for the selected database dialect. If not, a jdbc library can be placed in ``/WEB-INF/lib`` or in the tomcat lib folder. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How are they supposed to verify? Does geonetwork include any JDBC drivers?
Configuring a database via config files | ||
--------------------------------------- | ||
|
||
The database dialect to use is configured in ``/WEB-INF/config-node/srv.xml``. Comment H2 and uncomment the dialect to use. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Even if you are providing generic directions, please provide one example of what you mean (perhaps using PostgreSQL as an example).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion: Break down the first 2 paras into
Configure a database
Where: You can configure a database in /WEB-INF/config-node/srv.xml.
a. Comment H2
b. Uncomment the dialect you want to use
c. Verify that a jdbc driver is available for your selected database dialect. It not, you can put a jdbc library in /WB0INF/lib or in the tomcat lib folder.
Update connection details
|
||
GeoNetwork assumes data is stored in the default schema for a user. If this is not the case, you need to activate a setting ``hibernate.default_schema`` in ``/WEB-INF/config-spring-geonetwork.xml``. | ||
There are some scripts that run directly on the database at initialisation and can't use the ``hibernate.default-schema`` parameter. For these scripts you need to set the default-schema manually. | ||
In PostGreSQL this is possible by appending ``?currentSchema=example`` to the database connection. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The above paragraphic switches between discussion and actions, and indeed topic.
- Double click the installer to start it. Alternatively open command line, navigate to the folder where the package has been downloaded and type 'java -jar geonetwork-install-x.x.x-x.jar'. | ||
- You can also run the installation with debug output. To do so run the installer with the flag -DTRACE=true: 'java -DTRACE=true -jar geonetwork-install-x.x.x.jar' | ||
|
||
- A wizard will start, guiding you through the installation steps |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
number the steps
|
||
- GeoNetwork will now be installed using the selected configuration | ||
|
||
- On windows a shortcut to start the service will be added to the start menu. On other platforms navigate to the installation folder and start the startup.sh script. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
make a separate heading for each platform
- GeoNetwork will now be installed using the selected configuration | ||
|
||
- On windows a shortcut to start the service will be added to the start menu. On other platforms navigate to the installation folder and start the startup.sh script. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
note I personally had a lot of problems sort things out - I used:
cd /Applications/geonetwork`
bin/start.sh
And it would not work.
You need to cd into the bin
folder for it to work, and the scripts were not executable.
cd /Applications/geonetwork/bin
su chmod 777 *.sh
And then:
./start.sh
|
||
- GeoNetwork initially needs some time to organise and start up. A local H2 database will be created for storage purposes. After 2-5 minutes you will be able to access the service via your browser. Open the website http://localhost:8080/geonetwork. | ||
|
||
- The server will not start if port 8080 is taken by another process or the application does not have write privileges on the application folder. Check the logfile located at {installation-folder}/jetty/logs for potential causes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a trouble shooting section
|
||
- On windows a shortcut to start the service will be added to the start menu. On other platforms navigate to the installation folder and start the startup.sh script. | ||
|
||
- GeoNetwork initially needs some time to organise and start up. A local H2 database will be created for storage purposes. After 2-5 minutes you will be able to access the service via your browser. Open the website http://localhost:8080/geonetwork. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be a section you reuse and include in each quickstart....
... by removing double colon from preceding paragraph end
Make dbeaver.io into a URL
…2-dbf Update misc.rst
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with Jody's comments throughout. There are a few language tweaks I would make, but it might be easier to do that once it's published
make last two code blocks show
* Update readme to reflect build steps * Add ccbya license to pom and repository to reflect footer used in docs * Consistently build english and french as the default * Seperate properties for translations to download, and languages to build * All profile is now only responsible for defining translations to download and langues to build * Disable colored output for build server * Remove unused _build/locale folder * Ignore Visual Studio Code and DS_Store files Signed-off-by: Jody Garnett <jody.garnett@gmail.com>
Search doc / Fix invalid link
…-url Proxy / Limit to URL host registered in records
This page will list GeoNetwork installation with a screenshot. A script allows to update the page once a new url is added to the list. This page can be linked from https://geonetwork-opensource.org/gallery/gallery.html (which contains a list with a number of not working nodes). The script check the URL returns something before adding it. ``` ./build-gallery.sh ______________________________ Adding http://metadata.vlaanderen.be/ to gallery page... * URL does not exist. ______________________________ Adding http://catalogue.geo-ide.developpement-durable.gouv.fr/ to gallery page... * Building thumbnail ... ✔ Generated 1 screenshot from 1 url and 1 size . Thumbnail catalogue.geo-ide.developpement-durable.gouv.fr.png created. * Portal added to the gallery. ______________________________ Adding http://geocatalog.webservice-energy.org/geonetwork to gallery page... * Building thumbnail ... ✔ Generated 1 screenshot from 1 url and 1 size . Thumbnail geocatalog.webservice-energy.org!geonetwork.png created. * Portal added to the gallery. ```
Gallery / Add a list of some GeoNetwork nodes
Signed-off-by: Jody Garnett <jody.garnett@gmail.com>
how to set up geonetwork for opensearch
closing this, it is outdated, preparing a new pr, thanx all for reviewing! |
using the howto templated suggested by swapnill