Skip to main content

Installer

Properties

PropertyTypeRequiredDescriptionDefaultExample
sourcestringNoexternal configuration source Path to an external file containing installer configuration (YAML, JSON, or TOML)--
namestringNoinstaller name Human-readable name for the installer-"My SaaS Installer"
descriptionstringNoinstaller description Detailed description of what this installer does-"Complete installer for My SaaS application"
slugstringNoURL-safe slug URL-friendly identifier for the installer-"my-saas-installer"
appsarrayNolist of app names Array of app names to include in this installer-"api"
documentation_urlstringNodocumentation URL Link to the application documentation-"https://docs.example.com"
community_urlstringNocommunity URL Link to community resources or forum-"https://community.example.com"
homepage_urlstringNohomepage URL Link to the application homepage-"https://example.com"
github_urlstringNoGitHub repository URL Link to the GitHub repository-"https://github.com/example/repo"
logo_urlstringNologo URL URL to the application logo image-"https://example.com/logo.png"
favicon_urlstringNofavicon URL URL to the favicon image-"https://example.com/favicon.ico"
og_image_urlstringNoOpenGraph image URL URL to the image displayed when sharing the installer on social media-"https://example.com/og-image.png"
demo_urlstringNodemo URL Link to a live demo of the application-"https://demo.example.com"
post_install_markdownstringNopost-install markdown Markdown content displayed to users after successful installation--
copyright_markdownstringNocopyright markdown Markdown content for copyright information--
footer_markdownstringNofooter markdown Markdown content displayed in the installer footer--

Property Details

apps

Examples:
"api"
"web-ui"