Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.portway.dev/llms.txt

Use this file to discover all available pages before exploring further.

Welcome! Let’s get up and running on Portway. This tutorial uses free Portway resources—no payment required. All you need is a compose file with the web app you want to deploy.

​
Prerequisites

  • Docker installed and running
  • A docker-compose.yml in your project
1

Install the Portway CLI

curl -fsSL https://portway.dev/install.sh | bash
You can also download the CLI from the GitHub releases.Follow the instructions to install the Portway CLI. Optionally, you can verify the installation:
portway --help
2

Login

portway login
3

Deploy from your Compose file

portway deploy -f docker-compose.yml
That’s it—Portway will provision and run your services in production. Once the deployment is complete, the CLI will output the URL of your app. You can also view the logs and metrics for your app.

​
Next steps

​
Add a custom domain

Each Portway web service and static site receives its own portway.app URL. You can also add your own custom domains to these service types. Learn how.

​
Learn about operational controls

Deploying your app is just the beginning. Check out a few of the ways you can manage and monitor your running services on Portway: