Skip to content

Commit

Permalink
feat: add config migration tool info (#1754)
Browse files Browse the repository at this point in the history
  • Loading branch information
TheGreatRefrigerator authored Mar 20, 2024
2 parents b089736 + 3d0698e commit 94426d8
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 10 deletions.
8 changes: 4 additions & 4 deletions docker-entrypoint.sh
Original file line number Diff line number Diff line change
Expand Up @@ -336,12 +336,12 @@ success "CATALINA_OPTS and JAVA_OPTS ready. For details set CONTAINER_LOG_LEVEL=
# Print the migration info if print_migration_info is set to true but not if PRINT_MIGRATION_INFO is set to False
if [ "${print_migration_info}" = "true" ]; then
info "##########################################"
info "# Config migration and usage information #"
info "# Config options and migration information #"
info "##########################################"
info ">>> Migration information <<<"
info "Find detailed information for migrating to ORS version 8 at: "# TODO
info ">>> Config migration <<<"
info "Configuring ors with a .json config is deprecated and will be removed in the future."
warning "Configuring ors with a .json config is deprecated and will be removed in the future."
info "You can use the ors-config-migration tool to migrate your .json config to .yml: https://github.com/GIScience/ors-config-migration#usage"
info ">>> Config options <<<"
info "You have the following options to configure ORS:"
info "Method 1 yml config:"
info "> docker cp ors-container-name:${ORS_HOME}/config/example-ors-config.yml ./ors-config.yml"
Expand Down
2 changes: 1 addition & 1 deletion docs/run-instance/configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Which format to use in which scenario is documented in the config documentations

* `.yml` is the default configuration format since version 8. You can find an [example configuration file](https://github.com/GIScience/openrouteservice/blob/main/ors-config.yml) with all available configuration options. Only a minimal set of properties is active, all others are commented out.
* `.env` files for Docker setup. There is also an [example env file](https://github.com/GIScience/openrouteservice/blob/main/ors-config.env) that you can download and customize.
* `.json` config file: In the past openrouteservice was configured [via JSON file](json.md). This configuration method has been **deprecated** and will be eventually removed. Therefore, we strongly discourage you from using it. If you have an old JSON config, please consider to [migrate to the new config](migrate-from-json.md).
* `.json` config file: In the past openrouteservice was configured [via JSON file](json.md). This configuration method has been **deprecated** and will be eventually removed. Therefore, we strongly discourage you from using it. If you have an old JSON config, please consider to [migrate to the new config](https://github.com/GIScience/ors-config-migration#usage).

All of the above described config files can contain the same logic application properties.

Expand Down
4 changes: 2 additions & 2 deletions docs/run-instance/configuration/json.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Configuration via `ors-config.json`

:::warning
The ors-config.json is deprecated!
The ors-config.json is deprecated! [Migrate to ors-config.yml](https://github.com/GIScience/ors-config-migration#usage).
:::

The "old" configuration method is supported for a while for convenience.
The description below is kept as long as openrouteservice still supports configuration via JSON file,
but we do **not** recommend using this configuration method.
Please consider to [migrate JSON configuration](migrate-from-json.md) to the new style.
Please consider [migrating your JSON configuration](https://github.com/GIScience/ors-config-migration#usage) to the new style.
Note that currently all settings in a provided JSON configuration file will **override** any settings in the YAML file.

## ors
Expand Down
3 changes: 0 additions & 3 deletions docs/run-instance/configuration/migrate-from-json.md

This file was deleted.

0 comments on commit 94426d8

Please sign in to comment.