Documentation

The Shipfile is a configuration file that controls your app's deployment. It uses a YAML-like syntax and supports two main commands:

Used for running commands before the main application starts.

Single line command:

script: python manage.py migrate

Multiple line commands:

script: |
  python manage.py makemigrations
  python manage.py migrate

Specifies the command to start your application.

Examples:

run: python main.py
run: uvicorn main:app --host 0.0.0.0 --port 8000

Here are some complete Shipfile examples:

Basic Django application:

script: python manage.py migrate
run: gunicorn myproject.wsgi:application

FastAPI application with multiple setup steps:

script: |
  pip install -r requirements.txt
  alembic upgrade head
run: uvicorn main:app --host 0.0.0.0 --port 8000

Node.js application:

script: npm install
run: node server.js

Remember, the Shipfile should be placed in the root directory of your project and named exactly Shipfile (no file extension).

Supported Platforms