Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/deploystack/development/frontend/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,6 @@ Continue reading the detailed guides:
- [Internationalization (i18n)](/deploystack/development/frontend/internationalization) - Multi-language support
- [Plugin System](/deploystack/development/frontend/plugins) - Extending functionality
- [Router Optimization](/deploystack/development/frontend/router-optimization) - Performance improvements
- [Contributing Guidelines](/deploystack/development/frontend/contributing) - How to contribute

## Docker Development

Expand Down
9 changes: 9 additions & 0 deletions docs/deploystack/troubleshooting.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Troubleshooting DeployStack
description: Common issues and solutions for DeployStack MCP Serverdeployments
sidebar: Troubleshooting
---

# Troubleshooting DeployStack

Under this section, we will cover common issues and solutions for DeployStack MCP Server deployments. If you encounter any problems, please refer to the following troubleshooting steps.
2 changes: 1 addition & 1 deletion docs/docker-deployment/application-logo-configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Add a custom logo to make your application stand out in the DeployStack catalog.

## Adding Your Logo

Configure your logo in `.deploystack/config.yml` - [DeployStack Configuration File Reference](/deploystack/deploystack-config-file):
Configure your logo in `.deploystack/config.yml` - [DeployStack Configuration File Reference](/docker-deployment/deploystack-config-file):

