mirror of
https://github.com/Dokploy/website
synced 2025-06-26 18:16:01 +00:00
feat: add databases connection
This commit is contained in:
@@ -1,58 +0,0 @@
|
|||||||
---
|
|
||||||
title: Providers
|
|
||||||
description: Learn how to use providers in your application.
|
|
||||||
---
|
|
||||||
|
|
||||||
Dokploy offers several deployment methods, streamlining the process whether you're utilizing GitHub, any Git provider, Docker, or automated deployments.
|
|
||||||
|
|
||||||
- GitHub
|
|
||||||
- Gitlab
|
|
||||||
- Bitbucket
|
|
||||||
- Git (Any Git Provider)
|
|
||||||
- Docker
|
|
||||||
- Drop(Drag and Drop .zip)
|
|
||||||
|
|
||||||
## GitHub, Gitlab, Bitbucket
|
|
||||||
|
|
||||||
Go to [Git Sources](/docs/core/github) and select the provider you want to use.
|
|
||||||
|
|
||||||
## Git
|
|
||||||
|
|
||||||
For deployments from any Git repository, whether public or private, you can use either SSH or HTTPS:
|
|
||||||
|
|
||||||
### Public Repositories (HTTPS)
|
|
||||||
|
|
||||||
1. Enter the repository URL in `HTTPS URL`.
|
|
||||||
2. Type the branch name.
|
|
||||||
3. Click on `Save`.
|
|
||||||
|
|
||||||
### Private Repositories
|
|
||||||
|
|
||||||
For private repositories, is required to first create an SSH Key.
|
|
||||||
|
|
||||||
1. Go to [SSH Keys](/docs/core/ssh-keys/overview) and click on `Create SSH Key`.
|
|
||||||
2. Click on `Generate RSA SSH Key` and copy the `Public Key`.
|
|
||||||
|
|
||||||
<ImageZoom
|
|
||||||
src="/assets/dokploy-ssh-key.png"
|
|
||||||
width={800}
|
|
||||||
height={630}
|
|
||||||
className="rounded-lg"
|
|
||||||
/>
|
|
||||||
|
|
||||||
You can then copy the SSH key and paste it into the settings of your account.
|
|
||||||
|
|
||||||
<ImageZoom
|
|
||||||
src="/assets/private-repository.png"
|
|
||||||
width={800}
|
|
||||||
height={630}
|
|
||||||
className="rounded-lg"
|
|
||||||
/>
|
|
||||||
|
|
||||||
This enables you to pull repositories from your private repository, a method consistent across nearly all providers.
|
|
||||||
|
|
||||||
## Docker
|
|
||||||
|
|
||||||
For Docker deployments:
|
|
||||||
|
|
||||||
- Provide a Docker image. For private repositories, enter the username and password.
|
|
||||||
@@ -9,7 +9,6 @@ Auto deploy is only valid for the following services:
|
|||||||
|
|
||||||
- Applications
|
- Applications
|
||||||
- Docker Compose
|
- Docker Compose
|
||||||
- Templates Open Source
|
|
||||||
|
|
||||||
## Github
|
## Github
|
||||||
|
|
||||||
@@ -62,9 +61,22 @@ Webhooks allow you to automatically deploy your application whenever changes are
|
|||||||
The steps are almost the same for all the Git providers, GitHub, GitLab, Bitbucket, Gitea.
|
The steps are almost the same for all the Git providers, GitHub, GitLab, Bitbucket, Gitea.
|
||||||
</Callout>
|
</Callout>
|
||||||
|
|
||||||
### API Method
|
|
||||||
|
|
||||||
Deploy your application programmatically using the Dokploy API from anywhere.
|
## Dockerhub (Only Applications)
|
||||||
|
|
||||||
|
To setup auto deploys for Dockerhub, follow the steps below:
|
||||||
|
|
||||||
|
1. Go to your application and select `Deployments` tab.
|
||||||
|
2. Copy the `Webhook URL`.
|
||||||
|
3. Go to your Dockerhub repository and select `Webhooks` tab.
|
||||||
|
4. Set a name for the webhook and paste the `Webhook URL` copied in step 2.
|
||||||
|
5. That's it, now every time you push to your repository, your application will trigger a deployment in dokploy.
|
||||||
|
|
||||||
|
The deployment will trigger only if the `Tag` matches the one specified in Dokploy.
|
||||||
|
|
||||||
|
## API Method
|
||||||
|
|
||||||
|
Deploy your application programmatically using the Dokploy API from anywhere, this is useful when you want to trigger a deployment from a CI/CD pipeline or from a script.
|
||||||
|
|
||||||
### Steps to Deploy Using API
|
### Steps to Deploy Using API
|
||||||
|
|
||||||
|
|||||||
19
apps/docs/content/docs/core/databases/connection/mariadb.mdx
Normal file
19
apps/docs/content/docs/core/databases/connection/mariadb.mdx
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
---
|
||||||
|
title: MariaDB
|
||||||
|
description: This guide will cover how to connect from Beekeeper Studio to your mariadb databases in dokploy.
|
||||||
|
---
|
||||||
|
|
||||||
|
1. Download and install Beekeeper Studio [Beekeeper Studio](https://www.beekeeperstudio.io/get).
|
||||||
|
2. Go to your `mariadb` databases.
|
||||||
|
3. In External Credentials, enter the `External Port (Internet)` make sure the port is not in use by another service eg. `3307` and click `Save`.
|
||||||
|
4. It will display the `External Connection URL` eg. `mysql://user:password@1.2.4.5:3306/database`.
|
||||||
|
|
||||||
|
Open Beekeeper Studio and follow the steps:
|
||||||
|
|
||||||
|
1. Click on `Add New Server`.
|
||||||
|
2. Select `MariaDB` as the `Database Type`.
|
||||||
|
3. Use `Import URL` to enter the `External Connection URL` from Dokploy eg. `mysql://user:password@1.2.4.5:3306/database`.
|
||||||
|
4. Click on `Connect`.
|
||||||
|
5. Click on `Save`.
|
||||||
|
|
||||||
|
Done! now you can manage the database from Beekeeper Studio.
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
---
|
||||||
|
title: Mongo Compass
|
||||||
|
description: This guide will cover how to configure a Mongo Compass connection for your applications in dokploy or panel.
|
||||||
|
---
|
||||||
|
|
||||||
|
1. Download and install Mongo Compass [Mongo Compass](https://www.mongodb.com/try/download/compass).
|
||||||
|
2. Go to your `MongoDB` databases.
|
||||||
|
3. In External Credentials, enter the `External Port (Internet)` make sure the port is not in use by another service eg. `27017` and click `Save`.
|
||||||
|
4. It will display the `External Connection URL` eg. `mongodb://user:password@1.2.4.5:27017/database`.
|
||||||
|
|
||||||
|
Open Mongo Compass and follow the steps:
|
||||||
|
|
||||||
|
1. Click on `Add Connection`.
|
||||||
|
2. Copy and paste the `External Connection URL` eg. `mongodb://user:password@1.2.4.5:27017/database`.
|
||||||
|
3. Click on `Connect`.
|
||||||
|
|
||||||
|
|
||||||
|
Done! now you can manage the database from Mongo Compass.
|
||||||
19
apps/docs/content/docs/core/databases/connection/mysql.mdx
Normal file
19
apps/docs/content/docs/core/databases/connection/mysql.mdx
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
---
|
||||||
|
title: MySQL
|
||||||
|
description: This guide will cover how to connect from Beekeeper Studio to your mysql databases in dokploy.
|
||||||
|
---
|
||||||
|
|
||||||
|
1. Download and install Beekeeper Studio [Beekeeper Studio](https://www.beekeeperstudio.io/get).
|
||||||
|
2. Go to your `mysql` databases.
|
||||||
|
3. In External Credentials, enter the `External Port (Internet)` make sure the port is not in use by another service eg. `3306` and click `Save`.
|
||||||
|
4. It will display the `External Connection URL` eg. `mysql://user:password@1.2.4.5:3306/database`.
|
||||||
|
|
||||||
|
Open Beekeeper Studio and follow the steps:
|
||||||
|
|
||||||
|
1. Click on `Add New Server`.
|
||||||
|
2. Select `MySQL` as the `Database Type`.
|
||||||
|
3. Use `Import URL` to enter the `External Connection URL` from Dokploy eg. `mysql://user:password@1.2.4.5:3306/database`.
|
||||||
|
4. Click on `Connect`.
|
||||||
|
5. Click on `Save`.
|
||||||
|
|
||||||
|
Done! now you can manage the database from Beekeeper Studio.
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
---
|
||||||
|
title: PG Admin
|
||||||
|
description: This guide will cover how to connect from pgAdmin to your postgres databases in dokploy.
|
||||||
|
---
|
||||||
|
|
||||||
|
1. Download and install pgAdmin [pgAdmin](https://www.pgadmin.org/download/).
|
||||||
|
2. Go to your `postgres` databases.
|
||||||
|
3. In External Credentials, enter the `External Port (Internet)` make sure the port is not in use by another service eg. `5433` and click `Save`.
|
||||||
|
4. It will display the `External Connection URL` eg. `postgres://user:password@1.2.4.5:5433/database`.
|
||||||
|
|
||||||
|
|
||||||
|
Open pgAdmin and follow the steps:
|
||||||
|
|
||||||
|
1. Click on `Add New Server`.
|
||||||
|
2. Enter the `Server Name` eg. `dokploy`.
|
||||||
|
3. Enter to `Connection`.
|
||||||
|
4. In Hostname/Address enter the IP from the server where the database is hosted eg. `1.2.4.5`.
|
||||||
|
5. In Port enter the port where the database is running eg. `5433`.
|
||||||
|
6. In Database enter the name of the database eg. `database`.
|
||||||
|
7. In Username enter the username eg. `user`.
|
||||||
|
8. In Password enter the password eg. `password`.
|
||||||
|
9. Click on `Save`.
|
||||||
|
|
||||||
|
Done! now you can manage the database from pgAdmin.
|
||||||
21
apps/docs/content/docs/core/databases/connection/redis.mdx
Normal file
21
apps/docs/content/docs/core/databases/connection/redis.mdx
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
---
|
||||||
|
title: Redis
|
||||||
|
description: This guide will cover how to connect from RedisInsight to your redis databases in dokploy.
|
||||||
|
---
|
||||||
|
|
||||||
|
1. Download and install RedisInsight [RedisInsight](https://redis.io/insight/).
|
||||||
|
2. Go to your `redis` databases.
|
||||||
|
3. In External Credentials, enter the `External Port (Internet)` make sure the port is not in use by another service eg. `6379` and click `Save`.
|
||||||
|
4. It will display the `External Connection URL` eg. `redis://user:password@1.2.4.5:6379/database`.
|
||||||
|
|
||||||
|
Open RedisInsight and follow the steps:
|
||||||
|
|
||||||
|
|
||||||
|
1. Add Redis Database.
|
||||||
|
2. Enter the `Host` eg. `1.2.4.5`.
|
||||||
|
3. Enter the `Port` eg. `6379`.
|
||||||
|
4. Enter the username eg. `default`.
|
||||||
|
5. Enter the `Password` eg. `password`.
|
||||||
|
6. Click on `Save`.
|
||||||
|
|
||||||
|
Done! now you can manage the database from RedisInsight.
|
||||||
@@ -1,49 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Providers"
|
|
||||||
description: "Learn how to use Docker Compose with Dokploy"
|
|
||||||
---
|
|
||||||
|
|
||||||
Dokploy offers several deployment methods, streamlining the process whether you're utilizing GitHub, any Git provider, Raw, or automated deployments.
|
|
||||||
|
|
||||||
- GitHub
|
|
||||||
- Gitlab
|
|
||||||
- Bitbucket
|
|
||||||
- Git (Any Git Provider)
|
|
||||||
- Raw
|
|
||||||
|
|
||||||
## GitHub, Gitlab, Bitbucket
|
|
||||||
|
|
||||||
Go to [Git Sources](/docs/core/github) and select the provider you want to use.
|
|
||||||
|
|
||||||
## Git
|
|
||||||
|
|
||||||
For deployments from any Git repository, whether public or private, you can use either SSH or HTTPS:
|
|
||||||
|
|
||||||
1. Enter the repository URL.
|
|
||||||
2. Specify the branch you wish to deploy.
|
|
||||||
|
|
||||||
### Private Repositories
|
|
||||||
|
|
||||||
For private repositories, authenticate using SSH. We provide a lock icon to generate an SSH key.
|
|
||||||
|
|
||||||
<ImageZoom
|
|
||||||
src="/assets/dokploy-ssh-compose.png"
|
|
||||||
width={800}
|
|
||||||
height={630}
|
|
||||||
className="rounded-lg"
|
|
||||||
/>
|
|
||||||
|
|
||||||
You can then copy the SSH key and paste it into the settings of your account.
|
|
||||||
|
|
||||||
<ImageZoom
|
|
||||||
src="/assets/private-repository.png"
|
|
||||||
width={800}
|
|
||||||
height={630}
|
|
||||||
className="rounded-lg"
|
|
||||||
/>
|
|
||||||
|
|
||||||
This enables you to pull repositories from your private repository, a method consistent across nearly all providers.
|
|
||||||
|
|
||||||
## Raw
|
|
||||||
|
|
||||||
You specify a docker compose file directly in the code editor and trigger a deployment.
|
|
||||||
@@ -49,7 +49,7 @@ We assume that you have enabled the `Full (Strict)` mode in the previous step, i
|
|||||||
6. Enter the `Host` name, eg. `api` so it will be `api.dokploy.com`.
|
6. Enter the `Host` name, eg. `api` so it will be `api.dokploy.com`.
|
||||||
7. Enter the `IPv4 Address` from your server where the application is hosted eg. `1.2.3.4`.
|
7. Enter the `IPv4 Address` from your server where the application is hosted eg. `1.2.3.4`.
|
||||||
8. Click `Save`.
|
8. Click `Save`.
|
||||||
9. Go to dokploy panel and now you can assign either for `Applications` or `Docker Compose` or `Templates Open Source`.
|
9. Go to dokploy panel and now you can assign either for `Applications` or `Docker Compose`.
|
||||||
10. Go to `Domains` section.
|
10. Go to `Domains` section.
|
||||||
11. Click `Create Domain`.
|
11. Click `Create Domain`.
|
||||||
12. In the `Host` field, enter the domain name eg. `api.dokploy.com`.
|
12. In the `Host` field, enter the domain name eg. `api.dokploy.com`.
|
||||||
@@ -76,7 +76,7 @@ We assume that you have enabled the `Flexible` mode in the previous step, is sup
|
|||||||
6. Enter the `Host` name, eg. `api` so it will be `api.dokploy.com`.
|
6. Enter the `Host` name, eg. `api` so it will be `api.dokploy.com`.
|
||||||
7. Enter the `IPv4 Address` from your server where the application is hosted eg. `1.2.3.4`.
|
7. Enter the `IPv4 Address` from your server where the application is hosted eg. `1.2.3.4`.
|
||||||
8. Click `Save`.
|
8. Click `Save`.
|
||||||
9. Go to dokploy panel and now you can assign either for `Applications` or `Docker Compose` or `Templates Open Source`.
|
9. Go to dokploy panel and now you can assign either for `Applications` or `Docker Compose`.
|
||||||
10. Go to `Domains` section.
|
10. Go to `Domains` section.
|
||||||
11. Click `Create Domain`.
|
11. Click `Create Domain`.
|
||||||
12. In the `Host` field, enter the domain name eg. `api.dokploy.com`.
|
12. In the `Host` field, enter the domain name eg. `api.dokploy.com`.
|
||||||
|
|||||||
@@ -15,7 +15,6 @@ Domains are supported for:
|
|||||||
|
|
||||||
- **Applications**
|
- **Applications**
|
||||||
- **Docker Compose**
|
- **Docker Compose**
|
||||||
- **Templates Open Source**
|
|
||||||
|
|
||||||
|
|
||||||
## Requirements (Optional)
|
## Requirements (Optional)
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ In the case you don't want to use Cloudflare, you can use any domain from any pr
|
|||||||
5. Enter the `Host` name, eg. `api` so it will be `api.dokploy.com`.
|
5. Enter the `Host` name, eg. `api` so it will be `api.dokploy.com`.
|
||||||
6. Enter the `IPv4 Address` from your server where the application is hosted eg. `1.2.3.4`.
|
6. Enter the `IPv4 Address` from your server where the application is hosted eg. `1.2.3.4`.
|
||||||
7. Click `Save`.
|
7. Click `Save`.
|
||||||
8. Go to dokploy panel and now you can assign either for `Applications` or `Docker Compose` or `Templates Open Source`.
|
8. Go to dokploy panel and now you can assign either for `Applications` or `Docker Compose`.
|
||||||
9. Go to `Domains` section.
|
9. Go to `Domains` section.
|
||||||
10. Click `Create Domain`.
|
10. Click `Create Domain`.
|
||||||
11. In the `Host` field, enter the domain name eg. `api.dokploy.com`.
|
11. In the `Host` field, enter the domain name eg. `api.dokploy.com`.
|
||||||
|
|||||||
@@ -5,13 +5,13 @@ description: Learn how to use providers in your application or docker compose.
|
|||||||
|
|
||||||
Dokploy offers several deployment methods, streamlining the process whether you're utilizing GitHub, any Git provider, Docker, or automated deployments.
|
Dokploy offers several deployment methods, streamlining the process whether you're utilizing GitHub, any Git provider, Docker, or automated deployments.
|
||||||
|
|
||||||
- GitHub
|
1. GitHub
|
||||||
- Gitlab
|
2. Gitlab
|
||||||
- Bitbucket
|
3. Bitbucket
|
||||||
- Git
|
4. Git
|
||||||
- Docker (Only Applications)
|
5. Docker (Only Applications)
|
||||||
- Drag and Drop .zip (Only Applications)
|
6. Drag and Drop .zip (Only Applications)
|
||||||
- Raw (Only Docker Compose)
|
7. Raw (Only Docker Compose)
|
||||||
|
|
||||||
## GitHub, Gitlab, Bitbucket
|
## GitHub, Gitlab, Bitbucket
|
||||||
|
|
||||||
@@ -55,8 +55,21 @@ This is for Github, but the same applies for Gitlab, Bitbucket, Gitea, etc.
|
|||||||
This enables you to pull repositories from your private repository, a method consistent across nearly all providers,
|
This enables you to pull repositories from your private repository, a method consistent across nearly all providers,
|
||||||
remember to use the SSH URL `git@github.com:user/repo.git` and not the HTTPS URL `https://github.com/user/repo.git`.
|
remember to use the SSH URL `git@github.com:user/repo.git` and not the HTTPS URL `https://github.com/user/repo.git`.
|
||||||
|
|
||||||
## Docker
|
## Docker (Applications)
|
||||||
|
|
||||||
For Docker deployments:
|
For Docker deployments you have two options:
|
||||||
|
|
||||||
|
1. Login to your registry using the [Registry Section](/docs/core/registry) and it automatically will pull the image from the registry in the case of a private registry.
|
||||||
|
2. Provide the username and password directly in the application settings.
|
||||||
|
|
||||||
|
|
||||||
|
## Drag and Drop .zip (Applications)
|
||||||
|
|
||||||
|
You can upload a zip file directly from your computer and trigger a deployment.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Raw (Docker Compose)
|
||||||
|
|
||||||
|
You specify a docker compose file directly in the code editor and trigger a deployment.
|
||||||
|
|
||||||
- Provide a Docker image. For private repositories, enter the username and password.
|
|
||||||
|
|||||||
Reference in New Issue
Block a user