Documentation

Site Setup

Configure your app's basic information: name, description, URL slug, and app icon.

The first step is to configure your app’s basic information. In the Dashboard, fill out the Site Info section.

App Name

The name of your app as it appears in the App Store. This is displayed at the top of your privacy policy, support page, and data deletion page.

Description

A short description of your app (optional, up to 4,000 characters to match the App Store limit). Shown below the app name on your hosted pages.

URL Slug

Your site’s URL path. If you choose my-cool-app, your site will be available at sites.orbitkit.io/my-cool-app.

  • Must be 1–63 characters, lowercase letters, numbers, and hyphens only
  • Cannot start or end with a hyphen
  • Must be unique across all OrbitKit users
  • Certain slugs are reserved (e.g., admin, api, dashboard)

App Icon

Upload your app icon (PNG, JPEG, or WebP, max 2 MB). It will be resized to 512x512 and displayed on all your hosted pages.

When you upload an icon, OrbitKit automatically extracts the dominant color from the image and uses it to create a color-matched background for your site. The homepage features a radial gradient tinted with your icon’s color, and all other pages receive a subtle color wash in the header area. This works in both light and dark mode.

Security note SVG files are not accepted because they can contain embedded scripts. Your icon is re-encoded server-side to strip any metadata.