```yaml
application:
Expand Down
4 changes: 2 additions & 2 deletions docs/docker-deployment/deploystack-config-file.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ The override process follows this order:

### Branch Deployment Settings

Before configuring multiple branch deployments, ensure you have installed the [DeployStack Repository Sync GitHub App](/deploystack/github-application), as it's required for branch monitoring and template updates.
Before configuring multiple branch deployments, ensure you have installed the [DeployStack Repository Sync GitHub App](/docker-deployment/github-application), as it's required for branch monitoring and template updates.

You can configure multiple branch deployments using the `deployment.branches` section:

Expand Down Expand Up @@ -256,4 +256,4 @@ deployment:

### Minimal Configuration example for logo update

Please visit our [Application Logo Configuration](/deploystack/application-logo-configuration) page.
Please visit our [Application Logo Configuration](/docker-deployment/application-logo-configuration) page.
12 changes: 6 additions & 6 deletions docs/docker-deployment/deploystack-configuration-directory.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Technical guide for setting up the .deploystack directory to manage

# .deploystack Directory Reference

The `.deploystack` directory in your repository contains configuration files that DeployStack uses to generate and maintain your Infrastructure as Code templates. Creating this repo allows you to enable the [lifecycle of IaC](/deploystack/iac-lifecycle). The deploystack configurations repo only makes sense if you also [install DeployStack GitHub app](/deploystack/github-application). Otherwise, changes to DeployStack backend will not be recognized.
The `.deploystack` directory in your repository contains configuration files that DeployStack uses to generate and maintain your Infrastructure as Code templates. Creating this repo allows you to enable the [lifecycle of IaC](/docker-deployment/iac-lifecycle). The deploystack configurations repo only makes sense if you also [install DeployStack GitHub app](/docker-deployment/github-application). Otherwise, changes to DeployStack backend will not be recognized.

<Callout>
`.deploystack` directory is optional. You don't need to create it to submit your repository to deploystack.io.
Expand All @@ -24,7 +24,7 @@ The `.deploystack` directory in your repository contains configuration files tha

### DeployStack Configuration File

Please read more at [DeployStack Configuration File Reference](/deploystack/deploystack-config-file).
Please read more at [DeployStack Configuration File Reference](/docker-deployment/deploystack-config-file).

### Docker Configuration

Expand Down Expand Up @@ -52,11 +52,11 @@ docker run -d -p 80:80 nginx:alpine

### Environment Variables

Please read more from our [environment variables](/deploystack/docker-environment-variables) page.
Please read more from our [environment variables](/docker-deployment/docker-environment-variables) page.

## Automatic Updates

When the [DeployStack GitHub App](/deploystack/github-application) is installed:
When the [DeployStack GitHub App](/docker-deployment/github-application) is installed:

1. Changes to specific (`docker-compose.yml` & `docker-run.txt`) file in `.deploystack/` trigger template updates
2. Updates only process when changes occur on the default branch
Expand All @@ -66,6 +66,6 @@ When the [DeployStack GitHub App](/deploystack/github-application) is installed:

- The `.deploystack` directory is **optional**
- Without this directory, automatic template updates are **not** available
- You can add the directory and install the [DeployStack GitHub Sync App](/deploystack/github-application) at any time
- [Environment variables](/deploystack/docker-environment-variables) and [DeployStack config](/deploystack/deploystack-config-file) are optional components
- You can add the directory and install the [DeployStack GitHub Sync App](/docker-deployment/github-application) at any time
- [Environment variables](/docker-deployment/docker-environment-variables) and [DeployStack config](/docker-deployment/deploystack-config-file) are optional components
- Only one Docker configuration file should be used (either compose or run)
6 changes: 3 additions & 3 deletions docs/docker-deployment/docker-compose-requirements.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Currently, DeployStack only supports public images from Docker Hub. If you need

## Environment Variables

Please read more from our [environment variables](/deploystack/docker-environment-variables) page.
Please read more from our [environment variables](/docker-deployment/docker-environment-variables) page.

## Validation

Expand All @@ -98,5 +98,5 @@ When you submit your repository, we perform these checks:

## Next Steps

- See how [One-Click Deploy](/deploystack/one-click-deploy) works
- Check the [Troubleshooting](/deploystack/troubleshooting) guide if you run into issues
- See how [One-Click Deploy](/docker-deployment/one-click-deploy) works
- Check the [Troubleshooting](/docker-deployment/troubleshooting) guide if you run into issues
4 changes: 2 additions & 2 deletions docs/docker-deployment/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Create a `.deploystack` directory in your repository with these components:
- `docker-run.txt`: Alternative to compose file, contains your Docker run command
- Only one of these files should be present

For more configuration options please check our [.deploystack Directory Reference](/deploystack/deploystack-configuration-directory).
For more configuration options please check our [.deploystack Directory Reference](/docker-deployment/deploystack-configuration-directory).

### GitHub App Integration

Expand Down Expand Up @@ -191,6 +191,6 @@ After template generation:

## Need Additional Help?

- Review our detailed [Troubleshooting Guide](/deploystack/troubleshooting)
- Review our detailed [Troubleshooting Guide](/docker-deployment/troubleshooting)
- Join our active [Discord Community](https://discord.gg/UjFWwByB)
- Submit issues on GitHub to our [Feedback repository](https://github.com/deploystackio/feedback)
10 changes: 5 additions & 5 deletions docs/docker-deployment/github-application.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The DeployStack GitHub App ensures your Infrastructure as Code (IaC) templates r

When you install the [DeployStack Repository Sync](https://github.com/apps/deploystack-repository-sync) app, it monitors specific files in your repository:

- `.deploystack/` directory - [Contains your Docker configurations and assets](/deploystack/deploystack-configuration-directory)
- `.deploystack/` directory - [Contains your Docker configurations and assets](/docker-deployment/deploystack-configuration-directory)
- `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](https://github.com/deploystackio/deploy-templates) repository.
Expand Down Expand Up @@ -47,12 +47,12 @@ When the app detects changes, it automatically updates:
- 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](/deploystack/deploystack-configuration-directory#automatic-updates).
- 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](/docker-deployment/deploystack-configuration-directory#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/deploystack-configuration-directory#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](/docker-deployment/deploystack-configuration-directory#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](/deploystack/deploystack-configuration-directory#repository-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](/docker-deployment/deploystack-configuration-directory#repository-logo)

## Managing the Integration

Expand All @@ -66,4 +66,4 @@ After installing the app:
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](/deploystack/deploystack-configuration-directory).
For details about the `.deploystack` directory structure, check our [.deploystack Directory Reference](/docker-deployment/deploystack-configuration-directory).
6 changes: 3 additions & 3 deletions docs/docker-deployment/iac-lifecycle.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This guide explains how DeployStack manages and updates your Infrastructure as C

### Initial Setup

1. Create a `.deploystack` [configuration directory](/deploystack/deploystack-configuration-directory) in your repository
1. Create a `.deploystack` [configuration directory](/docker-deployment/deploystack-configuration-directory) in your repository
2. Add your Docker configuration files:
- `docker-compose.yml` for Compose configurations
- `docker-run.txt` for Docker run commands
Expand All @@ -20,7 +20,7 @@ This guide explains how DeployStack manages and updates your Infrastructure as C

### Enabling Automatic Updates

Install the [DeployStack Repository Sync](/deploystack/github-application) GitHub App to keep your templates up to date when:
Install the [DeployStack Repository Sync](/docker-deployment/github-application) GitHub App to keep your templates up to date when:

