Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Templates documentation #2

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions apps/docs/app/[lang]/layout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,13 @@ const modes: Mode[] = [
description: "API Documentation",
icon: PlugZapIcon,
},
{
param: "templates",
name: "Templates",
package: "fumadocs-mdx",
description: "Templates Documentation",
icon: PlugZapIcon,
},
];

export default function Layout({
Expand Down
22 changes: 22 additions & 0 deletions apps/docs/content/docs/templates/erpnext/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: ERPNext
description: A guide to install ERPNext template
---

## About Dokploy ERPNext

Thanks to [DeveloperRaju23](https://github.com/DeveloperRaju23) for creating the compose project of this template 💕

This documentation was based on his [Dokploy-ERPNext Repository](https://github.com/DeveloperRaju23/Dokploy-ERPNext)

## Steps
1. Create an ERPNext template via the GUI on your Dokploy instance.
2. On the `Domains` tab you need to enable SSL with Letsencrypt.
3. Deploy the template

## If you are stuck
1. Open the terminal and select frontend container
2. run bench --site frontend install-app erpnext
3. Open the url in incognito mode and continue with setup.

### [List of available commands (link*)](https://github.com/DeveloperRaju23/Dokploy-ERPNext/blob/main/commands.txt)
6 changes: 6 additions & 0 deletions apps/docs/content/docs/templates/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Introduction
description: A guide how to deploy some templates which needs additional setup
---

Some templates require additional settings before they can be launched, here you can find out more about these templates and how to launch them.
39 changes: 39 additions & 0 deletions apps/docs/content/docs/templates/mail-server/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: Docker Mail Server
description: A guide to install docker mail-server
---

## Mail Server Pre-Install Setup

To use this template, you need to perform some actions before installing it.

## The minimal DNS configuration

This example shows you a set of records for one domain. Each domain that is added needs at least this set of records to function correctly.

````md
# Name Type Value
mail IN A 1.2.3.4
autodiscover IN CNAME mail.example.org. (your ${DMS_HOSTNAME})
autoconfig IN CNAME mail.example.org. (your ${DMS_HOSTNAME})
@ IN MX 10 mail.example.org. (your ${DMS_HOSTNAME})
````

## SSL/TLS

Dokploy uses Traefik to generate certificates for your containers. There's a problem here, the domain must be configured on another service for Traefik to request it from Let's Encrypt (i.e. Traefik will not issue a certificate without a request from the service/router).

Therefore, you need to create a basic Compose project and add your domain to this project to issue a certificate. Here is an example of a Compose project:

```yaml
services:
whoami:
image: docker.io/traefik/whoami:latest
networks:
- dokploy-network
```

Then go to the `Domains` tab, click `Add Domain`, select `whoami` in the `Service Name` field, enter `your domain (mail.example.com)` in the `Host` field and set the `Container Port` field to 80. In the HTTPS line below, enable this value and select `Letsencrypt (Default)`.


Then save it, and in the `General` tab, click `Deploy`
5 changes: 5 additions & 0 deletions apps/docs/content/docs/templates/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"title": "Templates",
"root": true,
"pages": ["---Templates---", "mail-server/index", "erpnext/index"]
}