forked from geonetwork/geonetwork-ui
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into datahub-ign-2905
- Loading branch information
Showing
121 changed files
with
9,162 additions
and
1,391 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,147 +1,7 @@ | ||
| # Datahub | ||
|
|
||
| UI of the web application `datahub`. | ||
| The Datahub is an application to provide a default, pure and simple UI for metadata and dataset search. | ||
|
|
||
| `datahub` is an application to provide a default, pure and simple UI for metadata and dataset search. | ||
| More information here: https://geonetwork.github.io/geonetwork-ui/main/docs/apps/datahub.html | ||
|
|
||
| Inspire by Opendata catalogs (CKAN, Opendatasoft), the Hub will host geo and non-geo dataset. It will provide dataviz tool and focuses the experience on the dataset instead of on the metadata. | ||
|
|
||
| ## How to run it | ||
|
|
||
| The Datahub application is available as a docker image or as a ZIP archive. | ||
|
|
||
| ### With docker | ||
|
|
||
| The docker image is `geonetwork/geonetwork-ui-datahub`. | ||
|
|
||
| To run it on the 8080 port with a custom GN4 API url and proxy path, use: | ||
|
|
||
| ```bash | ||
| $ docker run -p 8080:80 \ | ||
| -e GN4_API_URL=https://gn4.custom/geonetwork/srv/api \ | ||
| -e PROXY_PATH=/proxy?url= \ | ||
| geonetwork/geonetwork-ui-datahub | ||
| ``` | ||
|
|
||
| Notice how the `GN4_API_URL` and `PROXY_PATH` variables are used to override any values present in the app configuration file. | ||
| **This override will happen everytime the docker container is started.** | ||
|
|
||
| The application will be available on http://localhost:8080/datahub/. | ||
|
|
||
| #### Specifying a custom configuration file | ||
|
|
||
| If the `GN4_API_URL` and `PROXY_PATH` environment variables are not enough and you want to specify a full configuration file, | ||
| you can do so like this: | ||
|
|
||
| ```bash | ||
| # this assumes a file named `default.toml` is located in the /home/user/custom-conf directory: | ||
| $ docker run -p 8080:80 \ | ||
| -v /home/user/custom-conf:/conf \ | ||
| geonetwork/geonetwork-ui-datahub | ||
| ``` | ||
|
|
||
| If a file named `default.toml` is found in the `/conf` folder _of the app container_ at startup, it will be used by the application. | ||
|
|
||
| You can specify a different directory to look for the `default.toml` file using the `CONFIG_DIRECTORY_OVERRIDE` env variable, like so: | ||
|
|
||
| ```bash | ||
| # this assumes a file named `default.toml` is located in the /home/user/custom-conf directory: | ||
| $ docker run -p 8080:80 \ | ||
| -v /home/user/custom-conf:/some/random/path \ | ||
| -e CONFIG_DIRECTORY_OVERRIDE=/some/random/path \ | ||
| geonetwork/geonetwork-ui-datahub | ||
| ``` | ||
|
|
||
| This can be useful when dealing with existing volumes having their own directory structure. | ||
|
|
||
| #### Adding custom assets to the docker container | ||
|
|
||
| Any file found in the `/assets` folder _of the app container_ at startup will be copied along with the other assets already present. Existing assets with conflicting names will be | ||
| replaced. Directory structure in the `/assets` folder will be preserved. | ||
|
|
||
| For each image file present in the copied assets, a [preload link](https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types/preload) will be created in the `index.html` file of the application. This will help reducing the | ||
| time to first significant draw for new visitors, especially for header backgrounds and the like. | ||
|
|
||
| You can specify a different directory to look for the custom assets using the `ASSETS_DIRECTORY_OVERRIDE` env variable, like so: | ||
|
|
||
| ```bash | ||
| # custom assets are located in the /home/user/my-assets directory: | ||
| $ docker run -p 8080:80 \ | ||
| -v /home/user/my-assets:/some/random/path \ | ||
| -e ASSETS_DIRECTORY_OVERRIDE=/some/random/path \ | ||
| geonetwork/geonetwork-ui-datahub | ||
| ``` | ||
|
|
||
| #### Adding custom scripts when deploying Datahub | ||
|
|
||
| You can deploy custom executable sh scripts when deploying a container by setting the environment variable `CUSTOM_SCRIPTS_DIRECTORY` pointing to a mounted volume. | ||
|
|
||
| It can be used to deploy custom header by example. | ||
|
|
||
| ```bash | ||
| $ docker run -p 8080:80 \ | ||
| -v /home/user/my-scripts:/some/random/path \ | ||
| -e CUSTOM_SCRIPTS_DIRECTORY=/some/random/path \ | ||
| geonetwork/geonetwork-ui-datahub | ||
| ``` | ||
|
|
||
| ### From the ZIP archive | ||
|
|
||
| Each release of GeoNetwork-UI comes with ZIP archives of all applications: https://github.com/geonetwork/geonetwork-ui/releases | ||
|
|
||
| Download the Datahub archive and simply serve its contents using an HTTP server like Apache or NGINX. | ||
|
|
||
| ## Configuration | ||
|
|
||
| See the [main README section for more info](../../README.md#application-configuration). | ||
|
|
||
| ## Development | ||
|
|
||
| > For the following instructions, make sure you are using Node v16+ and that you ran `npm install` before anything else. | ||
| Executing: | ||
|
|
||
| ``` | ||
| npx nx serve datahub | ||
| ``` | ||
|
|
||
| will run `datahub` as an Angular application available on [localhost:4200](http://localhost:4200/). | ||
|
|
||
| ### Proxy | ||
|
|
||
| The Datahub app can use a reverse proxy for querying WMS and WFS capabilities (thus working around | ||
| CORS limitations). | ||
|
|
||
| By default it is disabled in order not to hide those issues to the user. | ||
|
|
||
| You can specify a custom proxy path using the `proxy_path` setting in the `[global]` section of the app configuration file. The proxy is disabled when | ||
| no path is defined. | ||
|
|
||
| Please note that during development a proxy is provided by webpack on the `/dev-proxy?` url path. **It is | ||
| not used by default in the Datahub app, you will have to set it up yourself.** | ||
|
|
||
| ## Building without Docker | ||
|
|
||
| Before building, remember to edit the configuration file in [`conf/default.toml`](../../conf/default.toml) to fit your deployment. It indicates the `geonetwork4_api_url` and an optional `proxy_path` to use. | ||
|
|
||
| You can build the datahub app using the geonetwork-ui build command: | ||
|
|
||
| ```shell script | ||
| npm install | ||
| npx nx build datahub | ||
| ``` | ||
|
|
||
| The build artifact will be stored in the `dist/apps/datahub` directory, that can be deployed on a common webserver. Use the `--prod` flag for a production build. | ||
|
|
||
| The build also includes the app configuration file (`dist/apps/datahub/assets/configuration`). Do not modify the configuration file here, as it is overwritten on each build. | ||
|
|
||
| ## Building with Docker | ||
|
|
||
| You can build a docker image of the Datahub application like so: | ||
|
|
||
| ```bash | ||
| npm install | ||
| npx nx run datahub:docker-build | ||
| ``` | ||
|
|
||
| This will build a docker image with the tag `geonetwork/geonetwork-ui-datahub`. | ||
| See the [GeoNetwork-UI documentation](https://geonetwork.github.io/geonetwork-ui/main/docs/guide/run.html) to learn how to run and deploy the Datahub. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.