GitHub App Integration

The DeployStack GitHub App ensures your Infrastructure as Code (IaC) templates remain synchronized with your Docker configurations. After submitting your repository to deploystack.io, install our GitHub App to enable automatic updates.

How It Works

When you install the DeployStack Repository Sync app, it monitors specific files in your repository:

• .deploystack/ directory - Contains your Docker configurations and assets
• README.md - For README.md updates

When changes are detected in these files, the app automatically triggers an update of your IaC templates in our deploy-templates repository.

Installation

1. Visit the installation page
2. Select the repositories you want to monitor
3. Approve the requested permissions

Security & Permissions

The app follows the principle of least privilege and requires only:

• Read access to repository contents
• Read access to repository metadata

These minimal permissions ensure the app can only:

• Monitor changes to your Docker configurations
• Access basic repository information needed for template generation

What Gets Updated?

When the app detects changes, it automatically updates:

• Repository metadata in our catalog:
  Topics
  Repository Homepage
  Description
• IaC templates
  Depends on which technique (docker compose or docker run command) you choose, you can upload the docker-compose.yml or docker-run.txt in the .deploystack directory. Every time you update the files on your main branch (or additional branch), IaC templates will be updated automatically - Automatic Updates.
• Environment variables
  To make it easier for a user to deploy IaC templates, it is recommended to work with environment variables. For this purpose, you can upload an env file and add your appropriate variables - Environment Variables.
• DeployStack Configuration
• Project / Applicaton Logo
  It is possible to upload your own logo to DeployStack catalog. To do this you need to upload a file to our directory .deploystack. Read more about it here: Repository Logo

Managing the Integration

You can manage or remove the integration at any time through your GitHub Applications Settings. The app installation can be configured for specific repositories or your entire organization.

Next Steps

After installing the app:

1. Make changes to your Docker configurations in the .deploystack directory
2. Commit and push your changes
3. DeployStack will automatically update your deployment templates

For details about the .deploystack directory structure, check our .deploystack Directory Reference.