Skip to content

Commit 1701fc3

Browse files
SiumauricioSiumauricio
committed
feat: add databases connection
1 parent b53b13b commit 1701fc3

File tree

13 files changed

+142
-124
lines changed

13 files changed

+142
-124
lines changed

‎apps/docs/content/docs/core/applications/providers.mdx‎

Lines changed: 0 additions & 58 deletions
This file was deleted.

‎apps/docs/content/docs/core/auto-deploy.mdx‎

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ Auto deploy is only valid for the following services:
99

1010
- Applications
1111
- Docker Compose
12-
- Templates Open Source
1312

1413
## Github
1514

@@ -62,9 +61,22 @@ Webhooks allow you to automatically deploy your application whenever changes are
6261
The steps are almost the same for all the Git providers, GitHub, GitLab, Bitbucket, Gitea.
6362
</Callout>
6463

65-
### API Method
6664

67-
Deploy your application programmatically using the Dokploy API from anywhere.
65+
## Dockerhub (Only Applications)
66+
67+
To setup auto deploys for Dockerhub, follow the steps below:
68+
69+
1. Go to your application and select `Deployments` tab.
70+
2. Copy the `Webhook URL`.
71+
3. Go to your Dockerhub repository and select `Webhooks` tab.
72+
4. Set a name for the webhook and paste the `Webhook URL` copied in step 2.
73+
5. That's it, now every time you push to your repository, your application will trigger a deployment in dokploy.
74+
75+
The deployment will trigger only if the `Tag` matches the one specified in Dokploy.
76+
77+
## API Method
78+
79+
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.
6880

6981
### Steps to Deploy Using API
7082

apps/docs/content/docs/core/databases/connection.mdx renamed to apps/docs/content/docs/core/databases/connection/index.mdx

File renamed without changes.

