NixOS Wiki: Difference between revisions

Latest revision as of 14:49, 30 October 2024

Getting started

This is the official NixOS Wiki. It includes topics not covered in the NixOS Manual: NixOS user guides, configuration examples, and troubleshooting tips.

NixOS is a Linux operating system based on the Nix package manager and the Nixpkgs package repository.

Newcomers to NixOS are encouraged to read the Nix Core Ecosystem overview article to get a comprehensive orientation. For more specific introductions, see:

If you want to try Nix standalone in another Linux distribution or on a Mac, take your first steps on nix.dev.

Much great additional tooling exists in the Nix ecosystem such as:

Home-manager to manage user profile & home directory contents
Nix Flakes instead of nix-channel

These add complexity and may be confusing at first, and you may even decide that you don't need them. Start with plain Nix/NixOS, and only integrate Home Manager and/or Flakes into your setup once you're confident with Nix/NixOS and comprehend their significance.

Setting up NixOS

On desktop, with NixOS as a desktop
On ARM, with NixOS on ARM
In the cloud, with NixOS friendly hosters

Documentation topics

First stop should be Resources, which serves as a gateway to the most important documentation. Some highlights below.

Primary reference material:

Major page categories:

Software
Hardware
Desktop - how to setup PCs
Server - how to setup servers
Community - people, communication, work on NixOS

2024-09-02 — Wiki editors use Manual of Style

The Wiki team discussed and put into effect the Manual of Style for editing wiki articles. This is a huge step towards clear and consistent documentation. All editors are encouraged to follow this guide.

2024-08-22 — Wiki editors meeting

All interested wiki editors meet on 22th of August at 21:15 CEST in a Jitsi conference.

Agenda: https://pad.lassul.us/wiki-agenda?view

2024-07-05 — Wiki editors meeting

All interested wiki editors meet on 5th of July at 13:00 CEST in a Jitsi conference.

2024-04-01 — Launch of the wiki

The official NixOS wiki has taken off! If you want to find out why there is a new wiki effort, check out the FAQ.

... all news articles →

