# Getting Started with JovianX #### Table of Content 1. [Create and upload application blueprint](/getting-started-on-jovianx.md#step-1-create-and-upload-application-blueprint) 2. [Setup subscription plan](/getting-started-on-jovianx.md#step-2-setup-a-subscription-plan) 3. [Configure basic settings](/getting-started-on-jovianx.md#step-3-basic-settings) 4. C[reate customer account](/getting-started-on-jovianx.md#step-4-creating-customer-accounts) ### 1. Create and upload the application blueprint To get started creating your managed SaaS with JovianX, create your first [application blueprint](broken://pages/-LdZT-OS5JBfU8s00sNW). You can start by cloning the Hello SaaS World example blueprint from [GitHub](https://github.com/jovian-x/hello-world-saas-app). ```bash git clone git@github.com:jovian-x/hello-world-saas-app.git ``` #### Step 1 - Review application manifest: Review the application manifest file (a YAML file named [`jovianx.yaml`](https://github.com/jovian-x/hello-world-saas-app/blob/master/jovianx.yaml)). The application manifest has 2 main sections: the first is `Components` which declares service components with their properties, and the second is `settings_descriptors` which allows end-users to choose settings and control properties on signup. To review the application manifest file use cat command: ```bash cat hello-world-saas-app/jovianx.yaml ``` {% code title="hello-world-saas-app/jovianx.yaml" %} ```yaml # JovianX API Compatibility # v1 jovianx_api_version: v1 # Name of this SaaS application # string application_name: hello-world-app # version of this JovianX blueprint # semantic versioning version: 1.0.0 ... ``` {% endcode %} #### Step 2 - Create application blueprint archive An application blueprint is a `*.tar.gz` archive that contains an application manifest file(`jovianx.yaml`) in it's root directory, and also includes all the helm chart directories referenced in the application manifest `Jovianx.yaml` file. Review the files in the blueprint: ```bash tree hello-world-saas-app/ hello-world-saas-app/ ├── jovianx.yaml ├── LICENSE ├── mongodb-chart │ ├── Chart.yaml │ ├── values.yaml │ └── ... ├── node-chart │ ├── Chart.yaml │ ├── values.yaml │ └── ... ├── README.md ... 7 directories, 39 files ``` Create a `tar.gz` archive with the application manifest file(jovianx.yaml). ```bash cd hello-world-saas-app/ tar -czvf blueprint.tar.gz jovianx.yaml node-chart/ mongodb-chart/ values/ ``` {% hint style="info" %} **NOTE:** Make sure the the application manifest file (file named`jovinax.yaml` is in the root of the archive file, and also that the archive includes all referenced helm charts as non-archived directories. {% endhint %} {% hint style="success" %} You can name the blueprint archive any name you like, the best practice is to include the application name and version in the filename, i.e \`myapp\_blueprint\_4.13.0.tar.gz\`. {% endhint %} #### Step 3 - Push the application blueprint to JovianX Push the application blueprint to JovianX via the UI, or via API. {% tabs %} {% tab title="Push Blueprint via API / CURL" %} To push the blueprint via the API using Curl command: ```bash curl -u ':' -F 'file=@blueprint.tar.gz' 'https://.jovianx.app/api/v1/upload_blueprint' ``` {% hint style="info" %} **NOTE**: You can find your `ACCOUNT_API_KEY` and `ACCOUNT_API_SECRET` in the blueprints page under Upload a new Blueprint card. You can also integrate the push operation with your CI workflow. {% endhint %} {% hint style="info" %} **NOTE**: You can also set the blueprint as ACTIVE by adding the querystring `?make_default=true` to the API path. {% endhint %} {% endtab %} {% tab title="Push Blueprint via Web UI" %} To push the application blueprint via the Web UI: 1. Navigate on the side-menu to `Application > Blueprints`. 2. Click on the top card titled `Upload a new Blueprint`. 3. Click on button `Choose blueprint tar.gz file`
![Side Menu > Blueprints > click on "Upload a new Blueprint" card](/files/-M3_nGqx4JqEPICz9w_i) {% endtab %} {% endtabs %} ### 2. Setup a subscription plan A plan determines the recurring period of a subscription and can determine how much to charge for each billing period, it can also enable or disable the trial, and determine the trial period. #### **Create a plan:** 1. Using the side-meue navigate to `Plans` 2. Click on `Create new Plan` 3. Choose plan settings and enable Trial 4. On the bottom of the screen click on `Create new plan Version` 5. Review the newly created plan in plans list ![2. Create a new billing Plan](/files/-M3asBClgWHOlWL6SNXj) ![3. Configure billing plan settings ](/files/-M3aspSM0KM0-4DYI5lZ) ![5. Review plans](/files/-M3atQV-h9AZN43_M7L7) {% hint style="danger" %} **NOTE**: You must have at least one plan in your account. {% endhint %} {% hint style="success" %} **NOTE**: To enable "Require payment details on subscription", first enable payments and configure your PayPal account by navigating to `Settings > Payments > Enable PayPal.` {% endhint %} ### 3.Basic settings In the settings section you can configure many aspects of your managed service, including integration with a private Docker registry, Cloud DNS, cofngire your Kubernentes KUBECONFIG files, define the behavior of the customer console ![Configure automated email notifications](/files/-M3ayydfiElhhJ6pBg3I) ![Configure the hosted customer console](/files/-M3azCBlV27jLEoSn_ri) ### 4. Create a customer account Navigate to the customer console and create an example test account ![White-label Hosted Customer Console](/files/-M3aztNQNohVJYdJU1Q2) ### --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.jovianx.com/getting-started-on-jovianx.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.