Skip to main content

Installer

Properties

PropertyDescriptionValuesExample
name
string
installer name Human-readable name for the installerOptional"My SaaS Installer"
description
string
installer description Detailed description of what this installer doesOptional"Complete installer for My SaaS application"
slug
string
URL-safe slug URL-friendly identifier for the installerOptional"my-saas-installer"
apps
array
list of app names Array of app names to include in this installerOptional"api", "web-ui"
documentation_url
string
documentation URL Link to the application documentationOptional"https://docs.example.com"
community_url
string
community URL Link to community resources or forumOptional"https://community.example.com"
homepage_url
string
homepage URL Link to the application homepageOptional"https://example.com"
github_url
string
GitHub repository URL Link to the GitHub repositoryOptional"https://github.com/example/repo"
logo_url
string
logo URL URL to the application logo imageOptional"https://example.com/logo.png"
favicon_url
string
favicon URL URL to the favicon imageOptional"https://example.com/favicon.ico"
og_image_url
string
OpenGraph image URL URL to the image displayed when sharing the installer on social mediaOptional"https://example.com/og-image.png"
demo_url
string
demo URL Link to a live demo of the applicationOptional"https://demo.example.com"
post_install_markdown
string
post-install markdown Markdown content displayed to users after successful installationOptional"## Next Steps\n\nYour application is now installed!"
copyright_markdown
string
copyright markdown Markdown content for copyright informationOptional"© 2025 Acme Inc. All rights reserved."
footer_markdown
string
footer markdown Markdown content displayed in the installer footerOptional`“DocumentationSupport”`