System Settings
Configure organization name, email domain, and self-registration modes. Configure settings →
Admin Guide
The Admin Guide covers everything you need to know about administering your Legend instance. Whether you’re setting up Legend for the first time, managing users and groups, configuring authentication, or maintaining your deployment, this guide provides the information you need.
What Administrators Can Do
Section titled “What Administrators Can Do”Administrators have full control over the Legend instance. With administrator privileges, you can:
- Manage users: Create, edit, deactivate, and delete user accounts
- Configure groups: Set up user groups for access control and permissions
- Customize categories and tags: Define the organizational structure for your entities
- Apply branding: Upload custom logos and favicons to match your organization’s identity
- Configure authentication: Set up OIDC/SSO integration with your identity provider
- Manage licensing: Apply and monitor your Legend license
- Monitor activity: Review audit logs to track changes and user activity
- Maintain backups: Create and restore database backups
- Configure alerts: Set up system-wide alert banners for important notifications
- Monitor link health: Track the availability of entity links
- Adjust system settings: Configure organization name, email domain, and registration modes
Admin Panel Navigation
Section titled “Admin Panel Navigation”The admin panel is organized into four main sections, accessible from the sidebar:
System
- Settings: Configure organization name, email domain, and registration modes
- Users: Manage user accounts and permissions
- Groups: Create and manage user groups for access control
Data
- Categories: Define and organize entity categories
- Tags: Create and manage tags with custom colors
- Branding: Upload custom logos and favicons
Security
- Single Sign-On (OIDC): Configure OIDC/SSO integration
- License: Apply and monitor your Legend license
- Audit Logs: Review system activity and changes
Operations
- Backups: Create and restore database backups
- Alerts: Configure system-wide alert banners
- Link Health: Monitor entity link availability
To access the admin panel, click your user menu in the top-right corner and select “Admin Panel” from the dropdown. Only users in the Admins group can access the admin panel.
User Management
Create, edit, and manage user accounts and permissions. Manage users →
Group Management
Set up user groups for access control and OIDC synchronization. Manage groups →
Categories and Tags
Define categories and tags to organize your entities. Organize entities →
Branding
Upload custom logos and favicons to match your organization. Customize branding →
Single Sign-On
Configure OIDC/SSO integration with your identity provider. Configure SSO →
License Management
Apply and monitor your Legend license tier and usage. Manage license →
Audit Logs
Review system activity and track changes over time. View logs →
Backups
Create and restore database backups to protect your data. Manage backups →
Alerts
Configure system-wide alert banners for important notifications. Set up alerts →
Link Health
Monitor the availability of entity links and detect broken links. Monitor links →
Data Directory
Understand the file-based data storage structure and YAML format. Explore structure →
Environment Variables
Reference for all environment variables and configuration options. View reference →
Troubleshooting
Solutions for common issues and how to get help. Get help →
Administrator Responsibilities
Section titled “Administrator Responsibilities”As an administrator, you have significant responsibility for the Legend instance. Key responsibilities include:
Security and Access Control
- Ensure only authorized users have access to the system
- Configure appropriate group memberships and permissions
- Monitor audit logs for suspicious activity
- Keep the system updated with the latest security patches
Data Management
- Create regular backups and verify they can be restored
- Monitor license usage and entity counts
- Ensure data quality and consistency
- Plan for data growth and capacity
User Support
- Help users understand how to use Legend effectively
- Resolve access issues and permission problems
- Provide guidance on best practices for entity creation
- Facilitate onboarding for new users
System Maintenance
- Keep the Legend instance updated to the latest version using Check for Updates in the Admin panel (powered by the update agent deployed during installation; see Install Legend)
- Monitor system performance and resource usage
- Configure alerts for important events
- Maintain documentation for your specific configuration
Getting Started with Administration
Section titled “Getting Started with Administration”If you’re new to administering Legend, we recommend starting with these tasks:
- Review system settings: Ensure your organization name and email domain are configured correctly
- Create user accounts: Add users who need access to Legend
- Set up groups: Create groups to organize users and control access
- Configure categories and tags: Define the organizational structure for your entities
- Apply branding: Upload your organization’s logo and favicons
- Set up backups: Ensure you have a backup strategy in place
- Configure alerts: Set up alerts for important system events
For detailed instructions on each of these tasks, see the relevant sections in this guide.
Next Steps
Section titled “Next Steps”Start with System Settings to configure your organization, or jump to User Management to add users to your Legend instance.