docs/Lix/Command-Reference/New-CLI/nix3-help-stores/index.html

5184 lines
104 KiB
HTML
Raw Permalink Normal View History

2024-07-24 19:14:02 +00:00
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="Aux Documentation">
<meta name="author" content="Nixpkgs Aux, and Lix Contributors">
<link rel="canonical" href="https://docs.auxolotl.org/Lix/Command-Reference/New-CLI/nix3-help-stores/">
<link rel="prev" href="../nix3-hash/">
<link rel="next" href="../nix3-help/">
<link rel="icon" href="../../../../assets/aux-logo.svg">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.29">
<title>nix help-stores - Aux Docs</title>
<link rel="stylesheet" href="../../../../assets/stylesheets/main.76a95c52.min.css">
<link rel="stylesheet" href="../../../../assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.bunny.net/css?family=IBM+Plex+Sans:300,300i,400,400i,700,700i%7CIBM+Plex+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"IBM Plex Sans";--md-code-font:"IBM Plex Mono"}</style>
<script>__md_scope=new URL("../../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<meta property="og:type" content="website" >
<meta property="og:title" content="`nix help-stores` - Aux Docs" >
<meta property="og:description" content="Aux Documentation" >
<meta property="og:image" content="https://docs.auxolotl.org/assets/images/social/Lix/Command-Reference/New-CLI/nix3-help-stores.png" >
<meta property="og:image:type" content="image/png" >
<meta property="og:image:width" content="1200" >
<meta property="og:image:height" content="630" >
<meta property="og:url" content="https://docs.auxolotl.org/Lix/Command-Reference/New-CLI/nix3-help-stores/" >
<meta name="twitter:card" content="summary_large_image" >
<meta name="twitter:title" content="`nix help-stores` - Aux Docs" >
<meta name="twitter:description" content="Aux Documentation" >
<meta name="twitter:image" content="https://docs.auxolotl.org/assets/images/social/Lix/Command-Reference/New-CLI/nix3-help-stores.png" >
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="blue">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#nix-help-stores" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../../../.." title="Aux Docs" class="md-header__button md-logo" aria-label="Aux Docs" data-md-component="logo">
<img src="../../../../assets/aux-logo.svg" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Aux Docs
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
nix help-stores
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="blue" aria-label="Dark Mode" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Dark Mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3 3.19.09m3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95 2.06.05m-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31Z"/></svg>
</label>
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="blue" aria-label="Light Mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Light Mode" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5c-.84 0-1.65.15-2.39.42L12 2M3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29L3.34 7m.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14L3.36 17M20.65 7l-1.77 3.79a7.023 7.023 0 0 0-2.38-4.15l4.15.36m-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29L20.64 17M12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44L12 22Z"/></svg>
</label>
</form>
<script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://git.auxolotl.org/auxolotl/docs" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M16.777 0a2.9 2.9 0 1 1-2.529 4.322H12.91a4.266 4.266 0 0 0-4.265 4.195v2.118a7.076 7.076 0 0 1 4.147-1.42l.118-.002h1.338a2.9 2.9 0 0 1 5.43 1.422 2.9 2.9 0 0 1-5.43 1.422H12.91a4.266 4.266 0 0 0-4.265 4.195v2.319A2.9 2.9 0 0 1 7.222 24 2.9 2.9 0 0 1 5.8 18.57V8.589a7.109 7.109 0 0 1 6.991-7.108l.118-.001h1.338A2.9 2.9 0 0 1 16.778 0ZM7.223 19.905a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Zm9.554-10.464a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.39Zm0-7.735a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Z"/></svg>
</div>
<div class="md-source__repository">
auxolotl/docs
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="../../../.." class="md-tabs__link">
Aux Documentation Hub
</a>
</li>
<li class="md-tabs__item">
<a href="../../../../TODO/" class="md-tabs__link">
TODO
</a>
</li>
<li class="md-tabs__item">
<a href="../../../../Aux/" class="md-tabs__link">
Aux
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="../../../" class="md-tabs__link">
Lix
</a>
</li>
<li class="md-tabs__item">
<a href="../../../../NixOS/appstream/" class="md-tabs__link">
NixOS
</a>
</li>
<li class="md-tabs__item">
<a href="../../../../Nixpkgs/" class="md-tabs__link">
Nixpkgs
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../../../.." title="Aux Docs" class="md-nav__button md-logo" aria-label="Aux Docs" data-md-component="logo">
<img src="../../../../assets/aux-logo.svg" alt="logo">
</a>
Aux Docs
</label>
<div class="md-nav__source">
<a href="https://git.auxolotl.org/auxolotl/docs" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M16.777 0a2.9 2.9 0 1 1-2.529 4.322H12.91a4.266 4.266 0 0 0-4.265 4.195v2.118a7.076 7.076 0 0 1 4.147-1.42l.118-.002h1.338a2.9 2.9 0 0 1 5.43 1.422 2.9 2.9 0 0 1-5.43 1.422H12.91a4.266 4.266 0 0 0-4.265 4.195v2.319A2.9 2.9 0 0 1 7.222 24 2.9 2.9 0 0 1 5.8 18.57V8.589a7.109 7.109 0 0 1 6.991-7.108l.118-.001h1.338A2.9 2.9 0 0 1 16.778 0ZM7.223 19.905a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Zm9.554-10.464a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.39Zm0-7.735a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Z"/></svg>
</div>
<div class="md-source__repository">
auxolotl/docs
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../.." class="md-nav__link">
<span class="md-ellipsis">
Aux Documentation Hub
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../../TODO/" class="md-nav__link">
<span class="md-ellipsis">
TODO
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../../../Aux/" class="md-nav__link">
<span class="md-ellipsis">
Aux
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
<div class="md-nav__link md-nav__container">
<a href="../../../" class="md-nav__link ">
<span class="md-ellipsis">
Lix
</span>
</a>
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Lix
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../glossary/" class="md-nav__link">
<span class="md-ellipsis">
Glossary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../quick-start/" class="md-nav__link">
<span class="md-ellipsis">
Quick Start
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../../Advanced-Topics/" class="md-nav__link">
<span class="md-ellipsis">
Advanced Topics
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_5" checked>
<div class="md-nav__link md-nav__container">
<a href="../../" class="md-nav__link ">
<span class="md-ellipsis">
Command Reference
</span>
</a>
<label class="md-nav__link " for="__nav_4_5" id="__nav_4_5_label" tabindex="0">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_5_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4_5">
<span class="md-nav__icon md-icon"></span>
Command Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../conf-file/" class="md-nav__link">
<span class="md-ellipsis">
nix.conf
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../env-common/" class="md-nav__link">
<span class="md-ellipsis">
Common Environment Variables
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../experimental-commands/" class="md-nav__link">
<span class="md-ellipsis">
Experimental Commands
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../main-commands/" class="md-nav__link">
<span class="md-ellipsis">
Main Commands
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../nix-build/" class="md-nav__link">
<span class="md-ellipsis">
nix-build
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../nix-channel/" class="md-nav__link">
<span class="md-ellipsis">
nix-channel
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../nix-collect-garbage/" class="md-nav__link">
<span class="md-ellipsis">
nix-collect-garbage
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../nix-copy-closure/" class="md-nav__link">
<span class="md-ellipsis">
nix-copy-closure
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../nix-daemon/" class="md-nav__link">
<span class="md-ellipsis">
nix-daemon
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../nix-hash/" class="md-nav__link">
<span class="md-ellipsis">
nix-hash
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../nix-instantiate/" class="md-nav__link">
<span class="md-ellipsis">
nix-instantiate
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../nix-prefetch-url/" class="md-nav__link">
<span class="md-ellipsis">
nix-prefetch-url
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../nix-shell/" class="md-nav__link">
<span class="md-ellipsis">
nix-shell
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../opt-common/" class="md-nav__link">
<span class="md-ellipsis">
Common Options
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../utilities/" class="md-nav__link">
<span class="md-ellipsis">
Utilities
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_5_17" checked>
<label class="md-nav__link" for="__nav_4_5_17" id="__nav_4_5_17_label" tabindex="0">
<span class="md-ellipsis">
New CLI
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="3" aria-labelledby="__nav_4_5_17_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4_5_17">
<span class="md-nav__icon md-icon"></span>
New CLI
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../nix/" class="md-nav__link">
<span class="md-ellipsis">
nix
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-build/" class="md-nav__link">
<span class="md-ellipsis">
nix build
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-bundle/" class="md-nav__link">
<span class="md-ellipsis">
nix bundle
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-config-show/" class="md-nav__link">
<span class="md-ellipsis">
nix config show
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-config/" class="md-nav__link">
<span class="md-ellipsis">
nix config
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-copy/" class="md-nav__link">
<span class="md-ellipsis">
nix copy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-daemon/" class="md-nav__link">
<span class="md-ellipsis">
nix daemon
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-derivation-add/" class="md-nav__link">
<span class="md-ellipsis">
nix derivation add
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-derivation-show/" class="md-nav__link">
<span class="md-ellipsis">
nix derivation show
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-derivation/" class="md-nav__link">
<span class="md-ellipsis">
nix derivation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-develop/" class="md-nav__link">
<span class="md-ellipsis">
nix develop
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-doctor/" class="md-nav__link">
<span class="md-ellipsis">
nix doctor
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-edit/" class="md-nav__link">
<span class="md-ellipsis">
nix edit
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-eval/" class="md-nav__link">
<span class="md-ellipsis">
nix eval
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-flake-archive/" class="md-nav__link">
<span class="md-ellipsis">
nix flake archive
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-flake-check/" class="md-nav__link">
<span class="md-ellipsis">
nix flake check
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-flake-clone/" class="md-nav__link">
<span class="md-ellipsis">
nix flake clone
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-flake-info/" class="md-nav__link">
<span class="md-ellipsis">
nix flake info
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-flake-init/" class="md-nav__link">
<span class="md-ellipsis">
nix flake init
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-flake-lock/" class="md-nav__link">
<span class="md-ellipsis">
nix flake lock
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-flake-metadata/" class="md-nav__link">
<span class="md-ellipsis">
nix flake metadata
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-flake-new/" class="md-nav__link">
<span class="md-ellipsis">
nix flake new
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-flake-prefetch/" class="md-nav__link">
<span class="md-ellipsis">
nix flake prefetch
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-flake-show/" class="md-nav__link">
<span class="md-ellipsis">
nix flake show
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-flake-update/" class="md-nav__link">
<span class="md-ellipsis">
nix flake update
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-flake/" class="md-nav__link">
<span class="md-ellipsis">
nix flake
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-fmt/" class="md-nav__link">
<span class="md-ellipsis">
nix fmt
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-hash-file/" class="md-nav__link">
<span class="md-ellipsis">
nix hash file
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-hash-path/" class="md-nav__link">
<span class="md-ellipsis">
nix hash path
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-hash-to-base16/" class="md-nav__link">
<span class="md-ellipsis">
nix hash to-base16
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-hash-to-base32/" class="md-nav__link">
<span class="md-ellipsis">
nix hash to-base32
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-hash-to-base64/" class="md-nav__link">
<span class="md-ellipsis">
nix hash to-base64
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-hash-to-sri/" class="md-nav__link">
<span class="md-ellipsis">
nix hash to-sri
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-hash/" class="md-nav__link">
<span class="md-ellipsis">
nix hash
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
nix help-stores
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
nix help-stores
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#synopsis" class="md-nav__link">
<span class="md-ellipsis">
Synopsis
</span>
</a>
<nav class="md-nav" aria-label="Synopsis">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#store-url-format" class="md-nav__link">
<span class="md-ellipsis">
Store URL format
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#dummy-store" class="md-nav__link">
<span class="md-ellipsis">
Dummy Store
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#experimental-ssh-store" class="md-nav__link">
<span class="md-ellipsis">
Experimental SSH Store
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#http-binary-cache-store" class="md-nav__link">
<span class="md-ellipsis">
HTTP Binary Cache Store
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#local-binary-cache-store" class="md-nav__link">
<span class="md-ellipsis">
Local Binary Cache Store
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#local-daemon-store" class="md-nav__link">
<span class="md-ellipsis">
Local Daemon Store
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#local-store" class="md-nav__link">
<span class="md-ellipsis">
Local Store
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#s3-binary-cache-store" class="md-nav__link">
<span class="md-ellipsis">
S3 Binary Cache Store
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#ssh-store" class="md-nav__link">
<span class="md-ellipsis">
SSH Store
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../nix3-help/" class="md-nav__link">
<span class="md-ellipsis">
nix help
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-key-convert-secret-to-public/" class="md-nav__link">
<span class="md-ellipsis">
nix key convert-secret-to-public
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-key-generate-secret/" class="md-nav__link">
<span class="md-ellipsis">
nix key generate-secret
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-key/" class="md-nav__link">
<span class="md-ellipsis">
nix key
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-log/" class="md-nav__link">
<span class="md-ellipsis">
nix log
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-nar-cat/" class="md-nav__link">
<span class="md-ellipsis">
nix nar cat
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-nar-dump-path/" class="md-nav__link">
<span class="md-ellipsis">
nix nar dump-path
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-nar-ls/" class="md-nav__link">
<span class="md-ellipsis">
nix nar ls
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-nar/" class="md-nav__link">
<span class="md-ellipsis">
nix nar
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-path-info/" class="md-nav__link">
<span class="md-ellipsis">
nix path-info
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-print-dev-env/" class="md-nav__link">
<span class="md-ellipsis">
nix print-dev-env
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-profile-diff-closures/" class="md-nav__link">
<span class="md-ellipsis">
nix profile diff-closures
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-profile-history/" class="md-nav__link">
<span class="md-ellipsis">
nix profile history
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-profile-install/" class="md-nav__link">
<span class="md-ellipsis">
nix profile install
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-profile-list/" class="md-nav__link">
<span class="md-ellipsis">
nix profile list
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-profile-remove/" class="md-nav__link">
<span class="md-ellipsis">
nix profile remove
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-profile-rollback/" class="md-nav__link">
<span class="md-ellipsis">
nix profile rollback
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-profile-upgrade/" class="md-nav__link">
<span class="md-ellipsis">
nix profile upgrade
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-profile-wipe-history/" class="md-nav__link">
<span class="md-ellipsis">
nix profile wipe-history
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-profile/" class="md-nav__link">
<span class="md-ellipsis">
nix profile
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-realisation-info/" class="md-nav__link">
<span class="md-ellipsis">
nix realisation info
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-realisation/" class="md-nav__link">
<span class="md-ellipsis">
nix realisation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-registry-add/" class="md-nav__link">
<span class="md-ellipsis">
nix registry add
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-registry-list/" class="md-nav__link">
<span class="md-ellipsis">
nix registry list
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-registry-pin/" class="md-nav__link">
<span class="md-ellipsis">
nix registry pin
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-registry-remove/" class="md-nav__link">
<span class="md-ellipsis">
nix registry remove
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-registry/" class="md-nav__link">
<span class="md-ellipsis">
nix registry
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-repl/" class="md-nav__link">
<span class="md-ellipsis">
nix repl
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-run/" class="md-nav__link">
<span class="md-ellipsis">
nix run
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-search/" class="md-nav__link">
<span class="md-ellipsis">
nix search
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-shell/" class="md-nav__link">
<span class="md-ellipsis">
nix shell
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-store-add-file/" class="md-nav__link">
<span class="md-ellipsis">
nix store add-file
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-store-add-path/" class="md-nav__link">
<span class="md-ellipsis">
nix store add-path
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-store-cat/" class="md-nav__link">
<span class="md-ellipsis">
nix store cat
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-store-copy-log/" class="md-nav__link">
<span class="md-ellipsis">
nix store copy-log
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-store-copy-sigs/" class="md-nav__link">
<span class="md-ellipsis">
nix store copy-sigs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-store-delete/" class="md-nav__link">
<span class="md-ellipsis">
nix store delete
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-store-diff-closures/" class="md-nav__link">
<span class="md-ellipsis">
nix store diff-closures
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-store-dump-path/" class="md-nav__link">
<span class="md-ellipsis">
nix store dump-path
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-store-gc/" class="md-nav__link">
<span class="md-ellipsis">
nix store gc
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-store-ls/" class="md-nav__link">
<span class="md-ellipsis">
nix store ls
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-store-make-content-addressed/" class="md-nav__link">
<span class="md-ellipsis">
nix store make-content-addressed
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-store-optimise/" class="md-nav__link">
<span class="md-ellipsis">
nix store optimise
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-store-path-from-hash-part/" class="md-nav__link">
<span class="md-ellipsis">
nix store path-from-hash-part
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-store-ping/" class="md-nav__link">
<span class="md-ellipsis">
nix store ping
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-store-prefetch-file/" class="md-nav__link">
<span class="md-ellipsis">
nix store prefetch-file
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-store-repair/" class="md-nav__link">
<span class="md-ellipsis">
nix store repair
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-store-sign/" class="md-nav__link">
<span class="md-ellipsis">
nix store sign
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-store-verify/" class="md-nav__link">
<span class="md-ellipsis">
nix store verify
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-store/" class="md-nav__link">
<span class="md-ellipsis">
nix store
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-upgrade-nix/" class="md-nav__link">
<span class="md-ellipsis">
nix upgrade-nix
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../nix3-why-depends/" class="md-nav__link">
<span class="md-ellipsis">
nix why-depends
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../files/" class="md-nav__link">
<span class="md-ellipsis">
Files
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../nix-env/" class="md-nav__link">
<span class="md-ellipsis">
Nix env
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../nix-store/" class="md-nav__link">
<span class="md-ellipsis">
Nix store
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../../Package-Management/" class="md-nav__link">
<span class="md-ellipsis">
Package Management
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../../architecture/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../../contributing/" class="md-nav__link">
<span class="md-ellipsis">
Contributing
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../../installation/" class="md-nav__link">
<span class="md-ellipsis">
Installation
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../../language/" class="md-nav__link">
<span class="md-ellipsis">
Language
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../../protocols/" class="md-nav__link">
<span class="md-ellipsis">
Protocols
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../../release-notes/" class="md-nav__link">
<span class="md-ellipsis">
Release notes
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../../../NixOS/appstream/" class="md-nav__link">
<span class="md-ellipsis">
NixOS
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../../../Nixpkgs/" class="md-nav__link">
<span class="md-ellipsis">
Nixpkgs
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#synopsis" class="md-nav__link">
<span class="md-ellipsis">
Synopsis
</span>
</a>
<nav class="md-nav" aria-label="Synopsis">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#store-url-format" class="md-nav__link">
<span class="md-ellipsis">
Store URL format
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#dummy-store" class="md-nav__link">
<span class="md-ellipsis">
Dummy Store
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#experimental-ssh-store" class="md-nav__link">
<span class="md-ellipsis">
Experimental SSH Store
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#http-binary-cache-store" class="md-nav__link">
<span class="md-ellipsis">
HTTP Binary Cache Store
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#local-binary-cache-store" class="md-nav__link">
<span class="md-ellipsis">
Local Binary Cache Store
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#local-daemon-store" class="md-nav__link">
<span class="md-ellipsis">
Local Daemon Store
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#local-store" class="md-nav__link">
<span class="md-ellipsis">
Local Store
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#s3-binary-cache-store" class="md-nav__link">
<span class="md-ellipsis">
S3 Binary Cache Store
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#ssh-store" class="md-nav__link">
<span class="md-ellipsis">
SSH Store
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="nix-help-stores"><code>nix help-stores</code></h1>
<p>Show help about store types and their settings.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
</div>
<blockquote>
<p>This program is
<a href="../../../contributing/experimental-features/#xp-feature-nix-command"><strong>experimental</strong></a>
and its interface is subject to change.</p>
</blockquote>
<h2 id="synopsis">Synopsis</h2>
<p><code>nix help-stores</code> [<em>option</em>...] </p>
<p>Lix supports different types of stores. These are described below.</p>
<h3 id="store-url-format">Store URL format</h3>
<p>Stores are specified using a URL-like syntax. For example, the command</p>
<div class="highlight"><pre><span></span><code><span class="gp">#</span><span class="c1"># nix path-info --store https://cache.nixos.org/ --json </span>
<span class="go"> /nix/store/a7gvj343m05j2s32xcnwr35v31ynlypr-coreutils-9.1</span>
</code></pre></div>
<p>fetches information about a store path in the HTTP binary cache
located at https://cache.nixos.org/, which is a type of store.</p>
<p>Store URLs can specify <strong>store settings</strong> using URL query strings,
i.e. by appending <code>?name1=value1&amp;name2=value2&amp;...</code> to the URL. For
instance,</p>
<div class="highlight"><pre><span></span><code>--store ssh://machine.example.org?ssh-key=/path/to/my/key
</code></pre></div>
<p>tells Lix to access the store on a remote machine via the SSH
protocol, using <code>/path/to/my/key</code> as the SSH private key. The
supported settings for each store type are documented below.</p>
<p>The special store URL <code>auto</code> causes Lix to automatically select a
store as follows:</p>
<ul>
<li>
<p>Use the <a href="#local-store">local store</a> <code>/nix/store</code> if <code>/nix/var/nix</code>
is writable by the current user.</p>
</li>
<li>
<p>Otherwise, if <code>/nix/var/nix/daemon-socket/socket</code> exists, <a href="#local-daemon-store">connect
to the Nix daemon listening on that socket</a>.</p>
</li>
<li>
<p>Otherwise, on Linux only, use the <a href="#local-store">local chroot store</a>
<code>~/.local/share/nix/root</code>, which will be created automatically if it
does not exist.</p>
</li>
<li>
<p>Otherwise, use the <a href="#local-store">local store</a> <code>/nix/store</code>.</p>
</li>
</ul>
<h3 id="dummy-store">Dummy Store</h3>
<p><strong>Store URL format</strong>: <code>dummy://</code></p>
<p>This store type represents a store that contains no store paths and
cannot be written to. It's useful when you want to use the Nix
evaluator when no actual Nix store exists, e.g.</p>
<div class="highlight"><pre><span></span><code><span class="gp">#</span><span class="c1"># nix eval --store dummy:// --expr &#39;1 + 2&#39;</span>
</code></pre></div>
<p><strong>Settings</strong>:</p>
<ul>
<li><span id="conf-path-info-cache-size"><a href="#conf-path-info-cache-size"><code>path-info-cache-size</code></a></span></li>
</ul>
<p>Size of the in-memory store path metadata cache.</p>
<p><strong>Default:</strong> <code>65536</code></p>
<ul>
<li><span id="conf-priority"><a href="#conf-priority"><code>priority</code></a></span></li>
</ul>
<p>Priority of this store when used as a substituter. A lower value means a higher priority.</p>
<p><strong>Default:</strong> <code>0</code></p>
<ul>
<li><span id="conf-store"><a href="#conf-store"><code>store</code></a></span></li>
</ul>
<p>Logical location of the Nix store, usually
<code>/nix/store</code>. Note that you can only copy store paths
between stores if they have the same <code>store</code> setting.</p>
<p><strong>Default:</strong> <code>/nix/store</code></p>
<ul>
<li><span id="conf-system-features"><a href="#conf-system-features"><code>system-features</code></a></span></li>
</ul>
<p>Optional features that the system this store builds on implements (like "kvm").</p>
<p><strong>Default:</strong> <em>machine-specific</em></p>
<ul>
<li><span id="conf-trusted"><a href="#conf-trusted"><code>trusted</code></a></span></li>
</ul>
<p>Whether paths from this store can be used as substitutes
even if they are not signed by a key listed in the
<a href="../../conf-file/#conf-trusted-public-keys"><code>trusted-public-keys</code></a>
setting.</p>
<p><strong>Default:</strong> <code>false</code></p>
<ul>
<li><span id="conf-want-mass-query"><a href="#conf-want-mass-query"><code>want-mass-query</code></a></span></li>
</ul>
<p>Whether this store (when used as a substituter) can be
queried efficiently for path validity.</p>
<p><strong>Default:</strong> <code>false</code></p>
<h3 id="experimental-ssh-store">Experimental SSH Store</h3>
<p><strong>Store URL format</strong>: <code>ssh-ng://[username@]hostname</code></p>
<p>Experimental store type that allows full access to a Nix store on a
remote machine.</p>
<p><strong>Settings</strong>:</p>
<ul>
<li><span id="conf-base64-ssh-public-host-key"><a href="#conf-base64-ssh-public-host-key"><code>base64-ssh-public-host-key</code></a></span></li>
</ul>
<p>The public host key of the remote machine.</p>
<p><strong>Default:</strong> <em>empty</em></p>
<ul>
<li><span id="conf-compress"><a href="#conf-compress"><code>compress</code></a></span></li>
</ul>
<p>Whether to enable SSH compression.</p>
<p><strong>Default:</strong> <code>false</code></p>
<ul>
<li><span id="conf-max-connection-age"><a href="#conf-max-connection-age"><code>max-connection-age</code></a></span></li>
</ul>
<p>Maximum age of a connection before it is closed.</p>
<p><strong>Default:</strong> <code>4294967295</code></p>
<ul>
<li><span id="conf-max-connections"><a href="#conf-max-connections"><code>max-connections</code></a></span></li>
</ul>
<p>Maximum number of concurrent connections to the Nix daemon.</p>
<p><strong>Default:</strong> <code>1</code></p>
<ul>
<li><span id="conf-path-info-cache-size"><a href="#conf-path-info-cache-size"><code>path-info-cache-size</code></a></span></li>
</ul>
<p>Size of the in-memory store path metadata cache.</p>
<p><strong>Default:</strong> <code>65536</code></p>
<ul>
<li><span id="conf-priority"><a href="#conf-priority"><code>priority</code></a></span></li>
</ul>
<p>Priority of this store when used as a substituter. A lower value means a higher priority.</p>
<p><strong>Default:</strong> <code>0</code></p>
<ul>
<li><span id="conf-remote-program"><a href="#conf-remote-program"><code>remote-program</code></a></span></li>
</ul>
<p>Path to the <code>nix-daemon</code> executable on the remote machine.</p>
<p><strong>Default:</strong> <code>nix-daemon</code></p>
<ul>
<li><span id="conf-remote-store"><a href="#conf-remote-store"><code>remote-store</code></a></span></li>
</ul>
<p><a href="./#store-url-format">Store URL</a>
to be used on the remote machine. The default is <code>auto</code>
(i.e. use the Nix daemon or <code>/nix/store</code> directly).</p>
<p><strong>Default:</strong> <em>empty</em></p>
<ul>
<li><span id="conf-ssh-key"><a href="#conf-ssh-key"><code>ssh-key</code></a></span></li>
</ul>
<p>Path to the SSH private key used to authenticate to the remote machine.</p>
<p><strong>Default:</strong> <em>empty</em></p>
<ul>
<li><span id="conf-store"><a href="#conf-store"><code>store</code></a></span></li>
</ul>
<p>Logical location of the Nix store, usually
<code>/nix/store</code>. Note that you can only copy store paths
between stores if they have the same <code>store</code> setting.</p>
<p><strong>Default:</strong> <code>/nix/store</code></p>
<ul>
<li><span id="conf-system-features"><a href="#conf-system-features"><code>system-features</code></a></span></li>
</ul>
<p>Optional features that the system this store builds on implements (like "kvm").</p>
<p><strong>Default:</strong> <em>machine-specific</em></p>
<ul>
<li><span id="conf-trusted"><a href="#conf-trusted"><code>trusted</code></a></span></li>
</ul>
<p>Whether paths from this store can be used as substitutes
even if they are not signed by a key listed in the
<a href="../../conf-file/#conf-trusted-public-keys"><code>trusted-public-keys</code></a>
setting.</p>
<p><strong>Default:</strong> <code>false</code></p>
<ul>
<li><span id="conf-want-mass-query"><a href="#conf-want-mass-query"><code>want-mass-query</code></a></span></li>
</ul>
<p>Whether this store (when used as a substituter) can be
queried efficiently for path validity.</p>
<p><strong>Default:</strong> <code>false</code></p>
<h3 id="http-binary-cache-store">HTTP Binary Cache Store</h3>
<p><strong>Store URL format</strong>: <code>http://...</code>, <code>https://...</code></p>
<p>This store allows a binary cache to be accessed via the HTTP
protocol.</p>
<p><strong>Settings</strong>:</p>
<ul>
<li><span id="conf-compression"><a href="#conf-compression"><code>compression</code></a></span></li>
</ul>
<p>NAR compression method (<code>xz</code>, <code>bzip2</code>, <code>gzip</code>, <code>zstd</code>, or <code>none</code>).</p>
<p><strong>Default:</strong> <code>xz</code></p>
<ul>
<li><span id="conf-compression-level"><a href="#conf-compression-level"><code>compression-level</code></a></span></li>
</ul>
<p>The <em>preset level</em> to be used when compressing NARs.
The meaning and accepted values depend on the compression method selected.
<code>-1</code> specifies that the default compression level should be used.</p>
<p><strong>Default:</strong> <code>-1</code></p>
<ul>
<li><span id="conf-index-debug-info"><a href="#conf-index-debug-info"><code>index-debug-info</code></a></span></li>
</ul>
<p>Whether to index DWARF debug info files by build ID. This allows <a href="https://github.com/edolstra/dwarffs"><code>dwarffs</code></a> to
fetch debug info on demand</p>
<p><strong>Default:</strong> <code>false</code></p>
<ul>
<li><span id="conf-local-nar-cache"><a href="#conf-local-nar-cache"><code>local-nar-cache</code></a></span></li>
</ul>
<p>Path to a local cache of NARs fetched from this binary cache, used by commands such as <code>nix store cat</code>.</p>
<p><strong>Default:</strong> <em>empty</em></p>
<ul>
<li><span id="conf-parallel-compression"><a href="#conf-parallel-compression"><code>parallel-compression</code></a></span></li>
</ul>
<p>Enable multi-threaded compression of NARs. This is currently only available for <code>xz</code> and <code>zstd</code>.</p>
<p><strong>Default:</strong> <code>false</code></p>
<ul>
<li><span id="conf-path-info-cache-size"><a href="#conf-path-info-cache-size"><code>path-info-cache-size</code></a></span></li>
</ul>
<p>Size of the in-memory store path metadata cache.</p>
<p><strong>Default:</strong> <code>65536</code></p>
<ul>
<li><span id="conf-priority"><a href="#conf-priority"><code>priority</code></a></span></li>
</ul>
<p>Priority of this store when used as a substituter. A lower value means a higher priority.</p>
<p><strong>Default:</strong> <code>0</code></p>
<ul>
<li><span id="conf-secret-key"><a href="#conf-secret-key"><code>secret-key</code></a></span></li>
</ul>
<p>Path to the secret key used to sign the binary cache.</p>
<p><strong>Default:</strong> <em>empty</em></p>
<ul>
<li><span id="conf-store"><a href="#conf-store"><code>store</code></a></span></li>
</ul>
<p>Logical location of the Nix store, usually
<code>/nix/store</code>. Note that you can only copy store paths
between stores if they have the same <code>store</code> setting.</p>
<p><strong>Default:</strong> <code>/nix/store</code></p>
<ul>
<li><span id="conf-system-features"><a href="#conf-system-features"><code>system-features</code></a></span></li>
</ul>
<p>Optional features that the system this store builds on implements (like "kvm").</p>
<p><strong>Default:</strong> <em>machine-specific</em></p>
<ul>
<li><span id="conf-trusted"><a href="#conf-trusted"><code>trusted</code></a></span></li>
</ul>
<p>Whether paths from this store can be used as substitutes
even if they are not signed by a key listed in the
<a href="../../conf-file/#conf-trusted-public-keys"><code>trusted-public-keys</code></a>
setting.</p>
<p><strong>Default:</strong> <code>false</code></p>
<ul>
<li><span id="conf-want-mass-query"><a href="#conf-want-mass-query"><code>want-mass-query</code></a></span></li>
</ul>
<p>Whether this store (when used as a substituter) can be
queried efficiently for path validity.</p>
<p><strong>Default:</strong> <code>false</code></p>
<ul>
<li><span id="conf-write-nar-listing"><a href="#conf-write-nar-listing"><code>write-nar-listing</code></a></span></li>
</ul>
<p>Whether to write a JSON file that lists the files in each NAR.</p>
<p><strong>Default:</strong> <code>false</code></p>
<h3 id="local-binary-cache-store">Local Binary Cache Store</h3>
<p><strong>Store URL format</strong>: <code>file://</code><em>path</em></p>
<p>This store allows reading and writing a binary cache stored in <em>path</em>
in the local filesystem. If <em>path</em> does not exist, it will be created.</p>
<p>For example, the following builds or downloads <code>nixpkgs#hello</code> into
the local store and then copies it to the binary cache in
<code>/tmp/binary-cache</code>:</p>
<div class="highlight"><pre><span></span><code>## nix copy --to file:///tmp/binary-cache nixpkgs#hello
</code></pre></div>
<p><strong>Settings</strong>:</p>
<ul>
<li><span id="conf-compression"><a href="#conf-compression"><code>compression</code></a></span></li>
</ul>
<p>NAR compression method (<code>xz</code>, <code>bzip2</code>, <code>gzip</code>, <code>zstd</code>, or <code>none</code>).</p>
<p><strong>Default:</strong> <code>xz</code></p>
<ul>
<li><span id="conf-compression-level"><a href="#conf-compression-level"><code>compression-level</code></a></span></li>
</ul>
<p>The <em>preset level</em> to be used when compressing NARs.
The meaning and accepted values depend on the compression method selected.
<code>-1</code> specifies that the default compression level should be used.</p>
<p><strong>Default:</strong> <code>-1</code></p>
<ul>
<li><span id="conf-index-debug-info"><a href="#conf-index-debug-info"><code>index-debug-info</code></a></span></li>
</ul>
<p>Whether to index DWARF debug info files by build ID. This allows <a href="https://github.com/edolstra/dwarffs"><code>dwarffs</code></a> to
fetch debug info on demand</p>
<p><strong>Default:</strong> <code>false</code></p>
<ul>
<li><span id="conf-local-nar-cache"><a href="#conf-local-nar-cache"><code>local-nar-cache</code></a></span></li>
</ul>
<p>Path to a local cache of NARs fetched from this binary cache, used by commands such as <code>nix store cat</code>.</p>
<p><strong>Default:</strong> <em>empty</em></p>
<ul>
<li><span id="conf-parallel-compression"><a href="#conf-parallel-compression"><code>parallel-compression</code></a></span></li>
</ul>
<p>Enable multi-threaded compression of NARs. This is currently only available for <code>xz</code> and <code>zstd</code>.</p>
<p><strong>Default:</strong> <code>false</code></p>
<ul>
<li><span id="conf-path-info-cache-size"><a href="#conf-path-info-cache-size"><code>path-info-cache-size</code></a></span></li>
</ul>
<p>Size of the in-memory store path metadata cache.</p>
<p><strong>Default:</strong> <code>65536</code></p>
<ul>
<li><span id="conf-priority"><a href="#conf-priority"><code>priority</code></a></span></li>
</ul>
<p>Priority of this store when used as a substituter. A lower value means a higher priority.</p>
<p><strong>Default:</strong> <code>0</code></p>
<ul>
<li><span id="conf-secret-key"><a href="#conf-secret-key"><code>secret-key</code></a></span></li>
</ul>
<p>Path to the secret key used to sign the binary cache.</p>
<p><strong>Default:</strong> <em>empty</em></p>
<ul>
<li><span id="conf-store"><a href="#conf-store"><code>store</code></a></span></li>
</ul>
<p>Logical location of the Nix store, usually
<code>/nix/store</code>. Note that you can only copy store paths
between stores if they have the same <code>store</code> setting.</p>
<p><strong>Default:</strong> <code>/nix/store</code></p>
<ul>
<li><span id="conf-system-features"><a href="#conf-system-features"><code>system-features</code></a></span></li>
</ul>
<p>Optional features that the system this store builds on implements (like "kvm").</p>
<p><strong>Default:</strong> <em>machine-specific</em></p>
<ul>
<li><span id="conf-trusted"><a href="#conf-trusted"><code>trusted</code></a></span></li>
</ul>
<p>Whether paths from this store can be used as substitutes
even if they are not signed by a key listed in the
<a href="../../conf-file/#conf-trusted-public-keys"><code>trusted-public-keys</code></a>
setting.</p>
<p><strong>Default:</strong> <code>false</code></p>
<ul>
<li><span id="conf-want-mass-query"><a href="#conf-want-mass-query"><code>want-mass-query</code></a></span></li>
</ul>
<p>Whether this store (when used as a substituter) can be
queried efficiently for path validity.</p>
<p><strong>Default:</strong> <code>false</code></p>
<ul>
<li><span id="conf-write-nar-listing"><a href="#conf-write-nar-listing"><code>write-nar-listing</code></a></span></li>
</ul>
<p>Whether to write a JSON file that lists the files in each NAR.</p>
<p><strong>Default:</strong> <code>false</code></p>
<h3 id="local-daemon-store">Local Daemon Store</h3>
<p><strong>Store URL format</strong>: <code>daemon</code>, <code>unix://</code><em>path</em></p>
<p>This store type accesses a Nix store by talking to a Nix daemon
listening on the Unix domain socket <em>path</em>. The store pseudo-URL
<code>daemon</code> is equivalent to <code>unix:///nix/var/nix/daemon-socket/socket</code>.</p>
<p><strong>Settings</strong>:</p>
<ul>
<li><span id="conf-log"><a href="#conf-log"><code>log</code></a></span></li>
</ul>
<p>directory where Lix will store log files.</p>
<p><strong>Default:</strong> <code>/nix/var/log/nix</code></p>
<ul>
<li><span id="conf-max-connection-age"><a href="#conf-max-connection-age"><code>max-connection-age</code></a></span></li>
</ul>
<p>Maximum age of a connection before it is closed.</p>
<p><strong>Default:</strong> <code>4294967295</code></p>
<ul>
<li><span id="conf-max-connections"><a href="#conf-max-connections"><code>max-connections</code></a></span></li>
</ul>
<p>Maximum number of concurrent connections to the Nix daemon.</p>
<p><strong>Default:</strong> <code>1</code></p>
<ul>
<li><span id="conf-path-info-cache-size"><a href="#conf-path-info-cache-size"><code>path-info-cache-size</code></a></span></li>
</ul>
<p>Size of the in-memory store path metadata cache.</p>
<p><strong>Default:</strong> <code>65536</code></p>
<ul>
<li><span id="conf-priority"><a href="#conf-priority"><code>priority</code></a></span></li>
</ul>
<p>Priority of this store when used as a substituter. A lower value means a higher priority.</p>
<p><strong>Default:</strong> <code>0</code></p>
<ul>
<li><span id="conf-real"><a href="#conf-real"><code>real</code></a></span></li>
</ul>
<p>Physical path of the Nix store.</p>
<p><strong>Default:</strong> <code>/nix/store</code></p>
<ul>
<li><span id="conf-root"><a href="#conf-root"><code>root</code></a></span></li>
</ul>
<p>Directory prefixed to all other paths.</p>
<p><strong>Default:</strong> ``</p>
<ul>
<li><span id="conf-state"><a href="#conf-state"><code>state</code></a></span></li>
</ul>
<p>Directory where Lix will store state.</p>
<p><strong>Default:</strong> <code>/dummy</code></p>
<ul>
<li><span id="conf-store"><a href="#conf-store"><code>store</code></a></span></li>
</ul>
<p>Logical location of the Nix store, usually
<code>/nix/store</code>. Note that you can only copy store paths
between stores if they have the same <code>store</code> setting.</p>
<p><strong>Default:</strong> <code>/nix/store</code></p>
<ul>
<li><span id="conf-system-features"><a href="#conf-system-features"><code>system-features</code></a></span></li>
</ul>
<p>Optional features that the system this store builds on implements (like "kvm").</p>
<p><strong>Default:</strong> <em>machine-specific</em></p>
<ul>
<li><span id="conf-trusted"><a href="#conf-trusted"><code>trusted</code></a></span></li>
</ul>
<p>Whether paths from this store can be used as substitutes
even if they are not signed by a key listed in the
<a href="../../conf-file/#conf-trusted-public-keys"><code>trusted-public-keys</code></a>
setting.</p>
<p><strong>Default:</strong> <code>false</code></p>
<ul>
<li><span id="conf-want-mass-query"><a href="#conf-want-mass-query"><code>want-mass-query</code></a></span></li>
</ul>
<p>Whether this store (when used as a substituter) can be
queried efficiently for path validity.</p>
<p><strong>Default:</strong> <code>false</code></p>
<h3 id="local-store">Local Store</h3>
<p><strong>Store URL format</strong>: <code>local</code>, <em>root</em></p>
<p>This store type accesses a Nix store in the local filesystem directly
(i.e. not via the Nix daemon). <em>root</em> is an absolute path that is
prefixed to other directories such as the Nix store directory. The
store pseudo-URL <code>local</code> denotes a store that uses <code>/</code> as its root
directory.</p>
<p>A store that uses a <em>root</em> other than <code>/</code> is called a <em>chroot
store</em>. With such stores, the store directory is "logically" still
<code>/nix/store</code>, so programs stored in them can only be built and
executed by <code>chroot</code>-ing into <em>root</em>. Chroot stores only support
building and running on Linux when <a href="https://man7.org/linux/man-pages/man7/mount_namespaces.7.html"><code>mount namespaces</code></a> and <a href="https://man7.org/linux/man-pages/man7/user_namespaces.7.html"><code>user namespaces</code></a> are
enabled.</p>
<p>For example, the following uses <code>/tmp/root</code> as the chroot environment
to build or download <code>nixpkgs#hello</code> and then execute it:</p>
<div class="highlight"><pre><span></span><code><span class="gp">#</span><span class="c1"># nix run --store /tmp/root nixpkgs#hello</span>
<span class="go">Hello, world!</span>
</code></pre></div>
<p>Here, the "physical" store location is <code>/tmp/root/nix/store</code>, and
Nix's store metadata is in <code>/tmp/root/nix/var/nix/db</code>.</p>
<p>It is also possible, but not recommended, to change the "logical"
location of the Nix store from its default of <code>/nix/store</code>. This makes
it impossible to use default substituters such as
<code>https://cache.nixos.org/</code>, and thus you may have to build everything
locally. Here is an example:</p>
<div class="highlight"><pre><span></span><code><span class="gp">#</span><span class="c1"># nix build --store &#39;local?store=/tmp/my-nix/store&amp;state=/tmp/my-nix/state&amp;log=/tmp/my-nix/log&#39; nixpkgs#hello</span>
</code></pre></div>
<p><strong>Settings</strong>:</p>
<ul>
<li><span id="conf-log"><a href="#conf-log"><code>log</code></a></span></li>
</ul>
<p>directory where Lix will store log files.</p>
<p><strong>Default:</strong> <code>/nix/var/log/nix</code></p>
<ul>
<li><span id="conf-path-info-cache-size"><a href="#conf-path-info-cache-size"><code>path-info-cache-size</code></a></span></li>
</ul>
<p>Size of the in-memory store path metadata cache.</p>
<p><strong>Default:</strong> <code>65536</code></p>
<ul>
<li><span id="conf-priority"><a href="#conf-priority"><code>priority</code></a></span></li>
</ul>
<p>Priority of this store when used as a substituter. A lower value means a higher priority.</p>
<p><strong>Default:</strong> <code>0</code></p>
<ul>
<li><span id="conf-read-only"><a href="#conf-read-only"><code>read-only</code></a></span></li>
</ul>
<p>Allow this store to be opened when its <a href="../../../glossary/#gloss-nix-database">database</a> is on a read-only filesystem.</p>
<p>Normally Lix will attempt to open the store database in read-write mode, even for querying (when write access is not needed), causing it to fail if the database is on a read-only filesystem.</p>
<p>Enable read-only mode to disable locking and open the SQLite database with the <a href="https://www.sqlite.org/c3ref/open.html"><code>immutable</code> parameter</a> set.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Do not use this unless the filesystem is read-only.</p>
<p>Using it when the filesystem is writable can cause incorrect query results or corruption errors if the database is changed by another process.
While the filesystem the database resides on might appear to be read-only, consider whether another user or system might have write access to it.</p>
</div>
<p><strong>Default:</strong> <code>false</code></p>
<ul>
<li><span id="conf-real"><a href="#conf-real"><code>real</code></a></span></li>
</ul>
<p>Physical path of the Nix store.</p>
<p><strong>Default:</strong> <code>/nix/store</code></p>
<ul>
<li><span id="conf-require-sigs"><a href="#conf-require-sigs"><code>require-sigs</code></a></span></li>
</ul>
<p>Whether store paths copied into this store should have a trusted signature.</p>
<p><strong>Default:</strong> <code>true</code></p>
<ul>
<li><span id="conf-root"><a href="#conf-root"><code>root</code></a></span></li>
</ul>
<p>Directory prefixed to all other paths.</p>
<p><strong>Default:</strong> ``</p>
<ul>
<li><span id="conf-state"><a href="#conf-state"><code>state</code></a></span></li>
</ul>
<p>Directory where Lix will store state.</p>
<p><strong>Default:</strong> <code>/dummy</code></p>
<ul>
<li><span id="conf-store"><a href="#conf-store"><code>store</code></a></span></li>
</ul>
<p>Logical location of the Nix store, usually
<code>/nix/store</code>. Note that you can only copy store paths
between stores if they have the same <code>store</code> setting.</p>
<p><strong>Default:</strong> <code>/nix/store</code></p>
<ul>
<li><span id="conf-system-features"><a href="#conf-system-features"><code>system-features</code></a></span></li>
</ul>
<p>Optional features that the system this store builds on implements (like "kvm").</p>
<p><strong>Default:</strong> <em>machine-specific</em></p>
<ul>
<li><span id="conf-trusted"><a href="#conf-trusted"><code>trusted</code></a></span></li>
</ul>
<p>Whether paths from this store can be used as substitutes
even if they are not signed by a key listed in the
<a href="../../conf-file/#conf-trusted-public-keys"><code>trusted-public-keys</code></a>
setting.</p>
<p><strong>Default:</strong> <code>false</code></p>
<ul>
<li><span id="conf-want-mass-query"><a href="#conf-want-mass-query"><code>want-mass-query</code></a></span></li>
</ul>
<p>Whether this store (when used as a substituter) can be
queried efficiently for path validity.</p>
<p><strong>Default:</strong> <code>false</code></p>
<h3 id="s3-binary-cache-store">S3 Binary Cache Store</h3>
<p><strong>Store URL format</strong>: <code>s3://</code><em>bucket-name</em></p>
<p>This store allows reading and writing a binary cache stored in an AWS
S3 bucket.</p>
<p><strong>Settings</strong>:</p>
<ul>
<li><span id="conf-buffer-size"><a href="#conf-buffer-size"><code>buffer-size</code></a></span></li>
</ul>
<p>Size (in bytes) of each part in multi-part uploads.</p>
<p><strong>Default:</strong> <code>5242880</code></p>
<ul>
<li><span id="conf-compression"><a href="#conf-compression"><code>compression</code></a></span></li>
</ul>
<p>NAR compression method (<code>xz</code>, <code>bzip2</code>, <code>gzip</code>, <code>zstd</code>, or <code>none</code>).</p>
<p><strong>Default:</strong> <code>xz</code></p>
<ul>
<li><span id="conf-compression-level"><a href="#conf-compression-level"><code>compression-level</code></a></span></li>
</ul>
<p>The <em>preset level</em> to be used when compressing NARs.
The meaning and accepted values depend on the compression method selected.
<code>-1</code> specifies that the default compression level should be used.</p>
<p><strong>Default:</strong> <code>-1</code></p>
<ul>
<li><span id="conf-endpoint"><a href="#conf-endpoint"><code>endpoint</code></a></span></li>
</ul>
<p>The URL of the endpoint of an S3-compatible service such as MinIO.
Do not specify this setting if you're using Amazon S3.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
</div>
<blockquote>
<p>This endpoint must support HTTPS and will use path-based
addressing instead of virtual host based addressing.</p>
</blockquote>
<p><strong>Default:</strong> <em>empty</em></p>
<ul>
<li><span id="conf-index-debug-info"><a href="#conf-index-debug-info"><code>index-debug-info</code></a></span></li>
</ul>
<p>Whether to index DWARF debug info files by build ID. This allows <a href="https://github.com/edolstra/dwarffs"><code>dwarffs</code></a> to
fetch debug info on demand</p>
<p><strong>Default:</strong> <code>false</code></p>
<ul>
<li><span id="conf-local-nar-cache"><a href="#conf-local-nar-cache"><code>local-nar-cache</code></a></span></li>
</ul>
<p>Path to a local cache of NARs fetched from this binary cache, used by commands such as <code>nix store cat</code>.</p>
<p><strong>Default:</strong> <em>empty</em></p>
<ul>
<li><span id="conf-log-compression"><a href="#conf-log-compression"><code>log-compression</code></a></span></li>
</ul>
<p>Compression method for <code>log/*</code> files. It is recommended to
use a compression method supported by most web browsers
(e.g. <code>brotli</code>).</p>
<p><strong>Default:</strong> <em>empty</em></p>
<ul>
<li><span id="conf-ls-compression"><a href="#conf-ls-compression"><code>ls-compression</code></a></span></li>
</ul>
<p>Compression method for <code>.ls</code> files.</p>
<p><strong>Default:</strong> <em>empty</em></p>
<ul>
<li><span id="conf-multipart-upload"><a href="#conf-multipart-upload"><code>multipart-upload</code></a></span></li>
</ul>
<p>Whether to use multi-part uploads.</p>
<p><strong>Default:</strong> <code>false</code></p>
<ul>
<li><span id="conf-narinfo-compression"><a href="#conf-narinfo-compression"><code>narinfo-compression</code></a></span></li>
</ul>
<p>Compression method for <code>.narinfo</code> files.</p>
<p><strong>Default:</strong> <em>empty</em></p>
<ul>
<li><span id="conf-parallel-compression"><a href="#conf-parallel-compression"><code>parallel-compression</code></a></span></li>
</ul>
<p>Enable multi-threaded compression of NARs. This is currently only available for <code>xz</code> and <code>zstd</code>.</p>
<p><strong>Default:</strong> <code>false</code></p>
<ul>
<li><span id="conf-path-info-cache-size"><a href="#conf-path-info-cache-size"><code>path-info-cache-size</code></a></span></li>
</ul>
<p>Size of the in-memory store path metadata cache.</p>
<p><strong>Default:</strong> <code>65536</code></p>
<ul>
<li><span id="conf-priority"><a href="#conf-priority"><code>priority</code></a></span></li>
</ul>
<p>Priority of this store when used as a substituter. A lower value means a higher priority.</p>
<p><strong>Default:</strong> <code>0</code></p>
<ul>
<li><span id="conf-profile"><a href="#conf-profile"><code>profile</code></a></span></li>
</ul>
<p>The name of the AWS configuration profile to use. By default
Lix will use the <code>default</code> profile.</p>
<p><strong>Default:</strong> <em>empty</em></p>
<ul>
<li><span id="conf-region"><a href="#conf-region"><code>region</code></a></span></li>
</ul>
<p>The region of the S3 bucket. If your bucket is not in
<code>useast-1</code>, you should always explicitly specify the region
parameter.</p>
<p><strong>Default:</strong> <code>us-east-1</code></p>
<ul>
<li><span id="conf-scheme"><a href="#conf-scheme"><code>scheme</code></a></span></li>
</ul>
<p>The scheme used for S3 requests, <code>https</code> (default) or <code>http</code>. This
option allows you to disable HTTPS for binary caches which don't
support it.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
</div>
<blockquote>
<p>HTTPS should be used if the cache might contain sensitive
information.</p>
</blockquote>
<p><strong>Default:</strong> <em>empty</em></p>
<ul>
<li><span id="conf-secret-key"><a href="#conf-secret-key"><code>secret-key</code></a></span></li>
</ul>
<p>Path to the secret key used to sign the binary cache.</p>
<p><strong>Default:</strong> <em>empty</em></p>
<ul>
<li><span id="conf-store"><a href="#conf-store"><code>store</code></a></span></li>
</ul>
<p>Logical location of the Nix store, usually
<code>/nix/store</code>. Note that you can only copy store paths
between stores if they have the same <code>store</code> setting.</p>
<p><strong>Default:</strong> <code>/nix/store</code></p>
<ul>
<li><span id="conf-system-features"><a href="#conf-system-features"><code>system-features</code></a></span></li>
</ul>
<p>Optional features that the system this store builds on implements (like "kvm").</p>
<p><strong>Default:</strong> <em>machine-specific</em></p>
<ul>
<li><span id="conf-trusted"><a href="#conf-trusted"><code>trusted</code></a></span></li>
</ul>
<p>Whether paths from this store can be used as substitutes
even if they are not signed by a key listed in the
<a href="../../conf-file/#conf-trusted-public-keys"><code>trusted-public-keys</code></a>
setting.</p>
<p><strong>Default:</strong> <code>false</code></p>
<ul>
<li><span id="conf-want-mass-query"><a href="#conf-want-mass-query"><code>want-mass-query</code></a></span></li>
</ul>
<p>Whether this store (when used as a substituter) can be
queried efficiently for path validity.</p>
<p><strong>Default:</strong> <code>false</code></p>
<ul>
<li><span id="conf-write-nar-listing"><a href="#conf-write-nar-listing"><code>write-nar-listing</code></a></span></li>
</ul>
<p>Whether to write a JSON file that lists the files in each NAR.</p>
<p><strong>Default:</strong> <code>false</code></p>
<h3 id="ssh-store">SSH Store</h3>
<p><strong>Store URL format</strong>: <code>ssh://[username@]hostname</code></p>
<p>This store type allows limited access to a remote store on another
machine via SSH.</p>
<p><strong>Settings</strong>:</p>
<ul>
<li><span id="conf-base64-ssh-public-host-key"><a href="#conf-base64-ssh-public-host-key"><code>base64-ssh-public-host-key</code></a></span></li>
</ul>
<p>The public host key of the remote machine.</p>
<p><strong>Default:</strong> <em>empty</em></p>
<ul>
<li><span id="conf-compress"><a href="#conf-compress"><code>compress</code></a></span></li>
</ul>
<p>Whether to enable SSH compression.</p>
<p><strong>Default:</strong> <code>false</code></p>
<ul>
<li><span id="conf-max-connections"><a href="#conf-max-connections"><code>max-connections</code></a></span></li>
</ul>
<p>Maximum number of concurrent SSH connections.</p>
<p><strong>Default:</strong> <code>1</code></p>
<ul>
<li><span id="conf-path-info-cache-size"><a href="#conf-path-info-cache-size"><code>path-info-cache-size</code></a></span></li>
</ul>
<p>Size of the in-memory store path metadata cache.</p>
<p><strong>Default:</strong> <code>65536</code></p>
<ul>
<li><span id="conf-priority"><a href="#conf-priority"><code>priority</code></a></span></li>
</ul>
<p>Priority of this store when used as a substituter. A lower value means a higher priority.</p>
<p><strong>Default:</strong> <code>0</code></p>
<ul>
<li><span id="conf-remote-program"><a href="#conf-remote-program"><code>remote-program</code></a></span></li>
</ul>
<p>Path to the <code>nix-store</code> executable on the remote machine.</p>
<p><strong>Default:</strong> <code>nix-store</code></p>
<ul>
<li><span id="conf-remote-store"><a href="#conf-remote-store"><code>remote-store</code></a></span></li>
</ul>
<p><a href="./#store-url-format">Store URL</a>
to be used on the remote machine. The default is <code>auto</code>
(i.e. use the Nix daemon or <code>/nix/store</code> directly).</p>
<p><strong>Default:</strong> <em>empty</em></p>
<ul>
<li><span id="conf-ssh-key"><a href="#conf-ssh-key"><code>ssh-key</code></a></span></li>
</ul>
<p>Path to the SSH private key used to authenticate to the remote machine.</p>
<p><strong>Default:</strong> <em>empty</em></p>
<ul>
<li><span id="conf-store"><a href="#conf-store"><code>store</code></a></span></li>
</ul>
<p>Logical location of the Nix store, usually
<code>/nix/store</code>. Note that you can only copy store paths
between stores if they have the same <code>store</code> setting.</p>
<p><strong>Default:</strong> <code>/nix/store</code></p>
<ul>
<li><span id="conf-system-features"><a href="#conf-system-features"><code>system-features</code></a></span></li>
</ul>
<p>Optional features that the system this store builds on implements (like "kvm").</p>
<p><strong>Default:</strong> <em>machine-specific</em></p>
<ul>
<li><span id="conf-trusted"><a href="#conf-trusted"><code>trusted</code></a></span></li>
</ul>
<p>Whether paths from this store can be used as substitutes
even if they are not signed by a key listed in the
<a href="../../conf-file/#conf-trusted-public-keys"><code>trusted-public-keys</code></a>
setting.</p>
<p><strong>Default:</strong> <code>false</code></p>
<ul>
<li><span id="conf-want-mass-query"><a href="#conf-want-mass-query"><code>want-mass-query</code></a></span></li>
</ul>
<p>Whether this store (when used as a substituter) can be
queried efficiently for path validity.</p>
<p><strong>Default:</strong> <code>false</code></p>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
<div class="md-copyright__highlight">
Licenced MIT
</div>
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
<div class="md-social">
<a href="https://git.auxolotl.org/auxolotl/docs" target="_blank" rel="noopener" title="Aux Docs Repo" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M16.777 0a2.9 2.9 0 1 1-2.529 4.322H12.91a4.266 4.266 0 0 0-4.265 4.195v2.118a7.076 7.076 0 0 1 4.147-1.42l.118-.002h1.338a2.9 2.9 0 0 1 5.43 1.422 2.9 2.9 0 0 1-5.43 1.422H12.91a4.266 4.266 0 0 0-4.265 4.195v2.319A2.9 2.9 0 0 1 7.222 24 2.9 2.9 0 0 1 5.8 18.57V8.589a7.109 7.109 0 0 1 6.991-7.108l.118-.001h1.338A2.9 2.9 0 0 1 16.778 0ZM7.223 19.905a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Zm9.554-10.464a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.39Zm0-7.735a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Z"/></svg>
</a>
<a href="https://forum.aux.computer/" target="_blank" rel="noopener" title="Aux Forum" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12.103 0C18.666 0 24 5.485 24 11.997c0 6.51-5.33 11.99-11.9 11.99L0 24V11.79C0 5.28 5.532 0 12.103 0zm.116 4.563a7.395 7.395 0 0 0-6.337 3.57 7.247 7.247 0 0 0-.148 7.22L4.4 19.61l4.794-1.074a7.424 7.424 0 0 0 8.136-1.39 7.256 7.256 0 0 0 1.737-7.997 7.375 7.375 0 0 0-6.84-4.585h-.008z"/></svg>
</a>
<a href="https://wiki.auxolotl.org/" target="_blank" rel="noopener" title="Aux Wiki" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17.801 13.557c.148.098.288.202.417.313 1.854 1.6 3.127 4.656 2.582 7.311-1.091-.255-5.747-1.055-7.638-3.383-.91-1.12-1.366-2.081-1.569-2.885a5.65 5.65 0 0 0 .034-.219c.089.198.197.35.313.466.24.24.521.335.766.372.304.046.594-.006.806-.068l.001.001c.05-.015.433-.116.86-.342.325-.173 2.008-.931 3.428-1.566Zm-7.384 1.435C9.156 16.597 6.6 18.939.614 18.417c.219-1.492 1.31-3.019 2.51-4.11.379-.345.906-.692 1.506-1.009.286.168.598.332.939.486 2.689 1.221 3.903 1.001 4.89.573a1.3 1.3 0 0 0 .054-.025 6.156 6.156 0 0 0-.096.66Zm4.152-.462c.38-.341.877-.916 1.383-1.559-.389-.15-.866-.371-1.319-.591-.598-.29-1.305-.283-2.073-.315a4.685 4.685 0 0 1-.804-.103c.014-.123.027-.246.038-.369.062.104.673.057.871.057.354 0 1.621.034 3.074-.574 1.452-.608 2.55-1.706 3.022-3.225.474-1.52.22-3.091-.168-3.952-.169.709-1.453 2.381-1.926 2.871-.473.489-2.381 2.296-2.972 2.921-.7.74-.688.793-1.332 1.302-.202.19-.499.402-.563.53.027-.338.039-.675.027-.997a7.653 7.653 0 0 0-.032-.523c.322-.059.567-.522.567-.861 0-.224-.106-.247-.271-.229.075-.894.382-3.923 1.254-4.281.218.109.831.068.649-.295-.182-.364-.825-.074-1.081.266-.28.374-.956 2.046-.92 4.324-.113.014-.174.033-.322.033-.171 0-.321-.04-.433-.05.034-2.275-.714-3.772-.84-4.169-.12-.375-.491-.596-.781-.596-.146 0-.272.056-.333.179-.182.363.459.417.677.308.706.321 1.156 3.519 1.254 4.277-.125-.006-.199.035-.199.233 0 .311.17.756.452.843a.442.442 0 0 0-.007.03s-.287.99-.413 2.189a4.665 4.665 0 0 1-.718-.225c-.714-.286-1.355-.583-2.019-.566-.664.018-1.366.023-1.804-.036-.438-.058-.649-.15-.649-.15s-.234.365.257 1.075c.42.607 1.055 1.047 1.644 1.18.589.134 1.972.18 2.785-.377.16-.109.317-.228.459-.34a8.717 8.717 0 0 0-.013.626c-.289.753-.571 1.993-.268 3.338 0-.001.701-.842.787-2.958.006-.144.009-.271.01-.383.052-.248.103-.518.148-.799.072.135.151.277.234.413.511.842 1.791 1.37 2.383 1.49.091.019.187.032.285.038Zm-1.12.745c-.188.055-.445.1-.713.059-.21-.031-.45-.11-.655-.316-.169-.168-.312-.419-.401-.789a9.837 9.837 0 0 0 .039-.82l.049-.243c.563.855 1.865 1.398 2.476 1.522.036.008.072.014.109.02l-.013.009c-.579.415-.76.503-.891.558Zm6.333-2.818c-.257.114-4.111 1.822-5.246 2.363.98-.775 3.017-3.59 3.699-4.774 1.062.661 1.468 1.109 1.623 1.441.101.217.09.38.096.515a.57.57 0 0 1-.172.455Zm-9.213 1.62a1.606 1.606 0 0 1-.19.096c-.954.414-2.126.61-4.728-.571-2.023-.918-3.024-2.157-3.371-2.666.476.161 1.471.473 2.157.524.282.021.703.068 1.167.125.021.209.109.486.345.829l.001.001c.451.651 1.134 1.119 1.765 1.262.622.141 2.083.182 2.942-.407a3.12 3.12 0 0 0 .132-.093l.001.179a6.052 6.052 0 0 0-.221.721Zm5.512-1.271a17.49 17.49 0 0 1-1.326-.589c.437.042 1.054.083 1.692.108-.121.162-.244.323-.366.481Zm.932-1.26c-.12.17-.245.343-.373.517-.241.018-.478.03-.709.038a29.05 29.05 0 0 1-.741-.048c.608-.065 1.228-.252 1.823-.507Zm.22-.315c-.809.382-1.679.648-2.507.648-.472 0-.833.018-1.139.039v.001c-.324-.031-.665-.039-1.019-.054a3.555 3.555 0 0 1-.152-.009c.102-.002.192-.006.249-.006.363 0 1.662.034 3.151-.589 1.508-.632 2.645-1.773 3.136-3.351.37-1.186.31-2.402.086-3.312.458-.336.86-.651 1.147-.91.501-.451.743-.733.848-.869.199.206.714.864.685 2.138-.036 1.611-.606 3.187-1.501 4.154a9.099 9.099 0 0 1-1.321 1.132 11.978 11.978 0 0 0-.644-.422l-.089-.055-.051.091c-.184.332-.5.825-.879 1.374ZM4.763 5.817c-.157 1.144.113 2.323.652 3.099.539.776 2.088 2.29 3.614 2.505.991.14 2.055.134 2.055.134s-.593-.576-1.114-1.66c-.521-1.085-.948-2.104-1.734-2.786-.785-.681-1.601-1.416-2.045-1.945-.444-.53-.59-.86-.59-.86s-.656.175-.838 1.513Zm14.301 4.549a9.162 9.162 0 0 0 1.3-1.12c.326-.352.611-.782.845-1.265 1.315.145 2.399.371 2.791.434 0 0-.679 1.971-3.945 3.022l-.016-.035c-.121-.26-.385-.594-.975-1.036Zm-11.634.859a8.537 8.537 0 0 1-.598-.224c-1.657-.693-2.91-1.944-3.449-3.678-.498-1.601-.292-3.251.091-4.269.225.544.758 1.34 1.262 2.01a3.58 3.58 0 0 0-.172.726c-.163 1.197.123 2.428.687 3.24.416.599 1.417 1.62 2.555 2.193-.128.002-.253.003-.376.002Zm-1.758-.077c-.958-.341-1.901-.787-2.697-1.368C-.07 7.559 0 6.827 0 6.827s1.558-.005 3.088.179c.03.126.065.
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../../../..", "features": ["content.tooltips", "search.highlight", "navigation.tabs", "navigation.indexes", "navigation.prune"], "search": "../../../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="../../../../assets/javascripts/bundle.fe8b6f2b.min.js"></script>
</body>
</html>