Contents Menu Expand Light mode Dark mode Auto light/dark mode
Documentation Portal
  • 4.13 (current)
  • 4.0
  • 3.1
  • 3.0 (EOL)
  • 2.8 (EOL)
Logo
Mirantis Secure Registry
  • Product Overview
  • Reference Architecture
    • Introduction to MSR
    • Components
    • System requirements
    • Networks
    • Volumes
    • Storage
    • MSR Web UI
      • Rule engine
  • Installation Guide
    • System requirements
    • Preconfigure MKE
    • Install MSR online
    • Install MSR offline
    • Obtain the license
    • Uninstall MSR
  • Operations Guide
    • Access MSR
      • Configure your Mirantis Container Runtime
      • Configure your Notary client
      • Use a cache
    • Manage access tokens
    • Configure MSR
      • Add a custom TLS certificate
      • Enable single sign-on
      • Disable persistent cookies
      • Disable MSR telemetry
      • Configure external storage
        • Configure MSR image storage
        • Deploy MSR on NFS
        • Configure MSR for S3-compatible cloud storage providers
        • Migrate to a new storage backend
      • Set up high availability
      • Use a load balancer
      • Set up security scanning
        • Enable MSR security scanning
        • Set repository scanning mode
        • Update the CVE scanning database
      • Caches
        • MSR cache prerequisites
        • MSR cache deployment scenario
        • Deploy an MSR cache with Swarm
          • Prepare the cache deployment
          • Deploy the cache
        • Deploy an MSR cache with Kubernetes
          • Prepare the cache deployment
          • Create Kubernetes resources
          • Expose the MSR Cache
        • Configure caches for high availability
        • MSR cache configuration
      • Garbage collection
        • Schedule garbage collection
        • How garbage collection works
      • Create a new repository when pushing an image
      • Use a web proxy
    • Manage applications
    • Manage images
      • Create a repository
      • Review repository information
      • Pull and push images
      • Delete images
      • Scan images for vulnerabilities
        • Security scan process
        • Scan images
        • Review security scan results
        • Override a vulnerability
        • Scanner reporting
      • Prevent tags from being overwritten
      • Sign images
        • Sign an image
        • Using Docker Content Trust with a Remote MKE Cluster
    • Manage jobs
    • Manage users
    • Manage webhooks
      • Webhook types
      • Manage repository webhooks using web UI
      • Manage repository webhooks using API
        • API curl requests
        • Manage content structure using API
        • View and manage subscriptions
    • Manage repository events
      • Audit repository events
      • Enable Auto-Deletion of Repository Events
    • Promotion policies and monitoring
      • Promotion policies overview
      • Promote an image using policies
      • Mirror images to another registry
      • Mirror images from another registry
      • Template reference
    • Use Helm charts
      • Add a Helm chart repository
      • Pull charts and their provenance files
      • Push charts and their provenance files
      • View charts in a Helm repository
      • Delete charts from a Helm repository
      • Helm chart linting
        • Implement Helm linting
        • Helm chart linting rules
      • Helm limitations
    • Tag pruning
    • Image enforcement policies and monitoring
    • Upgrade MSR
    • Monitor MSR
    • Troubleshoot MSR
    • Disaster recovery
      • Disaster recovery overview
      • Repair a single replica
      • Repair a cluster
      • Create a backup
      • Restore from backup
    • Customer feedback
  • Migration Guide
    • MMT architecture
    • Migration prerequisites
    • Select the storage mode
    • Kubernetes migrations
    • Step-by-step migration
      • Verify the source system configuration
      • Estimate the migration
      • Extract the data
      • Transform the data extract
      • Restore the data extract
    • Settings not migrated
    • Telemetry
    • Troubleshoot migration
      • Restore MSR reusing an extract copy
      • Too many open files
      • Failure to load data error message
      • No space left on device
      • Failed to estimate migration error message
      • rethinkdb row cannot be restored
      • Admin password on MSR 3.0.x target no longer works
      • Blob image copy considerations
      • Total blob size: 0
      • Additional parameters
      • Additional volume mappings for containers
      • Failed to query for metadata size
      • flag provided but not defined: -append
      • Storage configuration is out of sync with metadata
      • The estimate command returns an image data value of 0
      • Unable to get FileInfo: /blobs
      • failed to run container: mmt-dtr-rethinkdb-backup
    • MMT release notes
      • 2.0.3
      • 2.0.2
      • 2.0.1
      • 2.0.0
      • 1.0.2
      • 1.0.1
  • Get Support

Reference documentation

  • API Reference
  • CLI Reference
    • mirantis/dtr backup
    • mirantis/dtr destroy
    • mirantis/dtr emergency-repair
    • mirantis/dtr images
    • mirantis/dtr install
    • mirantis/dtr join
    • mirantis/dtr reconfigure
    • mirantis/dtr remove
    • mirantis/dtr restore
    • mirantis/dtr upgrade

Release notes

  • Release Notes
    • 2.9.27
    • 2.9.26
    • 2.9.25
    • 2.9.24
    • 2.9.23
    • 2.9.22
    • 2.9.21
    • 2.9.20
    • 2.9.19
    • 2.9.18
    • 2.9.17
    • 2.9.16
    • 2.9.15
    • 2.9.14
    • 2.9.13
    • 2.9.12
    • 2.9.11
    • 2.9.10
    • 2.9.9
    • 2.9.8
    • 2.9.7
    • 2.9.6
    • 2.9.5
    • 2.9.4
    • 2.9.3
    • 2.9.2 (discontinued)
    • 2.9.1
    • 2.9.0
  • Release Compatibility Matrix
    • MSR 2.9 Compatibility Matrix
    • MKE and MSR Browser compatibility
    • MKE, MSR, and MCR Maintenance Lifecycle
  • Release Cadence and Support Lifecycle
  • Open Source Components and Licenses

Installation Guide¶

Targeted to deployment specialists and QA engineers, the MSR Installation Guide provides the detailed information and procedures you need to install and configure Mirantis Secure Registry (MSR).

  • System requirements
  • Preconfigure MKE
  • Install MSR online
  • Install MSR offline
  • Obtain the license
  • Uninstall MSR
Next
Preconfigure MKE
Previous
Rule engine
  • Multi-page view
  • Single-page view

Mirantis Inc. 900 E Hamilton Avenue, Suite 650, Campbell, CA 95008 +1-650-963-9828

© 2005 - 2025 Mirantis, Inc. All rights reserved. "Mirantis" and "FUEL" are registered trademarks of Mirantis, Inc. All other trademarks are the property of their respective owners.