The Shipa Developer Hub

Welcome to the Shipa developer hub. You'll find comprehensive guides and documentation to help you start working with Shipa as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Changelog

Platforms

Adding New Platforms

$ shipa platform add <platform name> [--dockerfile/-d Dockerfile] [--image/-i image]

The command above adds a new platform to Shipa.

The name of the image can be automatically inferred in case you're using an official platform. A list of official platforms and instructions on creating a custom platform on Shipa is made available here as reference.

Examples:

$ shipa platform add java # uses the official Shipa java image from docker hub

📘

Available Platforms

The following platforms are currently available to be used in the command example above:

  • java
  • ruby
  • nodejs
  • php
  • python
  • go
  • elixir
  • perl
  • pypy
  • static (for deploying Docker containers)
  • lua
  • dotnet
$ shipa platform add java -i registry.company.com/shipa/java # uses a custom Java image
$ shipa platform add java -d /data/projects/java/Dockerfile # uses a local Dockerfile
$ shipa platform add java -d https://platforms.com/java/Dockerfile # uses a remote Dockerfile

Flags:

Flag

Description

-d, --dockerfile

(= "") URL or path to the Dockerfile used for building the platform image

-i, --image

(= "") Name of the prebuilt Docker image

Listing Platforms

$ shipa platform list

Lists available platforms in Shipa. All platforms displayed in this list may be used when creating new applications through the app create command.

Updating Platforms

$ shipa platform update <platform name> [--dockerfile/-d Dockerfile] [--disable/--enable] [--image/-i image]

The command above updates a platform in Shipa.

The name of the image can be automatically inferred in case you're using an official platform. A list of official platforms and instructions on creating a custom platform on Shipa is made available here as reference.

The flags --enable and --disable can be used for enabling or disabling a platform.

Examples:

$ shipa platform update java # uses the official Shipa java image from docker hub
$ shipa platform update java -i registry.company.com/shipa/java # uses a custom Java image
$ shipa platform update java -d /data/projects/java/Dockerfile # uses a local Dockerfile
$ shipa platform update java -d https://platforms.com/java/Dockerfile # uses a remote Dockerfile

Flags:

Flag

Description

-d, --dockerfile

(= "") URL or path to the Dockerfile used for building the platform image

--disable

(= false) Disables the platform

--enable

(= false) Enables the platform

-i, --image

(= "") Name of the prebuilt Docker image

Removing Platforms

$ shipa platform remove <platform name> [-y]

The command above removes a platform from Shipa. This command will fail if applications are using the platform when the command is issued.

Flags:

Flag

Description

-y, --assume-yes

(= false) Don't ask for confirmation

Updated about a month ago


Platforms


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.