mirror of
https://github.com/Dokploy/website
synced 2025-06-26 18:16:01 +00:00
Merge pull request #26 from jrparks/feat/add-gitea-repo
Add Gitea documentation and provider integration
This commit is contained in:
77
apps/docs/content/docs/core/(Git-Sources)/gitea.mdx
Normal file
77
apps/docs/content/docs/core/(Git-Sources)/gitea.mdx
Normal file
@@ -0,0 +1,77 @@
|
||||
---
|
||||
title: Gitea
|
||||
description: 'Configure Gitea repositories for deployments. This includes setting up access tokens, repository names, and branches.'
|
||||
---
|
||||
|
||||
|
||||
import { Callout } from 'fumadocs-ui/components/callout';
|
||||
|
||||
Dokploy offers a way to connect your Gitea Repository to your Dokploy panel, you can use Organizations or personal accounts.
|
||||
|
||||
|
||||
Go to `Git` and select `Gitea` as the source, then you can use the following options:
|
||||
|
||||
- **Application ID**: Select the application ID that you want to connect to Dokploy.
|
||||
- **Personal Secret**: Select the secret that you want to connect to Dokploy.
|
||||
- **Organization Name(Optional)**: Select the organization name that you want to connect to Dokploy (Ideal for Gitea Organizations).
|
||||
|
||||
Follow the steps to connect your Gitea account to Dokploy:
|
||||
|
||||
1. Go to your Gitea instance's settings (e.g., `https://gitea.com/user/settings/applications`) and scroll to the `Create a new OAuth2 Application`.
|
||||
2. Set Application Name: e.g., `Dokploy-Gitea-App`. Choose any name you want.
|
||||
3. Redirect URI: Copy the `Redirect URI` from Dokploy. e.g., `https://dokploy.com/api/providers/gitea/callback`.
|
||||
4. Check Confidential Client
|
||||
5. Click on `Create Application`.
|
||||
6. Copy the `Client ID` and `Client Secret` from Gitea and paste them in Dokploy's `Gitea` Modal section.
|
||||
7. Click on `Configure Gitea App`.
|
||||
8. That operation will save the Gitea Provider configuration and redirect you to Gitia to authorize Dokploy to have access.
|
||||
9. Click on `Authorize`.
|
||||
10. You will be redirected to the `Git` section of Dokploy.
|
||||
11. Now you can use the repositories from your Gitea Account in `Applications` or `Docker Compose` services.
|
||||
|
||||
<Callout type='warn'>
|
||||
Dokploy doesn't support Gitea Automatic deployments on each push you make to your repository.
|
||||
</Callout>
|
||||
|
||||
|
||||
## Setup Automatic Deployments
|
||||
|
||||
You can configure automatic deployments in Dokploy for the Following Services:
|
||||
|
||||
1. **Applications**
|
||||
2. **Docker Compose**
|
||||
|
||||
The steps are the same for both services.
|
||||
|
||||
1. Go to either `Applications` or `Docker Compose` and go to `Deployments` Tab.
|
||||
2. Copy the `Webhook URL`.
|
||||
3. Go to your Gitea Account and select the repository.
|
||||
4. In the left menu, select `Settings` and then `Webhooks`.
|
||||
5. Click on `Add Webhook`.
|
||||
6. Set the `URL` to the one you copied in the previous step.
|
||||
7. In the Trigger section, select `Push Events`.
|
||||
8. Click on `Add Webhook`.
|
||||
9. Click on `Save`.
|
||||
10. Now you have automatic deployments enabled for the selected repository.
|
||||
|
||||
|
||||
## Clarification on Automatic Deployments
|
||||
|
||||
By default, Dokploy will automatically deploy your application on the Branch you have selected.
|
||||
|
||||
e.g., Let's suppose you have an `application` in this way:
|
||||
|
||||
Repository: `my-app`
|
||||
Branch: `feature`
|
||||
|
||||
If you try to make a push on another branch e.g., `main`, Dokploy will not automatically deploy your application, because
|
||||
your application has selected `feature` as the Branch.
|
||||
|
||||
<Callout>
|
||||
In the case you want to have multiple applications in the same repository, e.g., (development, staging, production), you can create 3 `Applications` in Dokploy
|
||||
and select the branch in each of them.
|
||||
|
||||
This is very useful if you want to have multiple environments for the same application.
|
||||
</Callout>
|
||||
|
||||
<userStyle>Normal</userStyle>
|
||||
@@ -16,7 +16,7 @@ and all your application will be down for this reasson, this is mainly problem f
|
||||
You have two options to solve this problem:
|
||||
|
||||
1. Increase the resources of your server CPU, RAM, Disk (Probably is not a good idea and cheapest solution)
|
||||
2. Build & Publish the application in a CI/CD pipeline eg. Github Actions, Gitlab CI, etc. (Recommended)
|
||||
2. Build & Publish the application in a CI/CD pipeline eg. Github Actions, Gitlab CI, Gitea Actions, etc. (Recommended)
|
||||
|
||||
|
||||
### Build & Publish the application in a CI/CD pipeline
|
||||
|
||||
@@ -52,7 +52,7 @@ Webhooks allow you to automatically deploy your application whenever changes are
|
||||
|
||||
#### 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.
|
||||
- **Branch Matching**: When using Git-based providers (GitHub, GitLab, Gitea, 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.
|
||||
- **Docker Tags**: For deployments using DockerHub, ensure the tag pushed matches the one specified in Dokploy.
|
||||
- The steps are the same for all the providers.
|
||||
|
||||
|
||||
@@ -15,6 +15,7 @@ Comparison of the following deployment tools:
|
||||
| **User Permission Management** | ✅ | ❌ | ❌ | ✅ |
|
||||
| **Bitbucket Integration** | ✅ | ❌ | ❌ | ❌ |
|
||||
| **Gitlab Integration** | ✅ | ❌ | ❌ | ❌ |
|
||||
| **Gitea Integration** | ✅ | ❌ | ✅ | ❌ |
|
||||
| **Advanced User Permission Management** | ✅ | ❌ | ❌ | ❌ |
|
||||
| **Terminal Access Built In** | ✅ | ❌ | ❌ | ✅ |
|
||||
| **Database Support** | ✅ | ✅ | ❌ | ✅ |
|
||||
|
||||
@@ -8,16 +8,18 @@ Dokploy offers several deployment methods, streamlining the process whether you'
|
||||
1. GitHub
|
||||
2. Gitlab
|
||||
3. Bitbucket
|
||||
4. Git
|
||||
5. Docker (Only Applications)
|
||||
6. Drag and Drop .zip (Only Applications)
|
||||
7. Raw (Only Docker Compose)
|
||||
4. Gitea
|
||||
5. Git
|
||||
6. Docker (Only Applications)
|
||||
7. Drag and Drop .zip (Only Applications)
|
||||
8. Raw (Only Docker Compose)
|
||||
|
||||
## GitHub, Gitlab, Bitbucket
|
||||
## GitHub, Gitlab, Bitbucket, Gitea
|
||||
|
||||
1. [Github](/docs/core/github) Guide.
|
||||
2. [Gitlab](/docs/core/gitlab) guide.
|
||||
3. [Bitbucket](/docs/core/bitbucket) guide.
|
||||
4. [Gitea](/docs/core/gitea) guide.
|
||||
|
||||
## Git
|
||||
|
||||
@@ -73,3 +75,4 @@ You can upload a zip file directly from your computer and trigger a deployment.
|
||||
|
||||
You specify a docker compose file directly in the code editor and trigger a deployment.
|
||||
|
||||
<userStyle>Normal</userStyle>
|
||||
@@ -1,33 +1,33 @@
|
||||
---
|
||||
title: Watch Paths
|
||||
description: Learn how to use watch paths in your application or docker compose.
|
||||
---
|
||||
---
|
||||
title: Watch Paths
|
||||
description: Learn how to use watch paths in your application or docker compose.
|
||||
---
|
||||
|
||||
Watch paths are a feature that allows you to monitor specific directories or files for changes and automatically trigger actions when modifications occur.
|
||||
Watch paths are a feature that allows you to monitor specific directories or files for changes and automatically trigger actions when modifications occur.
|
||||
|
||||
## Overview
|
||||
## Overview
|
||||
|
||||
Watch paths functionality is available for both standalone applications and Docker Compose configurations. This feature helps automate deployments based on file changes in your repository.
|
||||
Watch paths functionality is available for both standalone applications and Docker Compose configurations. This feature helps automate deployments based on file changes in your repository.
|
||||
|
||||
## Supported Source Providers
|
||||
## Supported Source Providers
|
||||
|
||||
The following source control providers are supported:
|
||||
The following source control providers are supported:
|
||||
|
||||
- GitHub
|
||||
- GitLab
|
||||
- Bitbucket
|
||||
- Git (works with Bitbucket, Github, and GitLab repositories)
|
||||
- GitHub
|
||||
- GitLab
|
||||
- Bitbucket
|
||||
- Git (works with Bitbucket, Github, and GitLab repositories)
|
||||
|
||||
## Basic Usage
|
||||
## Basic Usage
|
||||
|
||||
Let's say you have a project with the following directory structure:
|
||||
Let's say you have a project with the following directory structure:
|
||||
|
||||
```
|
||||
my-app/
|
||||
├── src/
|
||||
│ ├── index.js
|
||||
├── public/
|
||||
```
|
||||
```
|
||||
my-app/
|
||||
├── src/
|
||||
│ ├── index.js
|
||||
├── public/
|
||||
```
|
||||
|
||||
By default, dokploy accepts an array of paths, allowing you to monitor multiple locations. For example:
|
||||
|
||||
@@ -42,8 +42,9 @@ Watch Paths works out of the box with zero configuration when using GitHub as yo
|
||||
- [Bitbucket Integration](/docs/core/bitbucket)
|
||||
- [GitLab Integration](/docs/core/gitlab)
|
||||
- [GitHub Integration](/docs/core/github)
|
||||
- [Gitea Integration](/docs/core/gitea)
|
||||
|
||||
Note: When using the Git provider, the functionality will only work with GitHub, GitLab, or Bitbucket repositories.
|
||||
Note: When using the Git provider, the functionality will only work with GitHub, GitLab, Bitbucket, or Gitea repositories.
|
||||
|
||||
## Pattern Matching Features
|
||||
|
||||
@@ -69,3 +70,4 @@ We support a wide range of pattern matching features:
|
||||
- Regex logical "or":
|
||||
- `foo/(abc|xyz).js` (matches foo/abc.js or foo/xyz.js)
|
||||
|
||||
<userStyle>Normal</userStyle>
|
||||
@@ -101,6 +101,7 @@
|
||||
|-- reference-gitProvider.mdx
|
||||
|-- reference-github.mdx
|
||||
|-- reference-gitlab.mdx
|
||||
|-- reference-gitea.mdx
|
||||
|-- reference-mariadb.mdx
|
||||
|-- reference-mongo.mdx
|
||||
|-- reference-mounts.mdx
|
||||
@@ -135,6 +136,7 @@
|
||||
|-- reference-gitProvider.mdx
|
||||
|-- reference-github.mdx
|
||||
|-- reference-gitlab.mdx
|
||||
|-- reference-gitea.mdx
|
||||
|-- reference-mariadb.mdx
|
||||
|-- reference-mongo.mdx
|
||||
|-- reference-mounts.mdx
|
||||
@@ -165,6 +167,7 @@
|
||||
|-- bitbucket.mdx
|
||||
|-- github.mdx
|
||||
|-- gitlab.mdx
|
||||
|-- gitea.mdx
|
||||
|-- (Notifications)
|
||||
|-- discord.mdx
|
||||
|-- email.mdx
|
||||
|
||||
Reference in New Issue
Block a user