@@ Line 1: / Line 1: @@
-__NOTOC__{{#tweekihide:sidebar-right}}{{#tweekihide:firstHeading}}
+<languages/>
-<div class="nixos-wiki-jumbotron">
+<translate>
-    <div class="row">
+<!--T:1-->
-	<div class="col-lg-3 col-md-4">
+__NOTOC__
-	    <p style="text-align: center; padding-top: 1em;">[[File:home-nixos-logo.png|link=|class=jumbotron-logo]]</p>
+<!-- NOTE: Please don't change the layout/categorizing without first coordinating with the other editors. -->
-	</div>
+<!-- NOTE: Feel free to add/edit content though! -->
-	<div class="col-lg-9 col-md-8">
+<!-- NOTE: Removing those notes and/or disregarding this is not only rude, but should be considered defacement. -->
-	    <h1 style="font-size: 4rem;">NixOS Wiki</h1>
-	    <p class="lead" style="font-size:3rem; margin-bottom: 1rem;">Welcome to the '''unofficial''' user's wiki</p>
-	    <p class="lead">
-	    This wiki is user-maintained. Take a look at [[{{ns:4}}:About|the about page]] for more informations.
-	    </p>
-	</div>
-    </div>
-</div>
-<hr />
 <div class="row home-panes">
      <div class="col-md-7">
-{{home:box|manuals|icon=manual|Manuals|
+{{home:box|get-started|icon=clarifications|Getting started|
+This is the official NixOS Wiki.
+It includes topics not covered in the [https://nixos.org/nixos/manual NixOS Manual]: NixOS user guides, configuration examples, and troubleshooting tips.
+<!--T:2-->
+NixOS is a Linux operating system based on the Nix package manager and the Nixpkgs package repository.
+<!--T:3-->
+Newcomers to NixOS are encouraged to read the [[Nix Ecosystem|Nix Core Ecosystem]] overview article to get a comprehensive orientation. For more specific introductions, see:
+* [[Overview_of_the_NixOS_Linux_distribution|NixOS]]
+* [[Nix package manager]]
+* [[Nixpkgs]] package repository
+* [[Overview of the Nix Language |Nix Language]]
+If you want to try Nix standalone in another Linux distribution or on a Mac, take your first steps on [https://nix.dev nix.dev].
+<!--T:4-->
+Much great additional tooling exists in the Nix ecosystem such as:
+<!--T:12-->
+* [[Home Manager|Home-manager]] to manage user profile & home directory contents
+* [[Flakes|Nix Flakes]] instead of nix-channel
+<!--T:13-->
+These add complexity and may be confusing at first, and you may even decide that you don't need them.
+Start with plain Nix/NixOS, and only integrate Home Manager and/or Flakes into your setup once you're confident with Nix/NixOS and comprehend their significance.}}
+<!--T:5-->
+{{home:box|hosting|icon=cloud|Setting up NixOS|
+<!-- once ready: * On your computer, with [[NixOS Installation Guide]] -->
+* On desktop, with [[NixOS as a desktop]]
+* On ARM, with [[NixOS on ARM]]
+* In the cloud, with [[NixOS friendly hosters]]
+}}
+<!--T:6-->
+{{home:box|doctopics|icon=manual|Documentation topics|
+First stop should be [[Resources]], which serves as a gateway to the most important documentation. Some highlights below.
+<!--T:7-->
+Primary reference material:
+* [https://nixos.org/nixos/manual/ NixOS manual]
 * [https://nixos.org/nix/manual/ Nix manual]
-* [https://nixos.org/nixos/manual/ NixOS manual]
 * [https://nixos.org/nixpkgs/manual/ Nixpkgs manual]
-* [https://nixos.org/nixops/manual/ NixOps manual]
+* [https://nixos.org/hydra/manual/ Hydra manual]
+<!--T:8-->
+Major page categories:
+* [[:{{ns:14}}:Software|Software]]
+* [[:{{ns:14}}:Hardware|Hardware]]
+* [[:{{ns:14}}:Desktop|Desktop]] - how to setup PCs
+* [[:{{ns:14}}:Server|Server]] - how to setup servers
+* [[:{{ns:14}}:Community|Community]] - people, communication, work on NixOS
+<!--T:9-->
+See also:
+* [[FAQ]]
+* [[Nix vs. Linux Standard Base]]
+* [[Terms and Definitions in Nix Project]]
 * [[Cheatsheet]]
+* [[Ubuntu vs. NixOS|Comparison between Ubuntu and NixOS]]
 }}
-{{home:box|clarifications|Clarifications|
-* [[FAQ]]
+<!--T:10-->
-* [[Nixpkgs vs other packagers]]
+{{home:box|wikipages|Special pages|3=<ul>
-* [[Cheatsheet|Comparison between Ubuntu and NixOS]]
+<li><span class="plainlinks">[{{fullurl:Special:SpecialPages}} Overview of special pages]</span></li>
-}}
+<li><span class="plainlinks">[{{fullurl:Special:AllPages|hideredirects=1}} All pages of {{SERVERNAME}}]</span></li>
-{{home:box|hosting|icon=cloud|Hosting providers|
+<li>[[Special:Categories|All categories of {{SERVERNAME}}]]</li>
-* [[NixOS friendly hosters]]
+<li>[{{fullurl:Special:RecentChanges|hidebots=1&reviewStatus=unpatrolled}} Unpatrolled changes of {{SERVERNAME}}]</li>
-}}
+</ul>}}
      </div>
      <div class="col-md-5">
 {{home:box|get-in-touch|icon=dialog-hi|Get in touch|
-*[[Nix Community|Our Community]]
+<b>With the community</b>
-* Mailing list: [https://groups.google.com/forum/#!forum/nix-devel nix-devel]
+* [https://nixos.org/ Official NixOS website]
-* Forums
+* [https://nixos.org/community/#governance-teams Official Teams]
-** [https://stackoverflow.com/questions/tagged/nixos+or+nix+or+nixops+or+nixpkgs stack overflow]
+* [[Nix Community|Community overview]]
-** [https://www.reddit.com/r/NixOS/ /r/NixOS]
+* [[Get In Touch|Chats and forums]]
-* IRC: [irc://irc.freenode.net/nixos ''#nixos'' on freenode]
+* [[Support|Get support]]
-** Developers: [irc://irc.freenode.net/nixos-dev ''#nixos-dev'' on freenode]
+* [[Get In Touch#Events|Events]]
-** Wiki: [irc://irc.freenode.net/nixos-wiki ''#nixos-wiki'' on freenode]
-* Bugtracker: [https://github.com/NixOS/nixpkgs/issues issues (for Nixpkgs) on GitHub]
-; See also: [[Get Involved]]
+<!--T:11-->
+<b>About the Wiki</b>
+* Matrix chat for Wiki contributors [https://matrix.to/#/#wiki:nixos.org #wiki:nixos.org]
+* Email [mailto:wiki@nixos.org wiki@nixos.org] for contacting wiki.nixos.org regarding any wiki operational topics or requests
+* [[Contributing|Contribute to wiki and NixOS]]
+* [[Manual of Style]]
 }}
-{{home:box|news|News|
+{{home:box|news|News|{{NixOS_Wiki:News}}
-    {{NixOS_Wiki:News}}
 [[NixOS_Wiki:News{{!}}... all news articles &rarr;]]
-}}
-{{home:box|wikipages|Special pages|
-* [[Special:AllPages|All pages of {{SERVERNAME}}]]
-* [[Special:Categories|All categories of {{SERVERNAME}}]]
-* [[Special:RecentChanges|Recent changes of {{SERVERNAME}}]]
 }}
      </div>
 </div>
+</translate>