### Install and Run IcePanel MCP Server Source: https://docs.icepanel.io/experiments/mcp-server-beta Instructions for installing and running the IcePanel MCP server. This involves using Node.js and npm/npx to install the package and then executing it with necessary environment variables for authentication and identification. ```shell npx -y @icepanel/mcp-server@latest API_KEY="your-api-key" ORGANIZATION_ID="your-org-id" ``` -------------------------------- ### Okta SAML App Setup Source: https://docs.icepanel.io/other-information/sso-saml Guide for configuring a SAML 2.0 application in Okta to enable SSO with IcePanel. ```APIDOC Okta SAML Configuration: 1. Navigate to Okta Admin > Applications > Add New App. 2. Select SAML 2.0. 3. Single sign on URL: https://app.icepanel.io/__/auth/handler 4. Audience URI (SP Entity ID): icepanel.io 5. Name ID format: email address Application username: email. 6. Click 'View setup instructions' to retrieve: SSO URL Identity Provider Issuer (Entity ID) Certificate Fill these into the IcePanel SAML registration form. 7. Grant required users or groups access to the Okta app. 8. Complete setup and await IcePanel confirmation. ``` -------------------------------- ### IcePanel CLI Azure DevOps Sync Source: https://docs.icepanel.io/integrations/code-repo-linking/azure-devops Reference for the IcePanel CLI command used to synchronize code repositories with Azure DevOps. Includes options, environment variables, and usage examples for both direct command execution and environment variable configuration. ```APIDOC Usage: IcePanel azure-devops-sync [options] Syncronize IcePanel code repos with a Azure DevOps instance Options: --api-url IcePanel API URL (default: "https://api.icepanel.io/v1") -k, --api-key IcePanel API key -s, --url Azure DevOps URL (default: "https://dev.azure.com") -t, --token Azure DevOps token -o, --organization Azure DevOps organization name, comma seperated -i, --interval Interval for syncronization (default: "1800") -f, --force Force refresh of code repos and trees --filter-repos Filter code repo names to include, supports wildcards --delete-all Delete all code repos and trees for this integration --concurrency Number of jobs that can be processed in parallel (default: "10") -h, --help display help for command Environment variables: API_URL IcePanel API URL API_KEY IcePanel API key AZURE_DEVOPS_URL Azure DevOps URL AZURE_DEVOPS_TOKEN Azure DevOps token AZURE_DEVOPS_ORGANIZATION Azure DevOps organization name, comma seperated SYNC_INTERVAL Interval for syncronization FORCE Force refresh of code repos and trees FILTER_REPOS Filter code repo names to include, supports wildcards CONCURRENCY Number of jobs that can be processed in parallel LOG_LEVEL Options are fatal, error, warn, info, debug, trace, silent Example (direct parameters): docker run icepanel/cli azure-devops-sync \ --api-key $ICEPANEL_KEY \ --url \ --token $AZURE_DEVOPS_TOKEN \ --organization $AZURE_DEVOPS_ORGANIZATION Example (environment variables): docker run \ -e API_KEY=$ICEPANEL_KEY \ -e AZURE_DEVOPS_URL=https://dev.azure.com \ -e AZURE_DEVOPS_TOKEN=$AZURE_DEVOPS_TOKEN \ -e AZURE_DEVOPS_ORGANIZATION=$AZURE_DEVOPS_ORGANIZATION \ icepanel/cli azure-devops-sync ``` -------------------------------- ### IcePanel CLI github-sync Command Reference Source: https://docs.icepanel.io/integrations/code-repo-linking/github Provides detailed information on the `icepanel github-sync` command, its purpose, available options, and environment variables for configuring synchronization with GitHub instances. It also mentions handling self-signed certificates. ```APIDOC Usage: IcePanel github-sync [options] Syncronize IcePanel code repos with a GitHub instance Options: --api-url IcePanel API URL (default: "https://api.icepanel.io/v1") -k, --api-key IcePanel API key -s, --url GitHub URL (default: "https://api.github.com") -t, --token GitHub token -i, --interval Interval for syncronization (default: "1800") -f, --force Force refresh of code repos and trees --filter-repos Filter code repo names to include, supports wildcards --delete-all Delete all code repos and trees for this integration --concurrency Number of jobs that can be processed in parallel (default: "10") -h, --help display help for command Environment variables: API_URL IcePanel API URL API_KEY IcePanel API key GITHUB_URL GitHub URL GITHUB_TOKEN GitHub token SYNC_INTERVAL Interval for syncronization FORCE Force refresh of code repos and trees FILTER_REPOS Filter code repo names to include, supports wildcards CONCURRENCY Number of jobs that can be processed in parallel LOG_LEVEL Options are fatal, error, warn, info, debug, trace, silent Self-signed certificates: To use a self signed the certificates NODE_TLS_REJECT_UNAUTHORIZED=0 must be specified as an environment variable to the CLI container. ``` -------------------------------- ### Sync Self-Hosted GitHub with IcePanel CLI Source: https://docs.icepanel.io/integrations/code-repo-linking/github Synchronizes code repositories from a self-hosted GitHub instance with IcePanel using the IcePanel CLI. Supports configuration via command-line parameters or environment variables. ```shell docker run icepanel/cli github-sync \ --api-key $ICEPANEL_KEY \ --url \ --token $GITHUB_TOKEN ``` ```shell docker run \ -e API_KEY=$ICEPANEL_KEY \ -e GITHUB_URL=https://github.com \ -e GITHUB_TOKEN=$GITHUB_TOKEN \ icepanel/cli github-sync ``` -------------------------------- ### Google Workspace SAML App Setup Source: https://docs.icepanel.io/other-information/sso-saml Instructions for configuring a custom SAML application within Google Workspace to enable SSO with IcePanel. ```APIDOC Google Workspace SAML Configuration: 1. Navigate to Google Admin console > Apps > Web and mobile apps. 2. Click 'Add app' > 'Add custom SAML app'. 3. App name: IcePanel Upload IcePanel logo (optional). 4. SSO URL (from Google): Copy this value. Entity ID (from Google): Copy this value. Certificate (from Google): Copy this value. Fill these into the IcePanel SAML registration form. 5. Set 'ACS URL' field to: https://app.icepanel.io/__/auth/handler 6. Set 'Entity ID' field to: icepanel.io 7. Name ID format: EMAIL Name ID: Primary email 8. User access: ON for everyone. 9. Complete setup and await IcePanel confirmation. ``` -------------------------------- ### Copy Flow as Text Example Source: https://docs.icepanel.io/visual-storytelling/flows Example output format for copying an LLM flow as text, detailing steps, participants, and actions. This format is useful for appending to images or PDFs of your diagram for documentation purposes. ```text Introduction: Notes about this flow - Step 1: User: This happens first - Step 2: User -> API service: Thing happens via Request PNG or PDF export - Step 3: API service -> Export topic: Then this happens via Publish export request ``` -------------------------------- ### IcePanel CLI: bitbucket-server-sync Command Source: https://docs.icepanel.io/integrations/code-repo-linking/bitbucket-server Provides documentation for the IcePanel CLI command `bitbucket-server-sync` used to synchronize IcePanel code repositories with a Bitbucket Server instance. It details available options for configuration and environment variables for setting up the integration. ```APIDOC IcePanel bitbucket-server-sync Command Syncronize IcePanel code repos with a BitBucket server instance Usage: IcePanel bitbucket-server-sync [options] Options: --api-url IcePanel API URL (default: "https://api.icepanel.io/v1") -k, --api-key IcePanel API key -s, --server-url BitBucket server URL -u, --username BitBucket server username -t, --token BitBucket server token -p, --project-key BitBucket project key, comma seperated -i, --interval Interval for syncronization (default: "1800") -f, --force Force refresh of code repos and trees --filter-repos Filter code repo names to include, supports wildcards --delete-all Delete all code repos and trees for this integration --concurrency Number of jobs that can be processed in parallel (default: "10") -h, --help display help for command Environment variables: API_URL IcePanel API URL API_KEY IcePanel API key BITBUCKET_SERVER_URL BitBucket server URL BITBUCKET_SERVER_USERNAME BitBucket server username BITBUCKET_SERVER_TOKEN BitBucket server token BITBUCKET_PROJECT_KEY BitBucket project key, comma seperated SYNC_INTERVAL Interval for syncronization FORCE Force refresh of code repos and trees FILTER_REPOS Filter code repo names to include, supports wildcards CONCURRENCY Number of jobs that can be processed in parallel LOG_LEVEL Options are fatal, error, warn, info, debug, trace, silent ``` -------------------------------- ### List Organizations Landscapes Source: https://docs.icepanel.io/integrations/rest-api Example using curl to request a list of landscapes for a specific organization. This demonstrates making a GET request to the API endpoint. ```bash curl 'https://api.icepanel.io/v1/organizations/{organizationId}/landscapes' \ -H 'Accept: application/json' \ -H 'Authorization: ApiKey SH5XAiWtgevC2ZfQym3i:17a9c60035eed62c8f4f195c754ee6972ffc40ce975c5571ec521f463ebefa7f' ``` -------------------------------- ### iFrame Embed Code Example Source: https://docs.icepanel.io/collaboration/sharing This is an example of an iFrame code snippet that can be used to embed IcePanel diagrams or landscapes into other web pages or applications. It specifies the source URL and dimensions for the embedded content. ```html ``` -------------------------------- ### IcePanel CLI gitlab-sync Command Reference Source: https://docs.icepanel.io/integrations/code-repo-linking/gitlab Detailed reference for the `gitlab-sync` command within the IcePanel CLI, used to synchronize code repositories with a GitLab instance. It covers available options, their descriptions, default values, and corresponding environment variables for configuration. ```APIDOC Usage: IcePanel gitlab-sync [options] Syncronize IcePanel code repos with a GitLab instance Options: --api-url IcePanel API URL (default: "https://api.icepanel.io/v1") -k, --api-key IcePanel API key -s, --url GitLab URL (default: "https://gitlab.com") -t, --token GitLab token -g, --group-id GitLab group ID, comma seperated -i, --interval Interval for syncronization (default: "1800") -f, --force Force refresh of code repos and trees --filter-repos Filter code repo names to include, supports wildcards --delete-all Delete all code repos and trees for this integration --concurrency Number of jobs that can be processed in parallel (default: "10") -h, --help display help for command Environment variables: API_URL IcePanel API URL API_KEY IcePanel API key GITLAB_URL GitLab URL GITLAB_TOKEN GitLab token GITLAB_GROUP_ID GitLab group ID, comma seperated SYNC_INTERVAL Interval for syncronization FORCE Force refresh of code repos and trees FILTER_REPOS Filter code repo names to include, supports wildcards CONCURRENCY Number of jobs that can be processed in parallel LOG_LEVEL Options are fatal, error, warn, info, debug, trace, silent ``` -------------------------------- ### Microsoft Entra ID SAML App Setup Source: https://docs.icepanel.io/other-information/sso-saml Steps to set up a non-gallery SAML application in Microsoft Entra ID (formerly Azure AD) for IcePanel SSO. ```APIDOC Microsoft Entra ID SAML Configuration: 1. Navigate to Microsoft Entra ID portal > Enterprise applications. 2. Click 'New application' > 'Non-gallery application'. 3. App name: IcePanel Upload IcePanel logo (optional). 4. In the application, select 'Single sign-on' > 'SAML'. 5. Basic SAML configuration: Identifier (Entity ID): icepanel.io Reply URL (Assertion Consumer Service URL): https://app.icepanel.io/__/auth/handler 6. Copy 'Certificate (Base64)', 'Login URL', and 'Azure AD Identifier' from Entra ID. Fill these into the IcePanel SAML registration form. 7. Assign users or groups to the application under 'Users and groups'. 8. Complete setup and await IcePanel confirmation. ```