- You modify Docker configurations in the `.deploystack` directory
- Cloud providers update their IaC specifications
Expand All @@ -36,7 +36,7 @@ All IaC templates are stored in public and open-source repository: [https://gith

### Prerequisites for activating the flow

1. You have installed the [DeployStack GitHub app](/deploystack/github-application).
1. You have installed the [DeployStack GitHub app](/docker-deployment/github-application).
2. You have created the `.deploystack/docker-run.txt` or `.deploystack/docker-compose.yml` file.

The choice between `docker-run.txt` or `docker-compose.yml` depends on the submission process used to DeployStack. When submitting to DeployStack, you can choose two methods -> Docker Run or Docker Compose.
Expand Down
8 changes: 4 additions & 4 deletions docs/docker-deployment/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ DeployStack helps you deploy Docker Compose and Docker Run applications across d

## Documentation Sections

- [Getting Started](/deploystack/getting-started) - Quick introduction and first steps
- [Docker Compose Requirements](/deploystack/docker-compose-requirements) - Learn about supported configurations
- [One-Click Deploy](/deploystack/one-click-deploy) - Learn about deployment automation
- [Troubleshooting](/deploystack/troubleshooting) - Resolve common issues
- [Getting Started](/docker-deployment/getting-started) - Quick introduction and first steps
- [Docker Compose Requirements](/docker-deployment/docker-compose-requirements) - Learn about supported configurations
- [One-Click Deploy](/docker-deployment/one-click-deploy) - Learn about deployment automation
- [Troubleshooting](/docker-deployment/troubleshooting) - Resolve common issues

## Additional Resources

Expand Down
6 changes: 3 additions & 3 deletions docs/docker-deployment/multiple-branches.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Every repository starts with its default branch (typically `main` or `master`).

When you change your default branch in GitHub:

- DeployStack automatically detects the change - you need to install [DeployStack GitHub App](/deploystack/github-application)
- DeployStack automatically detects the change - you need to install [DeployStack GitHub App](/docker-deployment/github-application)
- Regenerates templates for the new default branch
- Updates all deployment buttons

Expand Down Expand Up @@ -80,7 +80,7 @@ This structure allows you to:
- Modify service configurations independently
- Keep each version's deployment parameters isolated

Remember: The DeployStack GitHub App only monitors the standard filenames: check [.deploystack Directory Reference for more info](/deploystack/deploystack-configuration-directory)
Remember: The DeployStack GitHub App only monitors the standard filenames: check [.deploystack Directory Reference for more info](/docker-deployment/deploystack-configuration-directory)

## Real-World Example

Expand Down Expand Up @@ -142,7 +142,7 @@ This strategy allows your users to:
- Maximum of 5 active branches supported
- Each branch can have unique Docker configurations
- Default branch can be changed (switch to another branch and make it default) but not excluded
- Branch configurations ([DeployStack config file](/deploystack/deploystack-config-file)) must be in the default branch
- Branch configurations ([DeployStack config file](/docker-deployment/deploystack-config-file)) must be in the default branch
- All branches are automatically monitored for changes
- Template regeneration happens automatically when:
- Branch content changes
Expand Down
6 changes: 3 additions & 3 deletions docs/docker-deployment/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ The submitted docker-compose file doesn't meet the required format or contains u
**Solution:**

- Validate your docker-compose file syntax
- Check our [Docker Compose Requirements](/deploystack/docker-compose-requirements) page
- Check our [Docker Compose Requirements](/docker-deployment/docker-compose-requirements) page
- Ensure you're using supported features only

## Error Converting Docker Compose to IaC
Expand Down Expand Up @@ -139,7 +139,7 @@ This indicates an unexpected error in our validation process.
## General Troubleshooting Tips

1. Validate your docker-compose file locally before submission
2. Ensure your repository meets all [requirements](/deploystack/docker-compose-requirements)
2. Ensure your repository meets all [requirements](/docker-deployment/docker-compose-requirements)
3. Check that all services use supported configurations
4. Verify your repository is public and accessible

Expand All @@ -148,5 +148,5 @@ This indicates an unexpected error in our validation process.
If you're still experiencing issues:

- Join our [Discord community](https://discord.gg/UjFWwByB)
- Check our [Docker Compose Requirements](/deploystack/docker-compose-requirements)
- Check our [Docker Compose Requirements](/docker-deployment/docker-compose-requirements)
- Review [supported features](/docker-to-iac/supported-docker-compose-variables)
3 changes: 0 additions & 3 deletions docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -85,13 +85,10 @@ Public repository for feature requests, bug reports, and roadmap discussions
- Include comprehensive documentation and usage examples
- Ensure production-ready deployment configurations

Visit our [MCP Server Development Guide](/deploystack/mcp-development) for detailed instructions.

## Community and Support

- Join our [Discord community](https://discord.gg/42Ce3S7b3b) for real-time discussions
- Explore the [MCP Server Catalog](https://deploystack.io/mcp) for deployment-ready servers
- Check our [troubleshooting guide](/deploystack/troubleshooting) for common issues
- Follow [@deploystack](https://twitter.com/deploystack) for ecosystem updates

Ready to eliminate MCP server deployment complexity? [Get started for free →](https://cloud.deploystack.io)