mirror of
https://github.com/Dokploy/website.git
synced 2026-06-15 20:25:25 +02:00
docs: update schedule jobs documentation and add Lark notifications
- Enhanced the schedule jobs section to clarify the execution context for Server and Dokploy Server Jobs, emphasizing their interaction with Docker commands. - Introduced a new Lark notifications guide, detailing setup steps and configuration for receiving notifications in the Dokploy panel. - Updated the overview of notification providers to include Lark, ensuring comprehensive coverage of available options.
This commit is contained in:
24
apps/docs/content/docs/core/(Notifications)/lark.mdx
Normal file
24
apps/docs/content/docs/core/(Notifications)/lark.mdx
Normal file
@@ -0,0 +1,24 @@
|
||||
---
|
||||
title: Lark
|
||||
description: 'Configure Lark notifications for your applications.'
|
||||
---
|
||||
|
||||
Lark notifications are a great way to stay up to date with important events in your Dokploy panel. You can choose to receive notifications for specific events or all events.
|
||||
|
||||
## Lark Notifications
|
||||
|
||||
To start receiving Lark notifications, you need to fill the form with the following details:
|
||||
|
||||
- **Name**: Enter any name you want.
|
||||
- **Webhook URL**: Enter the webhook URL. eg. `https://open.larksuite.com/open-apis/bot/v2/hook/xxxxxxxxxxxxxxxxxxxxxxxx`
|
||||
|
||||
To setup Lark notifications, follow these steps:
|
||||
|
||||
1. Go to your Lark workspace and navigate to the bot configuration.
|
||||
2. Create a new bot or use an existing one.
|
||||
3. Copy the webhook URL from your Lark bot settings.
|
||||
4. Go to Dokploy **Notifications** and select **Lark** as the notification provider.
|
||||
5. Enter a name for your notification configuration.
|
||||
6. Paste the webhook URL you copied in the previous step.
|
||||
7. Click on **Test** to make sure everything is working.
|
||||
8. Click on **Create** to save the notification.
|
||||
13
apps/docs/content/docs/core/(Notifications)/meta.json
Normal file
13
apps/docs/content/docs/core/(Notifications)/meta.json
Normal file
@@ -0,0 +1,13 @@
|
||||
{
|
||||
"title": "Notifications",
|
||||
"pages": [
|
||||
"overview",
|
||||
"slack",
|
||||
"telegram",
|
||||
"discord",
|
||||
"lark",
|
||||
"email",
|
||||
"gotify",
|
||||
"ntfy"
|
||||
]
|
||||
}
|
||||
@@ -5,18 +5,28 @@ description: 'Configure general notifications for your applications and services
|
||||
|
||||
import { Callout } from 'fumadocs-ui/components/callout';
|
||||
|
||||
Dokploy offer multiples notifications options to notify about some events.
|
||||
Dokploy offers multiple notification options to notify you about important events in your applications and services.
|
||||
|
||||
1. **App Deploy**: Notify when a new version of your application is deployed.
|
||||
2. **App Deploy Error**: Notify when a new version of your application fails to deploy.
|
||||
3. **Docker Cleanup**: Notify when a Docker cleanup is triggered.
|
||||
4. **Dokploy Restart**: Notify when Dokploy Server restarts.
|
||||
5. **Database Backup**: Notify when a new database backup is created(Success or Error).
|
||||
## Actions
|
||||
|
||||
## Providers:
|
||||
You can select which actions trigger notifications:
|
||||
|
||||
1. **App Deploy**: Trigger the action when an app is deployed.
|
||||
2. **App Build Error**: Trigger the action when the build fails.
|
||||
3. **Database Backup**: Trigger the action when a database backup is created.
|
||||
4. **Volume Backup**: Trigger the action when a volume backup is created.
|
||||
5. **Docker Cleanup**: Trigger the action when the docker cleanup is performed.
|
||||
6. **Dokploy Restart**: Trigger the action when Dokploy is restarted.
|
||||
|
||||
## Providers
|
||||
|
||||
Dokploy supports the following notification providers:
|
||||
|
||||
1. **Slack**: Slack is a platform for team communication and collaboration.
|
||||
2. **Telegram**: Telegram is a messaging platform that allows users to send and receive messages.
|
||||
3. **Discord**: Discord is generally used for communication between users in a chat or voice channel.
|
||||
4. **Email**: Email is a popular method for sending messages to a group of recipients.
|
||||
4. **Lark**: Lark is a collaboration platform that provides messaging and team communication features.
|
||||
5. **Email**: Email is a popular method for sending messages to a group of recipients.
|
||||
6. **Gotify**: Gotify is a self-hosted push notification service.
|
||||
7. **Ntfy**: Ntfy is a simple HTTP-based pub-sub notification service.
|
||||
|
||||
|
||||
@@ -12,8 +12,8 @@ Dokploy supports four types of scheduled jobs:
|
||||
|
||||
1. **Application Jobs**: Run commands inside specific application containers
|
||||
2. **Compose Jobs**: Execute commands in Docker Compose services
|
||||
3. **Server Jobs**: Run scripts on remote servers
|
||||
4. **Dokploy Server Jobs**: Execute tasks on the Dokploy server itself
|
||||
3. **Server Jobs**: Run scripts on remote servers (executed on the host)
|
||||
4. **Dokploy Server Jobs**: Execute tasks at the container level within the Dokploy container. These jobs can interact with commands inside the Dokploy container (e.g., `docker ps`, `docker image prune`), but they are not executed directly on the host system
|
||||
|
||||
## Container-based Jobs (Application and Compose)
|
||||
|
||||
@@ -40,7 +40,27 @@ For docker compose jobs, is required to not change the COMPOSE_PROJECT_NAME envi
|
||||
|
||||
## Server-based Jobs (Server and Dokploy Server)
|
||||
|
||||
For remote servers and the Dokploy server, you can write bash scripts to perform various tasks. These scripts can use any command or tool available on the target system.
|
||||
### Server Jobs
|
||||
|
||||
For remote servers, you can write bash scripts to perform various tasks. These scripts are executed directly on the host system and can use any command or tool available on the target server.
|
||||
|
||||
### Dokploy Server Jobs
|
||||
|
||||
Dokploy Server Jobs are executed at the container level within the Dokploy container. This means:
|
||||
|
||||
- Commands run inside the Dokploy container environment
|
||||
- You can interact with Docker commands (e.g., `docker ps`, `docker image prune`, `docker system prune`)
|
||||
- Scripts have access to the Docker socket and can manage containers and images
|
||||
- Jobs do not execute directly on the host system, but within the containerized Dokploy environment
|
||||
|
||||
**Example**: You can create a scheduled job to clean up unused Docker images:
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
docker image prune -af
|
||||
```
|
||||
|
||||
This command will run inside the Dokploy container and can interact with Docker to clean up images.
|
||||
|
||||
<Callout type="info">
|
||||
Make sure any required dependencies are installed on the target server before using them in your scripts.
|
||||
|
||||
Reference in New Issue
Block a user