Skip to main content

Install

Requirements​

Otoroshi18.0.0 or later
Java17 or above

Download Otoroshi​

Otoroshi release

curl -L -o otoroshi.jar \
  'https://github.com/MAIF/otoroshi/releases/download/v18.0.0/otoroshi.jar'

Download the portal plugins​

Otoroshi API Portal release

Grab the latest jar from the releases page. The asset is named otoroshi-api-portal_3-<version>.jar, and comes with its checksum:

curl -L -o otoroshi-api-portal.jar \
  'https://github.com/cloud-apim/otoroshi-api-portal/releases/download/<version>/otoroshi-api-portal_3-<version>.jar'
curl -L -o otoroshi-api-portal.jar.sha256 \
  'https://github.com/cloud-apim/otoroshi-api-portal/releases/download/<version>/otoroshi-api-portal_3-<version>.jar.sha256'

shasum -a 256 otoroshi-api-portal.jar | cut -d ' ' -f 1
cat otoroshi-api-portal.jar.sha256

Run Otoroshi with the plugins​

java -cp "./otoroshi-api-portal.jar:./otoroshi.jar" \
  -Dotoroshi.adminLogin=admin \
  -Dotoroshi.adminPassword=password \
  -Dotoroshi.storage=file \
  play.core.server.ProdServerStart

The plugins Otoroshi API Portal and Otoroshi API Portal Catalog then appear in the list of plugins of the routes, in the Cloud APIM category.

For anything beyond a local trial, see the Otoroshi setup documentation.

Use Docker​

Alternatively, mount the jar into the plugins directory Otoroshi already scans:

docker run \
  -p 8080:8080 \
  -e APP_STORAGE=file \
  -e OTOROSHI_PLUGINS_DIR_PATH=/usr/app/plugins \
  -v "$(pwd)/otoroshi-api-portal.jar:/usr/app/plugins/otoroshi-api-portal.jar" \
  maif/otoroshi:18.0.0

What the pages load​

The pages of the portal are served by the plugin. They load three libraries from jsDelivr, at fixed versions — Scalar on the API reference, marked and highlight.js on the pages written in Markdown — and the Plus Jakarta Sans font from Google Fonts. The browsers of your developers need to reach them.