Skip to content
 
 

Repository files navigation

Sealos Template Repository

简体中文 | Quick Deploy

With the templates in this repository, you can easily run various applications on Sealos without worrying about dependencies between applications. Deploy with one click!

🚀 Quick Start

3 Steps to Deploy Your First App

  1. Browse available templates and find one you like
  2. Click the "Deploy on Sealos" button in the template documentation
  3. Configure and deploy - just fill in the required parameters

Template authoring quick links:

  • Start from template.yaml (or the Create Template (TODO) button).
  • Built-in variables/functions use GitHub Actions-style syntax; see example.md.
  • A complete FastGPT example and database Cluster YAML examples (MongoDB/PostgreSQL/MySQL/Redis/Kafka/Milvus/ClickHouse) are in example.md.

That's it! Your app will be running in minutes.

Popular Templates

Template Description Deploy
FastGPT Build your own knowledge base with AI Deploy
ChatGPT-Next-Web ChatGPT web UI with your own API key Deploy
Code-Server VS Code in your browser Deploy
Cloudreve Cloud storage system Deploy
Appsmith Low-code app builder Deploy

View all templates →

📚 Documentation

🛠️ How to Create a Template

You can create your application template through existing template files or the UI (TODO button).

1. Start from a template reference

Copy template.yaml as your starting point:

cp template.yaml my-app-template.yaml

2. Understand the structure

Template files are divided into two main parts:

  • Metadata CR: Template information, default values, and user inputs
  • Kubernetes Resources: StatefulSet, Service, Ingress, etc.

For detailed explanation, see example.md.

3. Use variables and functions

The system provides built-in environment variables and functions. Use GitHub Actions-like syntax:

# System built-in variable
${{ SEALOS_NAMESPACE }}

# Function to generate random string
${{ random(8) }}

# User input variable
${{ inputs.your_parameter }}

See Built-in system variables and functions for complete reference.

4. Example: FastGPT Template

The FastGPT example demonstrates how to create a complete template with:

  • Default application name and hostname
  • User-configurable inputs (API key, password, database type)
  • Multiple Kubernetes resources (database, application, ingress)

🤖 Convert Apps with Agent Skills

This repository includes the docker-to-sealos skill (.codex/skills/docker-to-sealos/SKILL.md), which can be called directly from Codex, Claude Code, OpenCode, and OpenClaw to convert Docker Compose apps into Sealos templates.

Recommended Cross-Agent Prompt

Use this minimal prompt in your agent:

Use the `docker-to-sealos` skill and convert this GitHub repository to a Sealos template:
https://github.com/<owner>/<repo>

Invocation Notes

  • Replace the URL with your target repository.
  • If your agent supports explicit skill calls, invoke it as $docker-to-sealos.
  • If your agent uses automatic routing, mentioning docker-to-sealos in the prompt is usually enough.
  • The same prompt pattern works across Codex, Claude Code, OpenCode, and OpenClaw.

🔗 Use "Deploy on Sealos" Button

You can add a "Deploy on Sealos" button to your project's README:

Markdown

[![](https://sealos.io/Deploy-on-Sealos.svg)](https://sealos.io/products/app-store/your-app-name)

HTML

<a href="https://sealos.io/products/app-store/your-app-name">
  <img src="https://sealos.io/Deploy-on-Sealos.svg" alt="Deploy on Sealos"/>
</a>

Replace your-app-name with your template's metadata.name from the Template CR.

🤝 Contributing

We welcome contributions! Follow these steps:

  1. Fork this repository
  2. Create a branch for your template or improvement
  3. Follow the template structure - use template.yaml as reference
  4. Test your template on Sealos before submitting
  5. Submit a pull request with clear description

Template Guidelines

  • Naming: Use lowercase, hyphen-separated names (e.g., my-awesome-app)
  • Description: Write clear, concise descriptions
  • Documentation: Include app-specific usage instructions if needed
  • Defaults: Provide sensible default values for all inputs
  • Resources: Set reasonable resource limits (CPU/memory)

📖 Resources

📄 License

This repository follows the same license as Sealos. See LICENSE for details.

About

No description, website, or topics provided.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages