First Steps with Legend

After installing Legend, you complete two wizards: the setup wizard creates your administrator account, and the onboarding wizard helps you populate Legend with initial data.

Setup Wizard

On first visit to your Legend instance, you are automatically redirected to the setup wizard at /setup. This wizard creates the initial administrator account and configures your organization.

1. Enter your name: Provide your first and last name. This information is used for your administrator profile.

2. Enter your organization name: This name appears throughout the Legend interface and in communications. Choose a name that represents your team or company.

3. Enter your admin email: This email address is used for authentication and notifications. Use an email address you will remember, as this is your primary administrator account.

4. Create a password: Your password must meet these requirements:

   • At least 12 characters long
   • Contains at least one uppercase letter (A-Z)
   • Contains at least one lowercase letter (a-z)
   • Contains at least one number (0-9)

   Password Strength

   Use a password manager to generate and store a strong password. The password is hashed using scrypt, a secure algorithm designed to resist brute-force attacks.

5. Confirm your password: Re-enter your password to ensure accuracy.

6. Click Complete Setup: Legend creates your administrator account, initializes the database, and redirects you to the main dashboard.

Single Setup Opportunity

The setup wizard only runs once. After completion, you cannot access it again. If you forget your administrator password, you must reset it through the database or reinstall Legend.

What Happens During Setup

When you complete the setup wizard, Legend:

• Creates the administrator user account with full privileges
• Initializes the SQLite database with system tables
• Creates default user groups (Admins, Users, Editors)
• Sets the organization name in system configuration
• Disables self-registration by default (you can enable it later in Admin Settings)
• Enables anonymous telemetry (you can disable it in Admin Settings)
• Creates a session cookie for immediate access

You are now logged in as the administrator and can access all admin features.

Onboarding Wizard

After completing the setup wizard, the onboarding wizard appears on your first visit to the dashboard. This wizard helps you populate Legend with demo data and common services so you can explore features immediately.

The onboarding wizard has three steps:

Step 1: Create Demo Entities

The first step offers to create a set of demo entities that showcase Legend’s capabilities. These demo entities include:

• Sample landmarks (services, projects, resources)
• Example teams and people
• Relationship connections between entities
• Documentation files attached to entities

Demo Entities Are Temporary

Demo entities are tagged with __onboarding_demo__ for easy identification and removal. You can delete them at any time from the dashboard or through the API. They do not count against your license tier limits during the initial setup period.

To create demo entities:

1. Click the “Create Demo Entities” button in the onboarding wizard.
2. Legend generates a complete set of sample data.
3. The dashboard refreshes to show the demo entities.

To skip this step:

Click “Skip” to proceed without creating demo entities. You can create your own entities manually or use the quick-add feature in the next step.

Step 2: Quick-Add Common Services

The second step offers a quick way to add common services and tools that many organizations use. This feature creates landmark entities with pre-configured icons and links.

Available quick-add services include:

• Development tools: GitHub, GitLab, Jira, Confluence
• Communication: Slack, Microsoft Teams, Discord
• Cloud services: AWS Console, Google Cloud, Azure Portal
• Monitoring: Grafana, Datadog, PagerDuty
• Documentation: Notion, Confluence, Google Docs

To use quick-add:

1. Browse the list of available services.
2. Select the services your organization uses by clicking the checkboxes.
3. Click “Add Selected Services”.
4. Legend creates landmark entities for each selected service.

Customize After Adding

Quick-add creates basic landmarks with default icons and links. After adding them, you can edit each landmark to customize the icon, add documentation, assign an owner, or define relationships.

To skip this step:

Click “Skip” to proceed without adding any services. You can add services manually at any time using the “Add Entity” button on the dashboard.

Step 3: Explore Features

The final step highlights key features you should explore:

• Search: Use the search box to find entities by name, description, tags, or documentation content. Search is relationship-aware and finds connected entities.

• Filters: Filter entities by type (landmarks, people, teams), tags, or categories using the sidebar controls.

• Entity cards: Click any entity card to open the detail drawer, which shows full information, relationships, links, and documentation.

• Topology explorer: Click the “Explore” button on any entity to visualize its relationships in an interactive graph. Navigate through dependencies, ownership, and team memberships.

• Admin panel: Access the admin panel from the user menu to manage users, groups, categories, tags, branding, and system settings.

To complete onboarding:

Click “Finish” or “Mark as Complete”. The onboarding wizard will not appear again. You can reset onboarding through the admin panel if you want to run through it again.

After Onboarding

After completing both wizards, you have a working Legend instance with:

• An administrator account with full access
• Optional demo entities showcasing the data model
• Optional quick-add services for common tools
• Familiarity with core features and navigation

Recommended Next Steps

1. Create your first real entities: Add landmarks for your actual services, projects, and resources. See the Working with Entities guide.

2. Add team members: Create person entities for your team and assign them to teams. See People and Teams.

3. Define relationships: Connect your entities with dependencies and ownership relationships. See Relationships.

4. Invite users: If you want other people to access Legend, create user accounts in the admin panel. See User Management.

5. Configure categories and tags: Set up categories and tags that match your organization’s structure. See Categories and Tags.

6. Apply a license: If you have a Starter, Professional, or Business license, apply it to unlock additional features. See License Management.

Troubleshooting Setup Issues

Setup Wizard Does Not Appear

If you visit Legend but the setup wizard does not appear, it means the system has already been initialized. This can happen if:

• You completed setup in a previous session
• Another user completed setup
• The database was pre-populated

To reset and run setup again, you must delete the SQLite database file (legend.db) in your data directory and restart the container.

Database Reset Is Destructive

Deleting the database removes all users, groups, configuration, and audit logs. Entity data (YAML files) is not affected. Only reset if you are certain you want to start over.

Password Requirements Not Met

If the setup wizard rejects your password, check that it meets all requirements:

• At least 12 characters (not 8, not 10, but 12)
• At least one uppercase letter (A through Z)
• At least one lowercase letter (a through z)
• At least one number (0 through 9)

Special characters are allowed but not required. The password is case-sensitive.

Cannot Access Admin Features

After setup, if you cannot access admin features (User Management, Settings, etc.), verify that you are logged in as the administrator account created during setup. Check the user menu in the top-right corner to see your email address.

If you need to verify your account has admin privileges, check the admin panel’s User Management page. The administrator account created during setup is automatically added to the Admins group.