Version v1.5 of the documentation is no longer actively maintained. The site that you are currently viewing is an archived snapshot. For up-to-date documentation, see the latest version.

Guides

Step-by-step guides for using Porch to manage configuration packages

Overview

This section provides practical, step-by-step guides for using Porch. Each guide walks you through a specific workflow with commands, expected output, and troubleshooting tips.

Prerequisites

Before following these guides, ensure you have:

Guide Categories

Working with Repositories

Learn how to connect Porch to Git repositories where packages are stored:

Working with Package Revisions

Learn how to create and manage configuration packages:

If you’re new to Porch, follow this sequence:

  1. Start with repositories: Register a Git repository to store your packages
  2. Create your first package: Initialize a simple package and walk through the lifecycle (Draft → Proposed → Published)
  3. Clone and customize: Clone an existing package and modify it for your needs
  4. Explore other operations: Try copying, upgrading, and deleting packages

Getting Help

Each guide includes:

  • Prerequisites - What you need before starting
  • Step-by-step instructions - Commands with explanations
  • Verification steps - How to confirm success
  • Troubleshooting - Common issues and solutions

If you encounter issues not covered in the guides, see:

Working with Porch Repositories

A group of guides outlining how to interact with Porch repositories

Working with Package Revisions

A group of guides outlining how to interact with Package Revisions in Porch