Skip to content

Commit

Permalink
docs(run-instance): initial new structure
Browse files Browse the repository at this point in the history
  • Loading branch information
jhaeu committed Feb 13, 2024
1 parent d025605 commit bb8540d
Show file tree
Hide file tree
Showing 22 changed files with 94 additions and 3 deletions.
32 changes: 32 additions & 0 deletions docs/.vitepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,38 @@ export default defineConfig({
{text: 'JSON config (deprecated)', link:'/run-instance/configuration/json.md'}
]
},
{text: 'As WAR', collapsed: true,
items: [
{text: 'build', link: '/run-instance/war/build.md'},
{text: 'download', link: '/run-instance/war/download.md'},
{text: 'configure', link: '/run-instance/war/configure.md'},
{text: 'run', link: '/run-instance/war/run.md'},
{text: 'troubleshoot', link: '/run-instance/war/troubleshoot.md'}
]},
{text: 'As JAR', collapsed: true,
items: [
{text: 'build', link: '/run-instance/jar/build.md'},
{text: 'download', link: '/run-instance/jar/download.md'},
{text: 'configure', link: '/run-instance/jar/configure.md'},
{text: 'run', link: '/run-instance/jar/run.md'},
{text: 'troubleshoot', link: '/run-instance/jar/troubleshoot.md'}
]},
{text: 'As Docker Container (WAR)', collapsed: true,
items: [
{text: 'build', link: '/run-instance/jar-docker/build.md'},
{text: 'download', link: '/run-instance/jar-docker/download.md'},
{text: 'configure', link: '/run-instance/jar-docker/configure.md'},
{text: 'run', link: '/run-instance/jar-docker/run.md'},
{text: 'troubleshoot', link: '/run-instance/jar-docker/troubleshoot.md'}
]},
{text: 'As Docker Container (JAR)', collapsed: true,
items: [
{text: 'build', link: '/run-instance/jar-docker/build.md'},
{text: 'download', link: '/run-instance/jar-docker/download.md'},
{text: 'configure', link: '/run-instance/jar-docker/configure.md'},
{text: 'run', link: '/run-instance/jar-docker/run.md'},
{text: 'troubleshoot', link: '/run-instance/jar-docker/troubleshoot.md'}
]},
]
},
{
Expand Down
45 changes: 42 additions & 3 deletions docs/run-instance/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,30 @@

If you need to customize the behavior of openrouteservice or if the features or quota provided by our public API is not sufficient for your needs, you can run your own openrouteservice instance on a server or your local computer. There are multiple options to achieve this.

The service can exist or be built in the form of 4 different artifact types:

* **WAR:** Like older versions, ORS v8 can still be built as a Web Application Resource/Web ARchive (WAR) which can be deployed into a web container like tomcat.
* **JAR:** Since v8, openrouteservice can be built as a fat JAR, that contains all its dependencies. The JAR can be started stand-alone, without an installed tomcat. The trick is, that an embedded servlet container (tomcat) is used.
* **Docker Image with WAR:** Docker images for ORS versions before v8 were built with a openrouteservice WAR that was running in a tomcat inside a Docker container. If required, you can still go this way, but it is no longer supported by the ORS team.
* **Docker Image with JAR:** Since v8, the docker images, that are created by the ORS team and published on [docker hub](https://hub.docker.com/r/openrouteservice/openrouteservice) contain an ORS fat JAR with an embedded tomcat.

No matter how you want to run your openrouteservice, you first need the corresponding artifact.
In the table below, we link the documentation for downloading or building the different artifact types,
how to configure and run the service and where to find logs for trouble shooting:

| Artifact | Build yourself | or Download | Configure | Run | Trouble shoot |
|--------------------|-------------------------------------------------|-------------------------------------------------------|---------------------------------------------------------|---------------------------------------------|---------------------------------------------------------------|
| WAR | [Build WAR](war/build.md) | [Download WAR](war/download.md) | [Configure WAR](war/configure.md) | [Run WAR](war/run.md) | [Troubleshoot WAR](war/troubleshoot.md) |
| JAR | [Build JAR](jar/build.md) | [Download JAR](jar/download.md) | [Configure JAR](jar/configure.md) | [Run JAR](jar/run.md) | [Troubleshoot JAR](jar/troubleshoot.md) |
| Docker Image (WAR) | see [older versions](...?) | no longer supported since v8 | [Configure Docker Image (WAR)](war-docker/configure.md) | [Run docker (WAR)](war-docker/run.md) | [Troubleshoot docker (WAR)](war-docker/troubleshoot.md) |
| Docker Image (JAR) | [Build Docker Image (JAR)](jar-docker/build.md) | [Download Docker Image (JAR)](jar-docker/download.md) | [Configure Docker Image (JAR)](jar-docker/configure.md) | [Run Docker Image (JAR)](jar-docker/run.md) | [Troubleshoot Docker Image (JAR)](jar-docker/troubleshoot.md) |


::: tip
We recommend to use one of the JAR options, plain or with docker.
:::


## Quick start

The fastest and easiest way to have an instance of openrouteservice running is to use our docker compose file. If you have docker installed, running the following commands should get everything done.
Expand All @@ -14,8 +38,23 @@ docker compose up
This will pull the latest nightly build of openrouteservice from Docker Hub and start it up using an example setup and the provided test OSM file for Heidelberg/Germany and surrounding area.
You can then modify the configuration and source file settings to match your needs. For more details, check the [Running with Docker](installation/running-with-docker) section.

## Installation

Please read the documentation regarding [system requirements](system-requirements) and [data](data) before continuing to properly [install](installation/index.md) your openrouteservice instance.
## Developer options

Of course, developers can also build a WAR or JAR or docker Image as described in the linked documentations,
but there is also the option to run openrouteservice directly

* [from an IDE](runDirectlyFromIDE.md) with specific run configurations
* [on the command line with maven](runDirectlyWithMaven.md)

## RPM Package

A new way to install openrouteservice ist RPM.

[//]: # (TODO describe)


## Prerequisites

For more information on configuring openrouteservice for your specific needs, see the [configuration](configuration/index.md) documentation.
Before you start with one of the mentioned options,
please read the documentation regarding [System Requirements](system-requirements) and [Data](data)!
1 change: 1 addition & 0 deletions docs/run-instance/jar-docker/build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Build Docker Image with openrouteservice JAR
1 change: 1 addition & 0 deletions docs/run-instance/jar-docker/configure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Configure Docker Image with openrouteservice JAR
1 change: 1 addition & 0 deletions docs/run-instance/jar-docker/download.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Download Docker Image with openrouteservice JAR
1 change: 1 addition & 0 deletions docs/run-instance/jar-docker/run.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Run Docker Image with openrouteservice JAR
1 change: 1 addition & 0 deletions docs/run-instance/jar-docker/troubleshoot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Troublelshoot Docker Image with openrouteservice JAR
1 change: 1 addition & 0 deletions docs/run-instance/jar/build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Build openrouteservice JAR
1 change: 1 addition & 0 deletions docs/run-instance/jar/configure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Configure openrouteservice JAR
1 change: 1 addition & 0 deletions docs/run-instance/jar/download.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Download openrouteservice JAR
1 change: 1 addition & 0 deletions docs/run-instance/jar/run.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Run openrouteservice JAR
1 change: 1 addition & 0 deletions docs/run-instance/jar/troubleshoot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Troubleshoot openrouteservice JAR
1 change: 1 addition & 0 deletions docs/run-instance/war-docker/build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Build Docker Image with openrouteservice WAR
1 change: 1 addition & 0 deletions docs/run-instance/war-docker/configure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Configure Docker Image with openrouteservice WAR
1 change: 1 addition & 0 deletions docs/run-instance/war-docker/download.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Download Docker Image with openrouteservice WAR
1 change: 1 addition & 0 deletions docs/run-instance/war-docker/run.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Run Docker Image with openrouteservice WAR
1 change: 1 addition & 0 deletions docs/run-instance/war-docker/troubleshoot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Troubleshoot Docker Image with openrouteservice WAR
1 change: 1 addition & 0 deletions docs/run-instance/war/build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Build openrouteservice WAR
1 change: 1 addition & 0 deletions docs/run-instance/war/configure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Configure openrouteservice WAR
1 change: 1 addition & 0 deletions docs/run-instance/war/download.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Download openrouteservice WAR
1 change: 1 addition & 0 deletions docs/run-instance/war/run.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Run openrouteservice WAR
1 change: 1 addition & 0 deletions docs/run-instance/war/troubleshoot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Troubleshoot openrouteservice WAR

0 comments on commit bb8540d

Please sign in to comment.