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

Add Gitea documentation and provider integration

Browse Source
This commit is contained in:
Jason Parks
2025-03-21 02:13:28 -06:00
parent 6a9db932b6
commit ea1acda3e5
12 changed files with 510 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

302
apps/docs/api.json
View File

@@ -11887,6 +11887,305 @@
}
}
},
"/gitea.create": {
"post": {
"operationId": "gitea-create",
"tags": ["gitea"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"gitProviderId": {
"type": "string"
},
"authId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"token": {
"type": "string",
"nullable": true
},
"baseUrl": {
"type": "string",
"nullable": true
}
},
"required": ["authId", "name"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/gitea.one": {
"get": {
"operationId": "gitea-one",
"tags": ["gitea"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "giteaId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/gitea.giteaProviders": {
"get": {
"operationId": "gitea-giteaProviders",
"tags": ["gitea"],
"security": [
{
"Authorization": []
}
],
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/gitea.getGiteaRepositories": {
"get": {
"operationId": "gitea-getGiteaRepositories",
"tags": ["gitea"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "giteaId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/gitea.getGiteaBranches": {
"get": {
"operationId": "gitea-getGiteaBranches",
"tags": ["gitea"],
"security": [
{
"Authorization": []
}
],
"parameters": [
{
"name": "giteaId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
},
{
"name": "owner",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "repo",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "query",
"required": false,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/gitea.testConnection": {
"post": {
"operationId": "gitea-testConnection",
"tags": ["gitea"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"giteaId": {
"type": "string",
"minLength": 1
}
},
"required": ["giteaId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/gitea.update": {
"post": {
"operationId": "gitea-update",
"tags": ["gitea"],
"security": [
{
"Authorization": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"giteaId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"token": {
"type": "string",
"nullable": true
},
"baseUrl": {
"type": "string",
"nullable": true
},
"gitProviderId": {
"type": "string"
}
},
"required": ["giteaId", "gitProviderId"],
"additionalProperties": false
}
}
}
},
"parameters": [],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {}
}
},
"default": {
"$ref": "#/components/responses/error"
}
}
}
},
"/github.one": {
"get": {
"operationId": "github-one",
@@ -12682,6 +12981,9 @@
},
{
"name": "gitlab"
},
{
"name": "gitea"
}
],
"externalDocs": {

7
apps/docs/content/docs/api/generated/reference-application.mdx
View File

@@ -36,6 +36,9 @@ _openapi:
- depth: 2
title: Application save Gitlab Provider
url: '#application-save-gitlab-provider'
- depth: 2
title: Application save Gitea Provider
url: '#application-save-gitea-provider'
- depth: 2
title: Application save Bitbucket Provider
url: '#application-save-bitbucket-provider'
@@ -93,6 +96,8 @@ _openapi:
id: application-save-github-provider
- content: Application save Gitlab Provider
id: application-save-gitlab-provider
- content: Application save Gitea Provider
id: application-save-gitea-provider
- content: Application save Bitbucket Provider
id: application-save-bitbucket-provider
- content: Application save Docker Provider
@@ -118,4 +123,4 @@ _openapi:
contents: []
---
<APIPage document={"./api.json"} operations={[{"method":"post","path":"/application.create"},{"method":"get","path":"/application.one"},{"method":"post","path":"/application.reload"},{"method":"post","path":"/application.delete"},{"method":"post","path":"/application.stop"},{"method":"post","path":"/application.start"},{"method":"post","path":"/application.redeploy"},{"method":"post","path":"/application.saveEnvironment"},{"method":"post","path":"/application.saveBuildType"},{"method":"post","path":"/application.saveGithubProvider"},{"method":"post","path":"/application.saveGitlabProvider"},{"method":"post","path":"/application.saveBitbucketProvider"},{"method":"post","path":"/application.saveDockerProvider"},{"method":"post","path":"/application.saveGitProdiver"},{"method":"post","path":"/application.markRunning"},{"method":"post","path":"/application.update"},{"method":"post","path":"/application.refreshToken"},{"method":"post","path":"/application.deploy"},{"method":"post","path":"/application.cleanQueues"},{"method":"get","path":"/application.readTraefikConfig"},{"method":"post","path":"/application.updateTraefikConfig"},{"method":"get","path":"/application.readAppMonitoring"}]} hasHead={true} />
<APIPage document={"./api.json"} operations={[{"method":"post","path":"/application.create"},{"method":"get","path":"/application.one"},{"method":"post","path":"/application.reload"},{"method":"post","path":"/application.delete"},{"method":"post","path":"/application.stop"},{"method":"post","path":"/application.start"},{"method":"post","path":"/application.redeploy"},{"method":"post","path":"/application.saveEnvironment"},{"method":"post","path":"/application.saveBuildType"},{"method":"post","path":"/application.saveGithubProvider"},{"method":"post","path":"/application.saveGitlabProvider"},{"method":"post","path":"/application.saveGiteaProvider"},{"method":"post","path":"/application.saveBitbucketProvider"},{"method":"post","path":"/application.saveDockerProvider"},{"method":"post","path":"/application.saveGitProdiver"},{"method":"post","path":"/application.markRunning"},{"method":"post","path":"/application.update"},{"method":"post","path":"/application.refreshToken"},{"method":"post","path":"/application.deploy"},{"method":"post","path":"/application.cleanQueues"},{"method":"get","path":"/application.readTraefikConfig"},{"method":"post","path":"/application.updateTraefikConfig"},{"method":"get","path":"/application.readAppMonitoring"}]} hasHead={true} />

46
apps/docs/content/docs/api/generated/reference-gitea.mdx Normal file
View File

@@ -0,0 +1,46 @@
---
title: Gitea
full: true
_openapi:
toc:
- depth: 2
title: Gitea create
url: '#gitea-create'
- depth: 2
title: Gitea one
url: '#gitea-one'
- depth: 2
title: Gitea Gitea Providers
url: '#gitea-gitea-providers'
- depth: 2
title: Gitea get Gitea Repositories
url: '#gitea-get-gitea-repositories'
- depth: 2
title: Gitea get Gitea Branches
url: '#gitea-get-gitea-branches'
- depth: 2
title: Gitea test Connection
url: '#gitea-test-connection'
- depth: 2
title: Gitea update
url: '#gitea-update'
structuredData:
headings:
- content: Gitea create
id: gitea-create
- content: Gitea one
id: gitea-one
- content: Gitea Gitea Providers
id: gitea-gitea-providers
- content: Gitea get Gitea Repositories
id: gitea-get-gitea-repositories
- content: Gitea get Gitea Branches
id: gitea-get-gitea-branches
- content: Gitea test Connection
id: gitea-test-connection
- content: Gitea update
id: gitea-update'
contents: []
---
<APIPage document={"./api.json"} operations={[{"method":"post","path":"/gitea.create"},{"method":"get","path":"/gitea.one"},{"method":"get","path":"/gitea.giteaProviders"},{"method":"get","path":"/gitea.getGiteaRepositories"},{"method":"get","path":"/gitea.getGiteaBranches"},{"method":"post","path":"/gitea.testConnection"},{"method":"post","path":"/gitea.update"}]} hasHead={true} />

7
apps/docs/content/docs/api/reference-application.mdx
View File

@@ -36,6 +36,9 @@ _openapi:
- depth: 2
title: Application save Gitlab Provider
url: '#application-save-gitlab-provider'
- depth: 2
title: Application save Gitea Provider
url: '#application-save-gitea-provider'
- depth: 2
title: Application save Bitbucket Provider
url: '#application-save-bitbucket-provider'
@@ -93,6 +96,8 @@ _openapi:
id: application-save-github-provider
- content: Application save Gitlab Provider
id: application-save-gitlab-provider
- content: Application save Gitea Provider
id: application-save-gitea-provider
- content: Application save Bitbucket Provider
id: application-save-bitbucket-provider
- content: Application save Docker Provider
@@ -118,4 +123,4 @@ _openapi:
contents: []
---
<APIPage document={"./api.json"} operations={[{"method":"post","path":"/application.create"},{"method":"get","path":"/application.one"},{"method":"post","path":"/application.reload"},{"method":"post","path":"/application.delete"},{"method":"post","path":"/application.stop"},{"method":"post","path":"/application.start"},{"method":"post","path":"/application.redeploy"},{"method":"post","path":"/application.saveEnvironment"},{"method":"post","path":"/application.saveBuildType"},{"method":"post","path":"/application.saveGithubProvider"},{"method":"post","path":"/application.saveGitlabProvider"},{"method":"post","path":"/application.saveBitbucketProvider"},{"method":"post","path":"/application.saveDockerProvider"},{"method":"post","path":"/application.saveGitProdiver"},{"method":"post","path":"/application.markRunning"},{"method":"post","path":"/application.update"},{"method":"post","path":"/application.refreshToken"},{"method":"post","path":"/application.deploy"},{"method":"post","path":"/application.cleanQueues"},{"method":"get","path":"/application.readTraefikConfig"},{"method":"post","path":"/application.updateTraefikConfig"},{"method":"get","path":"/application.readAppMonitoring"}]} hasHead={true} />
<APIPage document={"./api.json"} operations={[{"method":"post","path":"/application.create"},{"method":"get","path":"/application.one"},{"method":"post","path":"/application.reload"},{"method":"post","path":"/application.delete"},{"method":"post","path":"/application.stop"},{"method":"post","path":"/application.start"},{"method":"post","path":"/application.redeploy"},{"method":"post","path":"/application.saveEnvironment"},{"method":"post","path":"/application.saveBuildType"},{"method":"post","path":"/application.saveGithubProvider"},{"method":"post","path":"/application.saveGitlabProvider"},,{"method":"post","path":"/application.saveGiteaProvider"}{"method":"post","path":"/application.saveBitbucketProvider"},{"method":"post","path":"/application.saveDockerProvider"},{"method":"post","path":"/application.saveGitProdiver"},{"method":"post","path":"/application.markRunning"},{"method":"post","path":"/application.update"},{"method":"post","path":"/application.refreshToken"},{"method":"post","path":"/application.deploy"},{"method":"post","path":"/application.cleanQueues"},{"method":"get","path":"/application.readTraefikConfig"},{"method":"post","path":"/application.updateTraefikConfig"},{"method":"get","path":"/application.readAppMonitoring"}]} hasHead={true} />

54
apps/docs/content/docs/api/reference-gitea.mdx Normal file
View File

@@ -0,0 +1,54 @@
---
title: Gitea
full: true
_openapi:
toc:
- depth: 2
title: Gitea create
url: '#gitea-create'
- depth: 2
title: Gitea one
url: '#gitea-one'
- depth: 2
title: Gitea gitea Providers
url: '#gitea-gitea-providers'
- depth: 2
title: Gitea get Gitea Repositories
url: '#gitea-get-gitea-repositories'
- depth: 2
title: Gitea get Gitea Branches
url: '#gitea-get-gitea-branches'
- depth: 2
title: Gitea test Connection
url: '#gitea-test-connection'
- depth: 2
title: Gitea update
url: '#gitea-update'
structuredData:
headings:
- content: Gitea create
id: gitea-create
- content: Gitea one
id: gitea-one
- content: Gitea gitea Providers
id: gitea-gitea-providers
- content: Gitea get Gitea Repositories
id: gitea-get-gitea-repositories
- content: Gitea get Gitea Branches
id: gitea-get-gitea-branches
- content: Gitea test Connection
id: gitea-test-connection
- content: Gitea update
id: gitea-update
contents: []
---
<APIPage document={"./api.json"} operations={[
{"method":"post","path":"/gitea.create", "description":"Create a new Gitea provider"},
{"method":"get","path":"/gitea.one", "description":"Fetch a specific Gitea provider by ID"},
{"method":"get","path":"/gitea.giteaProviders", "description":"Fetch all Gitea providers for the active organization"},
{"method":"get","path":"/gitea.getGiteaRepositories", "description":"Fetch repositories from Gitea provider"},
{"method":"get","path":"/gitea.getGiteaBranches", "description":"Fetch branches of a specific Gitea repository"},
{"method":"post","path":"/gitea.testConnection", "description":"Test connection to Gitea provider"},
{"method":"post","path":"/gitea.update", "description":"Update an existing Gitea provider"}
]} hasHead={true} />

77
apps/docs/content/docs/core/(Git-Sources)/gitea.mdx Normal file
View 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>

2
apps/docs/content/docs/core/applications/going-production.mdx
View File

@@ -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

2
apps/docs/content/docs/core/auto-deploy.mdx
View File

@@ -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.

5
apps/docs/content/docs/core/comparison.mdx
View File

@@ -13,8 +13,9 @@ Comparison of the following deployment tools:
| **Multi node support** | ✅ | ✅ | ❌ | ✅ |
| **Traefik Integration** | ✅ | ✅ | Available via Plugins | ✅ |
| **User Permission Management** | ✅ | ❌ | ❌ | ✅ |
| **Bitbucket Integration** | ✅ | ❌ | ❌ | ❌ |
| **Gitlab Integration** | ✅ | ❌ | ❌ | ❌ |
| **Bitbucket Integration** | ✅ | ❌ | ❌ | ✅ |
| **Gitlab Integration** | ✅ | ❌ | ❌ | ✅ |
| **Gitea Integration** | ✅ | ❌ | ✅ | ✅ |
| **Advanced User Permission Management** | ✅ | ❌ | ❌ | ❌ |
| **Terminal Access Built In** | ✅ | ❌ | ❌ | ✅ |
| **Database Support** | ✅ | ✅ | ❌ | ✅ |

13
apps/docs/content/docs/core/providers.mdx
View File

@@ -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>

35
apps/docs/content/docs/core/watch-paths.mdx
View File

@@ -1,34 +1,3 @@
---
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.
## 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.
## Supported Source Providers
The following source control providers are supported:
- GitHub
- GitLab
- Bitbucket
- Git (works with Bitbucket, Github, and GitLab repositories)
## Basic Usage
Let's say you have a project with the following directory structure:
```
my-app/
├── src/
│ ├── index.js
├── public/
```
By default, dokploy accepts an array of paths, allowing you to monitor multiple locations. For example:
- To trigger deployments when any file in the `src/` directory changes, use the pattern: `src/*`
@@ -42,8 +11,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 +39,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>