dokploy/templates/types/templates-data.type.ts
Mauricio Siu 8f9d21c0f8
Docker compose support (#111)
* feat(WIP): compose implementation

* feat: add volumes, networks, services name hash generate

* feat: add compose config test unique

* feat: add tests for each unique config

* feat: implement lodash for docker compose parsing

* feat: add tests for generating compose file

* refactor: implement logs docker compose

* refactor: composeFile set not empty

* feat: implement providers for compose deployments

* feat: add Files volumes to compose

* feat: add stop compose button

* refactor: change strategie of building compose

* feat: create .env file in composepath

* refactor: simplify git and github function

* chore: update deps

* refactor: update migrations and add badge to recognize compose type

* chore: update lock yaml

* refactor: use code editor

* feat: add monitoring for app types

* refactor: reset stats on change appName

* refactor: add option to clean monitoring folder

* feat: show current command that will run

* feat: add prefix

* fix: add missing types

* refactor: add docker provider and expose by default as false

* refactor: customize error page

* refactor: unified deployments to be a single one

* feat: add vitest to ci/cd

* revert: back to initial version

* refactor: add maxconcurrency vitest

* refactor: add pool forks to vitest

* feat: add pocketbase template

* fix: update path resolution compose

* removed

* feat: add template pocketbase

* feat: add pocketbase template

* feat: add support button

* feat: add plausible template

* feat: add calcom template

* feat: add version to each template

* feat: add code editor to enviroment variables and swarm settings json

* refactor: add loader when download the image

* fix: use base64 to generate keys plausible

* feat: add recognized domain names by enviroment compose

* refactor: show alert to redeploy in each card advanced tab

* refactor: add validation to prevent create compose if not have permissions

* chore: add templates section to contributing

* chore: add example contributing
2024-06-02 15:26:28 -06:00

68 lines
1.2 KiB
TypeScript

import type { templates } from "../templates";
import type { Schema, Template } from "../utils";
/**
* Type representing the keys of the templates.
*/
export type TemplatesKeys = (typeof templates)[number]["id"];
/**
* Interface representing the data structure for a template.
*/
export type TemplateData = {
/**
* Unique identifier for the template.
*/
id: string;
/**
* Name of the template.
*/
name: string;
/**
* Description of the template Max(150 Characters).
*/
description: string;
/**
* Links related to the template.
*/
links: {
/**
* GitHub repository link for the template.
*/
github: string;
/**
* Optional documentation link for the template.
*/
docs?: string;
/**
* Optional website link for the template.
*/
website?: string;
};
/**
* Version of the template.
*/
version: string;
/**
* Tags associated with the template.
*/
tags: string[];
/**
* Name of the logo file with extension (e.g. pocketbase.png).
*/
logo: string;
/**
* Function to load the template, returning a promise that resolves with a function
* taking a schema and returning a template.
*/
load: () => Promise<(schema: Schema) => Template>;
};