Skip to main content

Getting Started with Admin

Welcome to Portal Admin

As an authorized user, you can access the Admin section through the left sidebar navigation. Admin provides comprehensive configuration management to customize Portal for your organization's needs.

Admin Overview

The Admin interface is organized into three main areas for an intuitive configuration experience:

App Settings

Core Portal functionality including authentication, integrations, telemetry, and user management. Features curated forms designed specifically for Portal customers.

Plugin Settings

Single view for managing all installed and available plugins. Enable, disable, and configure plugins to customize your Portal experience.

Catalog Settings

Manage catalog configuration and monitor ingestion processes. Overview of all running catalog ingestions and entity management.

App Settings Structure

The App Settings section is divided into four organized tabs:

TabDescription
GeneralOrganization settings, branding, and core Portal configuration
AuthAuthentication providers with curated forms for all supported methods
IntegrationsRepository and service integrations with simplified configuration
UsersPortal administrator and user management

Common First Steps

After completing the Setup Wizard, here are the most common configuration tasks:

Update Company Name

Personalize Portal with your organization's branding:

Prerequisites

Before customizing your organization name, ensure you have configured:

  • Authentication provider (e.g., GitHub)
  • Integration (e.g., GitHub App)
  • Catalog data provider for organizational data

For setup requirements and provider-specific instructions, see our Getting Started Guide.

  1. Navigate to Admin → App Settings → General tab
  2. Update the "Organization Name" field with your company name
  3. Click "Save Changes"

Your Portal will now display your company name throughout the interface, creating a branded experience for your users.

Add More Authorized Users

Grant admin access to additional team members:

  1. Navigate to Admin → App Settings → Users tab
  2. Add new authorized users using entity references (e.g., user:default/jane.doe)
  3. Click "Save Changes"
Entity References

Use the format user:default/username where username matches the user's identifier in your authentication system (GitHub username, email, etc.).

Configure Integrations

Set up connections to your development tools:

  1. Navigate to Admin → App Settings → Integrations tab
  2. Configure your repository providers (GitHub, GitLab, Azure DevOps)
  3. Add API tokens and webhook configurations
  4. Test connections to ensure proper integration

Enable Plugins

Activate additional Portal features:

  1. Navigate to Admin → Plugin Settings
  2. Browse available plugins in the catalog
  3. Enable plugins that match your team's workflow
  4. Configure plugin-specific settings as needed

Need Help?

  • Setup Issues: Check the Troubleshooting Guide
  • Authentication Problems: Review Auth Setup Guides
  • Plugin Configuration: Visit individual plugin documentation
  • Advanced Configuration: Explore the full Admin interface
Pro Tip

Start with the General and Users tabs to establish your basic Portal configuration, then gradually enable integrations and plugins as your team's needs grow.