Dokploy/website
1
0
Fork 0
mirror of https://github.com/Dokploy/website synced 2025-06-26 18:16:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

feat: add SEO

Browse Source
This commit is contained in:
Mauricio Siu
2024-11-09 22:59:04 -06:00
parent 8267c4a7b6
commit 179e97dd56
47 changed files with 1346 additions and 152 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
apps/docs-v2/content/docs/core/docker-compose/auto-deploy.mdx
View File

@@ -1,84 +0,0 @@
---
title: Auto-deploy
description: How to auto-deploy your docker-compose application with Dokploy
---
Automatically deploying your docker-compose application to Dokploy can be achieved through two primary methods: using Webhooks or the Dokploy API. Each method supports various platforms and provides a streamlined deployment process.
## Github
For Github, we provide autodeploy without any configuration. This will automatically deploy your application whenever you push to your repository.
## Webhook URL
Webhooks allow you to automatically deploy your docker-compose application whenever changes are made in your source repository.
- GitHub
- GitLab
- Bitbucket
- Gitea
### Configuration Steps
1. **Enable Auto Deploy**: Toggle the 'Auto Deploy' button found in the general tab of your application settings in Dokploy.
2. **Obtain Webhook URL**: Locate the Webhook URL from the deployment logs.
<ImageZoom
src="/assets/webhook-url-compose.png"
alt="Webhook URL"
width={1000}
height={500}
/>
3. **Configure Your Repository**:
- Navigate to your repository settings on your chosen platform.
- Add the webhook URL provided by Dokploy.
- Ensure the settings match the configuration necessary for triggering the webhook.
<ImageZoom
src="/assets/webhook-github.png"
alt="Webhook URL"
width={1000}
height={500}
/>
#### Important Notes
- **Branch Matching**: When using Git-based providers (GitHub, GitLab, etc.), ensure that the branch configured in Dokploy matches the branch you intend to push to. Misalignment will result in a "Branch Not Match" error.
- The steps are the same for all the providers.
## API Method
Deploy your application programmatically using the Dokploy API from anywhere.
### Steps to Deploy Using API
Steps:
1. **Generate a Token**: Create an API token in your profile settings on Dokploy.
2. **Retrieve Compose ID**:
```http
curl -X 'GET' \
'https://your-domain/api/project.all' \
-H 'accept: application/json'
-H 'Authorization: Bearer <token>'
```
This command lists all projects and services. Identify the composeId for the compose you wish to deploy.
3. **Trigger Deployment**:
```http
curl -X 'POST' \
'https://your-domain/api/compose.deploy' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{
"composeId": "string"
}'
```
This API method allows for flexible, scriptable deployment options, suitable for automated systems or situations where direct repository integration is not feasible.
In this way you can deploy your application from anywhere, you can use the webhook URL or the API.

12
apps/docs-v2/content/docs/core/docker-compose/domains.mdx
View File

@@ -3,7 +3,7 @@ title: Domains
description: Configure domains for your Docker Compose application.
---
When using Docker Compose, adding a domain to a service is a straightforward process. This guide will walk you through the necessary steps to configure domains for your application.
When using Docker Compose, adding a domain to a service is a straightforward process. This guide will walk you through the necessary steps to configure manual domains for your application.
Key Steps:
@@ -15,7 +15,7 @@ import { Callout } from "fumadocs-ui/components/callout";
<Callout title="Attention" type="info">
Since v0.7.0 Dokploy support domains natively. This means that you can
configure your domain directly in the Dokploy UI, without doing the rest of
the steps.
the steps check on the [domains section](/docs/core/domains).
</Callout>
Example Scenario
@@ -170,12 +170,4 @@ Understanding Traefik Labels
With these configurations in place, you're now ready to deploy your application using Docker Compose. This setup should be sufficient to get your services up and running with custom domain routing through Traefik.
## SSL Certificates and Further Configuration
If you have questions about when to use Let's Encrypt or other SSL certificate options, you can find more detailed information in the following resources:
1. [Certificates](/docs/core/domain/certificates)
2. [Docker Compose Domain](/docs/core/domain/docker-compose-setup)
3. [Docker Compose Example](/docs/core/docker-compose/example)
If you have any further questions or need assistance, join our [Discord server](https://discord.com/invite/2tBnJ3jDJc) and we'll be happy to help.

21
apps/docs-v2/content/docs/core/docker-compose/providers.mdx
View File

@@ -11,26 +11,9 @@ Dokploy offers several deployment methods, streamlining the process whether you'
- Git (Any Git Provider)
- Raw
## GitHub
## GitHub, Gitlab, Bitbucket
Deploying via GitHub:
1. Configure your GitHub repository in the `/dashboard/settings/git-providers`.
2. When creating an application, Dokploy automatically retrieves the available repositories and branches.
## Gitlab
Deploying via Gitlab:
1. Configure your Gitlab repository in the `/dashboard/settings/git-providers`.
2. When creating an application, Dokploy automatically retrieves the available repositories and branches.
## Bitbucket
Deploying via Bitbucket:
1. Configure your Bitbucket repository in the `/dashboard/settings/git-providers`.
2. When creating an application, Dokploy automatically retrieves the available repositories and branches.
Go to [Git Sources](/docs/core/github) and select the provider you want to use.
## Git