Skip to content

Latest commit

 

History

History
97 lines (72 loc) · 3.38 KB

INSTALLATION.md

File metadata and controls

97 lines (72 loc) · 3.38 KB

Installation Guide

⚠️ Important: These instructions cover the general process for uploading and installing community packages. Each project may have additional configuration and deployment requirements - please refer to project-specific documentation.

Upload Package to Your Enrollment

The first step is uploading your package to the Foundry Marketplace:

  1. Download the project's .zip file from this repository
  2. Access your enrollment's marketplace at: 
    {enrollment-url}/workspace/marketplace
  3. In the marketplace interface, initiate the upload process:
    • Select or create a store in your preferred project folder
    • Click the "Upload to Store" button
    • Select your downloaded .zip file

Marketplace Interface

Install the Package

After upload, you'll need to install the package in your environment. For detailed instructions, see the official Palantir documentation.

The installation process has four main stages:

  1. General Setup

    • Configure package name
    • Select installation location

  2. Input Configuration

    • Configure any required inputs. If no inputs are needed, proceed to next step
    • Check project documentation for specific input requirements

  3. Content Review

    • Review resources to be installed such as Developer Console, the Ontology, and Functions

  4. Validation

    • System checks for any configuration errors
    • Resolve any flagged issues
    • Initiate installation

SDK Configuration (Optional)

Some packages include applications built with the Ontology SDK. These require additional setup:

  1. Locate the SDK application code in the app/ directory of the project repository

  2. The following details will need to added to the source code for the application.

    • Navigate to Developer Console: {enrollment-url}/workspace/developer-console
    • Find the installed application
    • Copy the following details:
      • CLIENT ID
      • Enrollment URL {enrollment-url}.palantirfoundry.com

  3. Configure your development environment:

    • Add to env.development file under app/
    • (optional) Configure CORS in your control panel to allow http://localhost:8080

Local Development

To run the application locally:

  1. Access the Developer Console's "Start Developing" section
  2. Follow the "Add Ontology SDK" setup process)
  3. In the /app directory, start the development server: 
    npm run dev
    This will launch your application at http://localhost:8080

Production Deployment

For website hosting setup:

  1. Update .env.production with your production configuration

  2. If using Foundry website hosting, configure foundry.config.json:

    {
  "foundryUrl": "https://<YOUR ENROLLMENT>.palantirfoundry.com",
  "site": {
    "application": "<APPLICATION RID FROM DEV CONSOLE>",
    "directory": "./dist",
    "autoVersion": {
      "type": "git-describe",
      "tagPrefix": ""
    }
  }
}

  3. Follow the deployment instructions in your widget's developer console

Note: For production deployments, set VITE_FOUNDRY_REDIRECT_URL in .env.production if you haven't specified a hosting URL. You can verify your production environment variables using the test in env.test.ts.