Self-host Swagger UI on a VPS

Renders an OpenAPI description as interactive API documentation you can try from the browser. It is static, has no login and no database.

levelrail-cli templates deploy swagger-ui --name my-swagger-ui

Specification

Status
Listed
Category
Developer Tools
Services
swagger-ui
Ports
8080
Volumes
0
Memory
about 64 MiB
arm64
unknown
amd64
unknown
Settings to fill in
none
Listing
Community template

About Swagger UI

Renders an OpenAPI description as interactive API documentation you can try from the browser. It is static, has no login and no database.

What it deploys

Swagger UI runs as one service in a single Compose app, listening on port 8080.

ServiceImageTagPortsVolumes
swagger-ui swaggerapi/swagger-ui v5.34.1 8080 none

Before you install

  • CPU architecture. arm64 unknown. The scan could not read a manifest or the tag is chosen at install time. This is not a claim either way.
  • Listed. It is in the catalog. Back up the data volume before changing an image tag.

Settings and environment

You do not have to fill in anything. Values are never shown here.

ServiceVariableValue
swagger-uiURLPreset by the template

Install Swagger UI on a VPS

  1. Install Levelrail on a fresh VPS

    Run this as root on a Linux server (amd64 or arm64) with ports 80 and 443 reachable. The installer prints a setup link.

    curl -fsSL https://levelrail.com/install.sh | sudo sh
  2. Sign in

    Open the setup link, choose a password, then log the CLI in. The CLI install command is curl -fsSL https://levelrail.com/install-cli.sh | sh if the machine does not have it. See Getting started.

    levelrail-cli login --device
  3. Read the template

    Shows the entry, including its full compose.yaml.

    levelrail-cli templates get swagger-ui
  4. Deploy it

    This deploys the template compose file as an app. The app name defaults to the template id; --name sets another.

    levelrail-cli templates deploy swagger-ui --name my-swagger-ui

Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then Swagger UI.

More in Developer Tools

All Developer Tools templates