Thanks to visit codestin.com
Credit goes to github.com

Skip to content

shizhMSFT/oras-desktop

Repository files navigation

ORAS Desktop

banner

A user-friendly desktop application for managing container artifacts in OCI registries (like Docker Hub, GitHub Container Registry, Azure Container Registry, etc.)

What is ORAS Desktop?

ORAS Desktop lets you easily view and manage your container artifacts without using command-line tools. With a simple graphical interface, you can:

  • Browse your repositories in any container registry
  • View all tags and versions of your containers
  • Inspect manifest details with an easy-to-read display
  • Explore relationships between artifacts

ORAS Desktop is built on top of the ORAS .NET SDK, which provides .NET bindings for the OCI Registry As Storage (ORAS) project.

Getting Started

Download the App

  1. Visit our Releases page
  2. Download the version for your operating system:
    • macOS: .app.zip file
    • Linux: .tar.gz file
    • Windows: .zip file

Installation

macOS

  1. Extract the downloaded .app.zip file
  2. Move the extracted app to your Applications folder
  3. Right-click the app and select "Open" (required only on first launch)

Linux

  1. Extract the downloaded TAR.GZ file
  2. Open a terminal and navigate to the extracted folder
  3. Make the application executable: chmod +x OrasProject.OrasDesktop.Desktop
  4. Run the application: ./OrasProject.OrasDesktop.Desktop

Windows

  1. Extract the downloaded ZIP file
  2. Double-click OrasProject.OrasDesktop.Desktop.exe to start the application

Using ORAS Desktop

Connecting to a Registry

  1. Click the "Connect" button in the top bar
  2. Enter your registry address (e.g., mcr.microsoft.com)
  3. Choose authentication type:
    • Anonymous (no credentials)
    • Basic (username/password)
    • Bearer Token (for registries using token-based auth)
  4. Enter your credentials if required
  5. Click "Connect"

Browsing Repositories

  • All accessible repositories will appear in the left sidebar
  • Click on a repository to view its available tags
  • Select a tag to view the manifest details

Viewing Manifests

  • Manifest details are displayed with syntax highlighting
  • Clickable digest links allow quick navigation between related manifests
  • The manifest shows important metadata like layers, configuration, and annotations

System Requirements

  • macOS: macOS 11 (Big Sur) or later (Intel or Apple Silicon)
  • Linux: Most modern 64-bit distributions (Ubuntu 20.04+, Fedora 34+, etc.)
  • Windows: Windows 10 or later (64-bit)

Building from Source

Prerequisites

Build Steps

  1. Clone the repository:

    git clone https://github.com/shizhMSFT/oras-desktop.git
    cd oras-desktop
  2. Restore dependencies and build:

    dotnet restore
    dotnet build --configuration Release
  3. Run the application:

    dotnet run --project OrasProject.OrasDesktop.Desktop/OrasProject.OrasDesktop.Desktop.csproj

Troubleshooting

Application Won't Start

  • macOS: If you get a "damaged app" warning, try right-clicking the app and selecting "Open"
  • Linux: Ensure the application has execute permissions (chmod +x)
  • Windows: Make sure you have the Visual C++ Redistributable installed

Can't Connect to Registry

  • Check your network connection
  • Verify your credentials are correct
  • Some registries may have IP restrictions or other access controls

Enable Debug Logging

To enable detailed debug logging, run the application with the --debug flag:

dotnet run --project OrasProject.OrasDesktop.Desktop/OrasProject.OrasDesktop.Desktop.csproj -- --debug

Logs are written to a temp file. The file path is shown in the status bar.

For Additional Help

If you encounter issues not covered here:

  1. Check the GitHub Issues to see if your problem is already known
  2. Create a new issue with details about your problem

License

ORAS Desktop is licensed under the Apache License 2.0.

Related Projects

About

ORAS desktop application based on ORAS .NET SDK

Resources

License

Stars

Watchers

Forks

Contributors 3

  •  
  •  
  •  

Languages