2021-02-07 06:07:38 +03:00
<!DOCTYPE HTML>
< html lang = "en" class = "sidebar-visible no-js light" >
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
< title > Profiles - nixflk docs< / title >
<!-- Custom HTML head -->
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
< meta name = "description" content = "" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta name = "theme-color" content = "#ffffff" / >
< link rel = "icon" href = "../favicon.svg" >
< link rel = "shortcut icon" href = "../favicon.png" >
< link rel = "stylesheet" href = "../css/variables.css" >
< link rel = "stylesheet" href = "../css/general.css" >
< link rel = "stylesheet" href = "../css/chrome.css" >
< link rel = "stylesheet" href = "../css/print.css" media = "print" >
<!-- Fonts -->
< link rel = "stylesheet" href = "../FontAwesome/css/font-awesome.css" >
< link rel = "stylesheet" href = "../fonts/fonts.css" >
<!-- Highlight.js Stylesheets -->
< link rel = "stylesheet" href = "../highlight.css" >
< link rel = "stylesheet" href = "../tomorrow-night.css" >
< link rel = "stylesheet" href = "../ayu-highlight.css" >
<!-- Custom theme stylesheets -->
< / head >
< body >
<!-- Provide site root to javascript -->
< script type = "text/javascript" >
var path_to_root = "../";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
< / script >
<!-- Work around some values being stored in localStorage wrapped in quotes -->
< script type = "text/javascript" >
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') & & theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') & & sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
< / script >
<!-- Set the theme before any content is loaded, prevents flash -->
< script type = "text/javascript" >
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('no-js')
html.classList.remove('light')
html.classList.add(theme);
html.classList.add('js');
< / script >
<!-- Hide / unhide sidebar before it is displayed -->
< script type = "text/javascript" >
var html = document.querySelector('html');
var sidebar = 'hidden';
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
}
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
< / script >
< nav id = "sidebar" class = "sidebar" aria-label = "Table of contents" >
< div class = "sidebar-scrollbox" >
2021-02-12 08:09:02 +03:00
< ol class = "chapter" > < li class = "chapter-item expanded " > < a href = "../doc/introduction.html" > < strong aria-hidden = "true" > 1.< / strong > Introduction< / a > < / li > < li class = "chapter-item expanded " > < a href = "../doc/start/quick-start.html" > < strong aria-hidden = "true" > 2.< / strong > Quick Start< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../doc/start/iso.html" > < strong aria-hidden = "true" > 2.1.< / strong > ISO< / a > < / li > < li class = "chapter-item expanded " > < a href = "../doc/start/from-nixos.html" > < strong aria-hidden = "true" > 2.2.< / strong > From NixOS< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < div > < strong aria-hidden = "true" > 3.< / strong > Layout< / div > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../hosts/index.html" > < strong aria-hidden = "true" > 3.1.< / strong > Hosts< / a > < / li > < li class = "chapter-item expanded " > < a href = "../profiles/index.html" class = "active" > < strong aria-hidden = "true" > 3.2.< / strong > Profiles< / a > < / li > < li class = "chapter-item expanded " > < a href = "../suites/index.html" > < strong aria-hidden = "true" > 3.3.< / strong > Suites< / a > < / li > < li class = "chapter-item expanded " > < a href = "../users/index.html" > < strong aria-hidden = "true" > 3.4.< / strong > Users< / a > < / li > < li class = "chapter-item expanded " > < a href = "../cachix/index.html" > < strong aria-hidden = "true" > 3.5.< / strong > Cachix< / a > < / li > < / ol > < / li > < / ol >
2021-02-07 06:07:38 +03:00
< / div >
< div id = "sidebar-resize-handle" class = "sidebar-resize-handle" > < / div >
< / nav >
< div id = "page-wrapper" class = "page-wrapper" >
< div class = "page" >
< div id = "menu-bar-hover-placeholder" > < / div >
< div id = "menu-bar" class = "menu-bar sticky bordered" >
< div class = "left-buttons" >
< button id = "sidebar-toggle" class = "icon-button" type = "button" title = "Toggle Table of Contents" aria-label = "Toggle Table of Contents" aria-controls = "sidebar" >
< i class = "fa fa-bars" > < / i >
< / button >
< button id = "theme-toggle" class = "icon-button" type = "button" title = "Change theme" aria-label = "Change theme" aria-haspopup = "true" aria-expanded = "false" aria-controls = "theme-list" >
< i class = "fa fa-paint-brush" > < / i >
< / button >
< ul id = "theme-list" class = "theme-popup" aria-label = "Themes" role = "menu" >
< li role = "none" > < button role = "menuitem" class = "theme" id = "light" > Light (default)< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "rust" > Rust< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "coal" > Coal< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "navy" > Navy< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "ayu" > Ayu< / button > < / li >
< / ul >
< button id = "search-toggle" class = "icon-button" type = "button" title = "Search. (Shortkey: s)" aria-label = "Toggle Searchbar" aria-expanded = "false" aria-keyshortcuts = "S" aria-controls = "searchbar" >
< i class = "fa fa-search" > < / i >
< / button >
< / div >
< h1 class = "menu-title" > nixflk docs< / h1 >
< div class = "right-buttons" >
< a href = "../print.html" title = "Print this book" aria-label = "Print this book" >
< i id = "print-button" class = "fa fa-print" > < / i >
< / a >
< / div >
< / div >
< div id = "search-wrapper" class = "hidden" >
< form id = "searchbar-outer" class = "searchbar-outer" >
< input type = "search" name = "search" id = "searchbar" name = "searchbar" placeholder = "Search this book ..." aria-controls = "searchresults-outer" aria-describedby = "searchresults-header" >
< / form >
< div id = "searchresults-outer" class = "searchresults-outer hidden" >
< div id = "searchresults-header" class = "searchresults-header" > < / div >
< ul id = "searchresults" >
< / ul >
< / div >
< / div >
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
< script type = "text/javascript" >
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
< / script >
< div id = "content" class = "content" >
< main >
< h1 > < a class = "header" href = "#profiles" id = "profiles" > Profiles< / a > < / h1 >
< p > Profiles are simply NixOS modules which contain generic expressions suitable
for any host. A good example is the configuration for a text editor, or
window manager. If you need some concrete examples, just checkout the
community < a href = "https://github.com/nrdxp/nixflk/tree/community/profiles" > branch< / a > .< / p >
2021-02-07 07:17:27 +03:00
< h2 > < a class = "header" href = "#constraints" id = "constraints" > Constraints< / a > < / h2 >
2021-02-07 06:07:38 +03:00
< p > For the sake of consistency, there are a few minor constraints. First of all, a
profile should always be defined in a < code > default.nix< / code > , and it should always be a
a function taking a single attribute set as an argument, and returning a NixOS
module which does not define any new module options. If you need to make new
2021-02-07 07:23:54 +03:00
module option declarations, just use < a href = "./modules.html" > modules< / a > .< / p >
2021-02-07 06:07:38 +03:00
< p > These restrictions help simplify the import logic used to pass profles to
2021-02-07 07:23:54 +03:00
< a href = "./suites.html" > suites< / a > .< / p >
2021-02-07 06:07:38 +03:00
< h3 > < a class = "header" href = "#example" id = "example" > Example< / a > < / h3 >
< p > ✔< code > profiles/develop/default.nix< / code > :< / p >
< pre > < code class = "language-nix" > # good profile definition
2021-02-07 06:18:20 +03:00
{ ... }:
2021-02-07 06:07:38 +03:00
{
2021-02-07 06:18:20 +03:00
programs.zsh.enable = true;
2021-02-07 06:07:38 +03:00
}
< / code > < / pre >
< p > ❌< code > profiles/develop.nix< / code > :< / p >
< pre > < code > # bad profile definition
{
options = {};
}
< / code > < / pre >
< h2 > < a class = "header" href = "#subprofiles" id = "subprofiles" > Subprofiles< / a > < / h2 >
< p > Profiles can also define subprofiles. They follow the same constraints outlined
above. A good top level profile should be a high level concern, such a your
personal development environment, and the subprofiles should be more concrete
program configurations such as your text editor, and shell configs. This way,
you can either pull in the whole development profile, or pick and choose
individual programs.< / p >
< h2 > < a class = "header" href = "#conclusion" id = "conclusion" > Conclusion< / a > < / h2 >
< p > Profiles are the most important concept in nixflk. They allow us to keep our
nix expressions self contained and modular. This way we can maximize reuse
while minimizing boilerplate. Always strive to keep your profiles as generic
and modular as possible. Anything machine specific belongs in your
2021-02-07 07:23:54 +03:00
< a href = "./hosts.html" > host< / a > files.< / p >
2021-02-07 06:07:38 +03:00
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
2021-02-12 08:09:02 +03:00
< a rel = "prev" href = "../hosts/index.html" class = "mobile-nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
2021-02-07 06:07:38 +03:00
< i class = "fa fa-angle-left" > < / i >
< / a >
2021-02-12 08:09:02 +03:00
< a rel = "next" href = "../suites/index.html" class = "mobile-nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
2021-02-07 06:26:50 +03:00
< i class = "fa fa-angle-right" > < / i >
< / a >
2021-02-07 06:07:38 +03:00
< div style = "clear: both" > < / div >
< / nav >
< / div >
< / div >
< nav class = "nav-wide-wrapper" aria-label = "Page navigation" >
2021-02-12 08:09:02 +03:00
< a rel = "prev" href = "../hosts/index.html" class = "nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
2021-02-07 06:07:38 +03:00
< i class = "fa fa-angle-left" > < / i >
< / a >
2021-02-12 08:09:02 +03:00
< a rel = "next" href = "../suites/index.html" class = "nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
2021-02-07 06:26:50 +03:00
< i class = "fa fa-angle-right" > < / i >
< / a >
2021-02-07 06:07:38 +03:00
< / nav >
< / div >
< script type = "text/javascript" >
window.playground_copyable = true;
< / script >
< script src = "../elasticlunr.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../mark.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../searcher.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../clipboard.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../highlight.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../book.js" type = "text/javascript" charset = "utf-8" > < / script >
<!-- Custom JS scripts -->
< / body >
< / html >
