Start here
Your first query
Connect to MongoDB, open a collection and run your first query in Palryn.
Before you start
You need a Palryn desktop build, a reachable MongoDB deployment, and a connection string or connection details. Palryn 0.7.0 is available for Windows and x86-64 Linux:
- Windows installer
- Linux AppImage
- Linux DEB for Debian/Ubuntu
- Linux RPM for Fedora
Download checksums are available for every package. Read the release notes from the version button in Palryn. Native Linux requirements and installation commands are below.
Third-party source downloads and checksums are available without charge for components with source-distribution requirements. Full component licences, source links and library-replacement instructions are also available through Third-party software on Palryn's welcome and version screens.
Basic browsing, queries, document editing and JSON/CSV transfers do not require MongoDB command-line tools. Install mongosh only for Shell, and MongoDB Database Tools for backup/restore. See tool configuration.
Launch your desktop build
Windows: open the supplied Palryn setup executable and follow the installer. It installs for the current user and can install the WebView2 runtime if needed. Start Palryn from its installed shortcut.
Linux: make the supplied AppImage executable, then launch it. Substitute your actual filename in this example:
chmod +x ./Palryn.AppImage
./Palryn.AppImage
On NixOS, launch the image using appimage-run ./Palryn.AppImage. Saved connections on Linux also need an available, unlocked desktop keychain service.
Native Linux packages
Choose DEB for the tested Debian 12 / Ubuntu 24.04 environments, or RPM for Fedora 44. These x86-64 packages use system GTK 3 and WebKitGTK 4.1 libraries and require glibc 2.36 or newer. Ubuntu 22.04 is not supported by these native builds. Other distributions and ARM64 have not yet been verified.
Run the command for your downloaded 0.7.0 package. The package manager resolves dependencies and installs a desktop-menu entry:
# Debian / Ubuntu
sudo apt install ./Palryn_0.7.0_amd64.deb
# Fedora
sudo dnf install ./Palryn-0.7.0-1.x86_64.rpm
Start Palryn from the application menu or run palryn as your normal desktop user. An available, unlocked Secret Service keychain is needed for saved credentials; GNOME Keyring is recommended by the package. Install mongosh, mongodump and mongorestore separately when you need those features.
Updating: close Palryn, download a newer package of the same format, and repeat the install command. DEB/RPM builds show package-manager instructions under the version button instead of offering an AppImage update. Installing a local package does not add a Palryn APT/DNF repository or enable automatic package updates. Initial native downloads have release checksums but no package GPG signature.
Remove with sudo apt remove palryn or sudo dnf remove palryn. User settings, theme files and saved connection data are retained. AppImage and native installs share the application identity; close one copy before starting another.
Review the welcome screen
On first launch, choose View Licence Agreement to read the bundled terms. Select the acceptance checkbox, then choose Accept & Continue to open Palryn. Connections and workspaces start only after acceptance; choose Exit to close instead.
Acceptance is remembered on this device for the exact terms, so a changed agreement requires acceptance again. You can read the agreement later through the version button in the status bar → View Licence Agreement.
1. Add a connection
- Open Manage connections. If you are already in a workspace, find it in the application menu at the top right.
- Choose Add, enter a recognizable profile name and paste your connection string into MongoDB URI.
- Choose Test details to check the unsaved details. A successful test does not save the profile.
- Choose Add connection, then connect or select the profile in the workspace selector.
For a MongoDB server running locally with no authentication, a connection string may look like:
mongodb://localhost:27017
For a hosted deployment, use the connection string supplied by your provider. See Connections for credentials, TLS, SRV and keychain details.
2. Open a collection
- In Explorer, expand a database to see its collections and views.
- Double-click a collection to open it. You can also focus it and press Enter, or right-click and choose Open.
- A query tab opens in the active editor group. Opening a tab does not execute a query.
If you cannot see a database, check your connection's permissions and the workspace visibility filters. Use the Explorer refresh icon to reload its list.
3. Run a query
Select Source in the filter editor and enter an empty filter to match every document:
{}
Choose a Page size, then choose Run query. You can also use Ctrl + Enter in the editor. Results appear in a table; expand a row to inspect its fields and nested values.
To narrow an example orders collection to pending orders:
{ status: "pending" }
Choose Run query again after changing the filter. The field must exist in your data for this example to match. If the collection is empty, a successful query can legitimately return no documents.
4. Explore the results
- Expand a document row, then expand objects or arrays to see nested values.
- Right-click a property to copy it, add a filter condition or define a relation where available.
- Use the column menus and drag column headers to arrange useful columns.
- Use the pager for another page, or Open to side from Explorer to compare another query.
Continue with Querying documents for dates, IDs, sort and projection, or Viewing & editing documents to change data.
5. Keep your setup
Settings → Workspace → Remember workspace state restores query drafts and layouts. Selecting a saved connection or workspace connects automatically; queries still require an explicit run. Database results and unsaved document changes are not restored after an application restart.