‎apps/docs/content/docs/core/databases/connection/mariadb.mdx‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: MariaDB
3+
description: This guide will cover how to connect from Beekeeper Studio to your mariadb databases in dokploy.
4+
---
5+
6+
1. Download and install Beekeeper Studio [Beekeeper Studio](https://www.beekeeperstudio.io/get).
7+
2. Go to your `mariadb` databases.
8+
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`.
9+
4. It will display the `External Connection URL` eg. `mysql://user:password@1.2.4.5:3306/database`.
10+
11+
Open Beekeeper Studio and follow the steps:
12+
13+
1. Click on `Add New Server`.
14+
2. Select `MariaDB` as the `Database Type`.
15+
3. Use `Import URL` to enter the `External Connection URL` from Dokploy eg. `mysql://user:password@1.2.4.5:3306/database`.
16+
4. Click on `Connect`.
17+
5. Click on `Save`.
18+
19+
Done! now you can manage the database from Beekeeper Studio.

‎apps/docs/content/docs/core/databases/connection/mongo-atlas.mdx‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Mongo Compass
3+
description: This guide will cover how to configure a Mongo Compass connection for your applications in dokploy or panel.
4+
---
5+
6+
1. Download and install Mongo Compass [Mongo Compass](https://www.mongodb.com/try/download/compass).
7+
2. Go to your `MongoDB` databases.
8+
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`.
9+
4. It will display the `External Connection URL` eg. `mongodb://user:password@1.2.4.5:27017/database`.
10+
11+
Open Mongo Compass and follow the steps:
12+
13+
1. Click on `Add Connection`.
14+
2. Copy and paste the `External Connection URL` eg. `mongodb://user:password@1.2.4.5:27017/database`.
15+
3. Click on `Connect`.
16+
17+
18+
Done! now you can manage the database from Mongo Compass.

‎apps/docs/content/docs/core/databases/connection/mysql.mdx‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: MySQL
3+
description: This guide will cover how to connect from Beekeeper Studio to your mysql databases in dokploy.
4+
---
5+
6+
1. Download and install Beekeeper Studio [Beekeeper Studio](https://www.beekeeperstudio.io/get).
7+
2. Go to your `mysql` databases.
8+
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`.
9+
4. It will display the `External Connection URL` eg. `mysql://user:password@1.2.4.5:3306/database`.
10+
11+
Open Beekeeper Studio and follow the steps:
12+
13+
1. Click on `Add New Server`.
14+
2. Select `MySQL` as the `Database Type`.
15+
3. Use `Import URL` to enter the `External Connection URL` from Dokploy eg. `mysql://user:password@1.2.4.5:3306/database`.
16+
4. Click on `Connect`.
17+
5. Click on `Save`.
18+
19+
Done! now you can manage the database from Beekeeper Studio.

‎apps/docs/content/docs/core/databases/connection/pg-admin.mdx‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: PG Admin
3+
description: This guide will cover how to connect from pgAdmin to your postgres databases in dokploy.
4+
---
5+
6+
1. Download and install pgAdmin [pgAdmin](https://www.pgadmin.org/download/).
7+
2. Go to your `postgres` databases.
8+
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`.
9+
4. It will display the `External Connection URL` eg. `postgres://user:password@1.2.4.5:5433/database`.
10+
11+
12+
Open pgAdmin and follow the steps:
13+
14+
1. Click on `Add New Server`.
15+
2. Enter the `Server Name` eg. `dokploy`.
16+
3. Enter to `Connection`.
17+
4. In Hostname/Address enter the IP from the server where the database is hosted eg. `1.2.4.5`.
18+
5. In Port enter the port where the database is running eg. `5433`.
19+
6. In Database enter the name of the database eg. `database`.
20+
7. In Username enter the username eg. `user`.
21+
8. In Password enter the password eg. `password`.
22+
9. Click on `Save`.
23+
24+
Done! now you can manage the database from pgAdmin.

‎apps/docs/content/docs/core/databases/connection/redis.mdx‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: Redis
3+
description: This guide will cover how to connect from RedisInsight to your redis databases in dokploy.
4+
---
5+
6+
1. Download and install RedisInsight [RedisInsight](https://redis.io/insight/).
7+
2. Go to your `redis` databases.
8+
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`.
9+
4. It will display the `External Connection URL` eg. `redis://user:password@1.2.4.5:6379/database`.
10+
11+
Open RedisInsight and follow the steps:
12+
13+
14+
1. Add Redis Database.
15+
2. Enter the `Host` eg. `1.2.4.5`.
16+
3. Enter the `Port` eg. `6379`.
17+
4. Enter the username eg. `default`.
18+
5. Enter the `Password` eg. `password`.
19+
6. Click on `Save`.
20+
21+
Done! now you can manage the database from RedisInsight.

‎apps/docs/content/docs/core/docker-compose/providers.mdx‎

Lines changed: 0 additions & 49 deletions
This file was deleted.

‎apps/docs/content/docs/core/domains/cloudflare.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ We assume that you have enabled the `Full (Strict)` mode in the previous step, i
4949
6. Enter the `Host` name, eg. `api` so it will be `api.dokploy.com`.
5050
7. Enter the `IPv4 Address` from your server where the application is hosted eg. `1.2.3.4`.
5151
8. Click `Save`.
52-
9. Go to dokploy panel and now you can assign either for `Applications` or `Docker Compose` or `Templates Open Source`.
52+
9. Go to dokploy panel and now you can assign either for `Applications` or `Docker Compose`.
5353
10. Go to `Domains` section.
5454
11. Click `Create Domain`.
5555
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
7676
6. Enter the `Host` name, eg. `api` so it will be `api.dokploy.com`.
7777
7. Enter the `IPv4 Address` from your server where the application is hosted eg. `1.2.3.4`.
7878
8. Click `Save`.
79-
9. Go to dokploy panel and now you can assign either for `Applications` or `Docker Compose` or `Templates Open Source`.
79+
9. Go to dokploy panel and now you can assign either for `Applications` or `Docker Compose`.
8080
10. Go to `Domains` section.
8181
11. Click `Create Domain`.
8282
12. In the `Host` field, enter the domain name eg. `api.dokploy.com`.

0 commit comments

Comments
 (0)