Commit Graph

172 Commits

Author SHA1 Message Date
pennae
a15d7335a5 nixos/manual: remove .title fenced divs
pandoc drops .title classes when rendering to docbook, so these are
effectively just paragraphs anyway. without support for including them
in a table of contents the complexity of parsing them in
nixos-render-docs won't be warranted.
2023-02-10 06:40:00 +01:00
pennae
861ebec769 nixos/manual: don't use multi-definitions in installer chapter
pandoc renders these to multiple docbook paragraphs in a single
definition for the term, not multiple *actual* definitions for the same
term. this is most likely not what is intended here, so let's use
multiple paragraphs instead.
2023-02-10 06:40:00 +01:00
figsoda
85053313e7 doc/installation: fix incorrect channel link 2023-01-03 15:24:36 -05:00
Naïm Favier
e9e65810ac
doc,nixos/doc: unescape double quotes
Leftovers from the CommonMark conversion.
2022-12-27 17:13:49 +01:00
Naïm Favier
d11832fd96
doc,nixos/doc: unescape apostrophes
Leftovers from the CommonMark conversion.
2022-12-27 17:13:47 +01:00
figsoda
6bb0dbf91f nixos: fix typos 2022-12-17 19:31:14 -05:00
Martin Weinelt
f1b9cc23aa Release NixOS 22.11 2022-11-30 11:52:38 +01:00
Valentin Gagarin
10ffe1e731
Merge pull request #201084 from wentasah/nixos-doc-fix-install
nixos/doc: fix installing from other distro
2022-11-22 11:13:09 +01:00
Michal Sojka
ee8ae2da4c nixos/doc: fix installing from other distro
The nixos-generate-config command mentioned in the manual fails with error:

    nixos-generate-config: no need to specify `/` with `--root`, it is the default

This was introduced in 611b8c4472
(#161034). Now, the command should be called without any arguments.
2022-11-13 22:11:19 +01:00
Philipp Hauck
cb82a002f8 nixos: correct install summary 2022-11-08 15:29:42 +01:00
davidak
f701bd5986 nixos/doc: improve install instructions
- Update download URLs
- Replace "USB stick"/"USB Drive" with "USB flash drive" as that seem more correct

  https://en.wikipedia.org/wiki/USB_flash_drive
  https://elementary.io/docs/installation#choose-operating-system

- Don't mention CD as easiest option anymore,
  as all modern systems should be able to boot from USB,
  but many don't have a CD drive. Burning CDs is also usually wasteful as you
  can't burn them again.
- Remove link to NixOS Wiki (Making_the_installation_media) as it is not needed
- Add Etcher and USBImager as graphical tools to create install drive
- Make dd command consistent and use block size of 4 MB for faster flashing
- More consistent text
- Add instructions for "Booting from the install medium"

  Inspired by 9a91b0f495/docs/installation.md (booting-from-the-install-drive-booting-from-the-installation-medium-clear-float-2)

- Add instructions for "Graphical Installation"
- Restructure headings and anchors for "Manual Installation"
- Adding legacy anchors for "Manual Installation" to not break links

Co-authored-by: j-k <dev@j-k.io>
Co-authored-by: Sandro <sandro.jaeckel@gmail.com>
Co-authored-by: Robert Schütz <github@dotlambda.de>
Co-authored-by: Jörg Thalheim <Mic92@users.noreply.github.com>
Co-authored-by: Thiago Kenji Okada <thiagokokada@gmail.com>
2022-10-26 14:22:15 +02:00
Benjamin Sayers
c962792927 nixos/docs: revised MBR partitioning steps 2022-09-02 11:39:25 +01:00
Benjamin Sayers
0c59d1f2a3 nixos/docs: updated MBR partitioning steps 2022-08-25 20:13:46 +01:00
Jörg Thalheim
e8e20bc30c
Merge pull request #171562 from Mic92/nixos-docs
nixos/doc/installation: fix alignment of created partitions
2022-08-16 05:05:13 +01:00
Guillaume Girol
273697ed08
Merge pull request #182829 from symphorien/bootloader-doc
rephrase nixos installation doc
2022-07-29 19:54:47 +00:00
Guillaume Girol
063996d291
Merge pull request #182233 from symphorien/doc-iso-branch
nixos/doc: don't advise to build master
2022-07-25 20:48:49 +00:00
Guillaume Girol
5eb63756ca rephrase nixos installation doc
systemd-boot is not the only option, even though it "just works" better.
2022-07-25 12:00:00 +00:00
Guillaume Girol
b996269988 nixos/doc: don't advise to build master 2022-07-20 12:00:00 +00:00
Florian Klink
06aa64684c nixos/doc: document how to use kexecTree
This documents how to build kexec artifacts.
2022-06-09 20:08:34 +02:00
Janne Heß
cbaacfb8df
Release 22.05 2022-05-30 20:50:07 +02:00
Ivan Kozik
59a76614f3 treewide: chown user:group instead of user.group to fix warnings from coreutils 9.1 2022-05-05 22:05:18 +00:00
Jörg Thalheim
f18befaaf4 nixos/doc/installation: fix alignment of created partitions
$ parted /dev/nvme1n1 -- mkpart primary linux-swap -8GiB 100%
Warning: The resulting partition is not properly aligned for best performance: 3108850352s % 2048s != 0s
Ignore/Cancel?
Information: You may need to update /etc/fstab.

When using GB than parted seems to round up itself.
2022-05-04 20:29:24 +02:00
Florian Klink
b2f5308400 nixos/doc: move "Building NixOS" into "Installation", not "Development"
This section mostly describes how to build various installer images, so
it fits better in that chapter.

Proposed in https://github.com/NixOS/nixpkgs/pull/168306#discussion_r848329534
2022-04-16 15:19:03 +02:00
Guillaume Girol
aafec3d778
Merge pull request #166154 from YoshiRulz/yoshi-manual
Manual: move note re: `useOSProber` option under GRUB subheading
2022-04-03 16:17:48 +00:00
Jeppe Fihl-Pearson
b5f36e84d1 Add block size to dd command
Without configuring the block size a default of 512 bytes is used, which can
slow down the transfer speed massively.

In a test I've done with a semi-decent USB stick, I only get a transfer speed
of around 180 KB/sec when not specifying the block size but see 27 MB/sec when
setting the block size to 1 MB. This makes the transfer of the minimal
installation ISO take half a minute instead of an hour.
2022-04-01 22:14:04 +02:00
YoshiRulz
0151265311
Manual: move note re: useOSProber option under GRUB subheading 2022-03-29 09:04:38 +10:00
Nikolay Amiantov
29fd78747a nixos/manual: use system nixpkgs to build pxe image
The command in example is expected to be run from nixpkgs checkout, but
there's no explanation of this. Let's just use system nixpkgs: most
users will have it just working and those who use git checkouts will
figure it out.
2022-02-16 22:22:32 +03:00
Tom Bereknyei
af92f1c0cc [21.11] update README.md
[21.11] update upgrading

[21.11] update release date

run generation
2021-11-29 20:15:35 -05:00
Dzmitry Malyshau
e7898e1226 Add command to switch to root
Installation guide assumed you are root but didn't explain how to get there. And it's not obvious.
2021-10-18 09:25:48 -04:00
Bobby Rong
7fb52b1325
nixos: nixos/doc/manual/installation/installing.xml to CommonMark 2021-09-12 09:26:37 +08:00
Jörg Thalheim
e622dd1c84
Merge pull request #129154 from bobby285271/pr15
nixos/doc: convert Chapter 1, 3, 4 to CommonMark
2021-09-07 06:29:19 +01:00
Jörg Thalheim
48dc5e4ba6
Merge pull request #129003 from bobby285271/pr10
nixos/doc: convert "2.5. Additional installation notes" to CommonMark
2021-09-07 06:24:42 +01:00
rnhmjoj
d857340c8e
nixos/installer: simplify and document wifi setup
The wpa_supplicant service in the NixOS installer is unusable because
the control socket is disabled and /etc/wpa_supplicant.conf ignored.

The manual currently recommends manually starting the daemon and using
wpa_passphrase, but this requires figuring out the interface name,
driver and only works for WPA2 personal networks.

By enabling the control socket, instead, a user can configure the
network via wpa_cli (or wpa_gui in the graphical installer), which
support more advanced network configurations.
2021-08-15 12:08:32 +02:00
Radovan Bast
45abf2f0d0 nixos/manual: prompt to set root password has changed
The manual mentions in
https://nixos.org/manual/nixos/stable/index.html#sec-installation-installing:
```
setting root password...
Enter new UNIX password: ***
Retype new UNIX password: ***
```

However, in the terminal I got:
```
setting root password...
New password: ***
Retype new password: ***
```
2021-07-04 20:33:38 +02:00
Bobby Rong
a3480a0e69 nixos: use only URI fragment in manual options links 2021-07-04 09:18:03 +08:00
Bobby Rong
f6911a020e nixos: nixos/doc/manual/installation/upgrading.xml to CommonMark 2021-07-04 00:10:18 +08:00
Bobby Rong
b85403368f nixos: nixos/doc/manual/installation/changing-config.xml to CommonMark 2021-07-04 00:09:43 +08:00
Bobby Rong
e7c482f789 nixos: nixos/doc/manual/installation/obtaining.xml to CommonMark 2021-07-04 00:09:05 +08:00
Bobby Rong
445e922b5b nixos: nixos/doc/manual/installation/installing-behind-a-proxy.xml to CommonMark 2021-07-02 22:52:47 +08:00
Bobby Rong
060684efa1 nixos: nixos/doc/manual/installation/installing-from-other-distro.xml to CommonMark 2021-07-02 22:52:17 +08:00
Bobby Rong
5a4d8ad834 nixos: nixos/doc/manual/installation/installing-virtualbox-guest.xml to CommonMark 2021-07-02 22:51:29 +08:00
Bobby Rong
f6a42c131a nixos: nixos/doc/manual/installation/installing-pxe.xml to CommonMark 2021-07-02 22:50:58 +08:00
Bobby Rong
5f0e1822e8 nixos: nixos/doc/manual/installation/installing-usb.xml to CommonMark 2021-07-02 22:50:10 +08:00
Jonathan Ringer
40b2ca3570 nixos/doc/releases: update stable release info to 21.05 2021-05-31 19:42:40 -07:00
Samuel Dionne-Riel
db3199f8c3
Merge pull request #118993 from tomfitzhenry/serial-doc
nixos/manual: document how to install over a serial port
2021-05-24 15:26:23 -04:00
Tom Fitzhenry
81e04717e8 nixos/manual: document how to install over a serial port
https://github.com/NixOS/nixpkgs/issues/58198
2021-05-24 17:29:19 +10:00
Robert Hensing
7b0e0ca35e nixos-install-tools: init
The essential commands from the NixOS installer as a package

With this package, you get the commands like nixos-generate-config and
nixos-install that you would otherwise only find on a NixOS system, such
as an installer image.

This way, you can install NixOS using a machine that only has Nix.

It also includes the manpages, which are important because the commands
rely on those for providing --help.
2021-05-13 01:29:02 +02:00
Jade
c6189e2f28 manual/installation: s/boot.loader.systemd/boot.loader.systemd-boot
The link had the wrong title.
2021-03-15 01:26:32 -07:00
nicoo
16b6c4b2d7 nixos/manual/virtualbox-guest: Remove mentions of rngd 2021-02-21 01:37:18 +01:00
Sibi Prabakaran
15dcf1344f
nixos/manual: fix typo in virtualbox installation guide 2020-12-21 11:01:54 +05:30