Commit Graph

192 Commits

Author SHA1 Message Date
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
Alyssa Ross
55a6b5565b
nixos/manual: don't recommend nix-env -iA
We're really setting users up on the wrong path if we tell them to
nix-env -iA immediately after installing.  Instead, let's just
reassure them that installing software will be covered in due course
in the manual, to encourage them to keep reading.
2020-12-01 01:23:16 +00:00
Doron Behar
8769c817f4
Merge pull request #75615 from FSMaxB/patch-1
Add note about installing NixOS from distributions with /usr/sbin and…
2020-11-13 10:50:32 +02:00
Max Bruckner
be0555b8a8 nixos/doc: Add note about /usr/sbin and /sbin
An installation from Debian buster may fail without adding /usr/sbin to
$PATH because chroot is not in the PATH of a non-root user.
2020-11-13 10:30:20 +02:00
Jonathan Ringer
366bebd53a README.md: update stable release links 2020-10-26 20:10:29 -04:00
Doron Behar
f85b2a1c89
Merge pull request #97797 from lf-/fix-redirecting-installer-urls
docs: add -L to remaining curl install commands
2020-09-26 19:15:08 +03:00
Jan Tojnar
e6ce041cae
nixos/doc: Improve code listings
By adding prompts and replaceables and removing unnecessary indentation.
2020-09-23 01:25:25 +02:00
lf-
6ed65d9b5f docs: add -L to remaining curl install commands 2020-09-11 12:14:07 -07:00
WORLDofPEACE
0e7f6a884b
Update nixos/doc/manual/installation/installing.xml
Co-authored-by: Jon <jonringer@users.noreply.github.com>
2020-09-08 19:24:51 -04:00
Jörg Thalheim
60d30e13f7
Update nixos/doc/manual/installation/installing.xml
Co-authored-by: Samuel Dionne-Riel <samuel@dionne-riel.com>
2020-09-06 19:44:30 +01:00
Jörg Thalheim
a5872edf2f
nixos/installer: enable sshd by default
Right now the UX for installing NixOS on a headless system is very bad.
To enable sshd without physical steps users have to have either physical
access or need to be very knowledge-able to figure out how to modify the
installation image by hand to put an `sshd.service` symlink in the
right directory in /nix/store. This is in particular a problem on ARM
SBCs (single board computer) but also other hardware where network is
the only meaningful way to access the hardware.

This commit enables sshd by default. This does not give anyone access to
the NixOS installer since by default. There is no user with a non-empty
password or key. It makes it easy however to add ssh keys to the
installation image (usb stick, sd-card on arm boards) by simply mounting
it and adding a keys to `/root/.ssh/authorized_keys`.
Importantly this should not require nix/nixos on the machine that
prepare the installation device and even feasiable on non-linux systems
by using ext4 third party drivers.

Potential new threats: Since this enables sshd by default a
potential bug in openssh could lead to remote code execution. Openssh
has a very good track-record over the last 20 years, which makes it
far more likely that Linux itself would have a remote code execution
vulnerability. It is trusted by millions of servers on many operating
systems to be exposed to the internet by default.

Co-authored-by: Samuel Dionne-Riel <samuel@dionne-riel.com>
2020-09-06 20:26:08 +02:00
rnhmjoj
bc62423a87
nixos/doc: convert loaOf options refs to attrsOf 2020-09-02 00:42:51 +02:00
Linus Heckemann
a5d20d25eb
Merge pull request #88669 from Mic92/hidpi
nixos/hidpi: Reasonable defaults for high-density displays
2020-07-22 17:43:03 +02:00
Nathan Fish
8ffa852aed
netboot: docs: building netboot should specify an arch (#75116)
Building without specifying an arch attempts to build all,
and fails.
2020-07-21 19:26:02 +02:00
Jan Tojnar
07cebeffb8
Merge pull request #86473 from bachp/virtualbox-vmsvga 2020-07-05 04:11:44 +02:00
Konrad Förstner
7ec38adfdc nixos/doc/manual: Fix parted's set subcommand for esp partition
With 'set 3 boot on' the error 'file system "/boot" is not a FAT EFI
system partition (ESP) file system' occurs when running
"nixos-install" during the basic installation (tested in in a
VirtualBox VM).
2020-07-02 08:40:01 +02:00
Pascal Bach
6c2d12f1fa nixos/manual: recommend VMSVGA as graphics adapter
Virtualbox recommends VMSVGA for Linux guests.

It is also currently the only one supporting 3D acceleration
and it works out of the box with NixOS and auto screen resizing.
2020-06-17 18:43:27 +02:00
Linus Heckemann
01ee5c9271 manual: use less weird way of installing nixos tools 2020-06-14 10:39:43 +02:00
Jörg Thalheim
b6a1dc51d0
nixos/installer: suggest to load v32n instead if i32n
v32n has more characters.
2020-05-25 09:24:50 +01:00
Pavol Rusnak
7b0167204d treewide: use https for nixos.org and hydra.nixos.org
tarballs.nixos.org is omitted from the change because urls from there
are always hashed and checked
2020-05-03 22:14:21 -07:00
Jörg Thalheim
b0196cacec
Merge pull request #84476 from jakobrs/installation-cd-base-terminus 2020-04-29 17:20:49 +01:00
worldofpeace
e9e9582986
Merge pull request #85186 from worldofpeace/20.03-readme
README.md: 20.03 release
2020-04-20 11:57:45 -04:00
worldofpeace
40f3faedbd nixos/manual: 19.09 -> 20.03 2020-04-17 12:41:24 -04:00
jakobrs
34f242c13d nixos/installer: Add terminus_font to installation_iso_base 2020-04-15 14:21:42 +02:00
Graham Christensen
ec2d28e323
specialisation: replace nesting with named configurations
Co-authored-by: worldofpeace <worldofpeace@protonmail.ch>
2020-04-12 08:12:50 -04:00
Eelco Dolstra
aebf9a4709
services/misc/nixos-manual.nix: Remove
Running the manual on a TTY is useless in the graphical ISOs and not
particularly useful in non-graphical ISOs (since you can also run
'nixos-help').

Fixes #83157.
2020-03-24 15:25:20 +01:00
Daniel Frank
73220589e0
doc: Add documentation for the new option to the Automatic Upgrades section 2020-02-08 11:44:59 +01:00
Mateusz Piotrowski
b7c217328e Fix a typo 2019-12-10 19:26:27 -08:00
Arnout Engelen
89ed88f86f Spell out you need to enable wifi explicitly at install time 2019-12-02 17:50:22 +01:00
Robin Gloster
844625708e
nixos/manual: reword installation section
Sounded a bit unprofessional and pessimistic. Was actually called out on
twitter.
2019-11-20 10:30:49 +01:00
Olgierd "Allgreed" Kasprowicz
3fd657f421 Add a hint on Virtualbox machine setup
By default VMSVGA is set, which causes failure upon X startup.
2019-10-10 00:49:43 +02:00
wodim
c5daa2cb3b
Fix typo 2019-10-09 20:42:36 +02:00
Vladimír Čunát
f760f0ef48
Revert "Merge #67232: machinectl compliant NixOS installation"
This reverts commit 66967ec752, reversing
changes made to fb6595eafd.
Fixes #70442; discussion: https://github.com/NixOS/nixpkgs/pull/70027
2019-10-07 20:56:59 +02:00
Samuel Leathers
4d25ec0caf
nixos/manual: update 19.03 -> 19.09 in upgrading section 2019-10-07 10:38:14 -04:00
Christian Kögler
ba37b3c622
nixos: added installation doc for nspawn container 2019-09-13 17:33:38 +02:00
SRGOM
c17e66afe4
nixos.manual.installation.installing: nixos-hw
Fixed repo name gh:nixos/nixos-hardware
2019-09-10 23:04:00 +05:30
SRGOM
5d08759f97
nixos.manual.installation.installing: nixos-hw
Add a brief note about nixos-hardware repo because it is in the official nixos organization. (and seemingly useful...)
2019-09-03 00:41:20 -06:00
Symphorien Gibol
c3e1e64e4c remove all instances of nix-env -i without -A in the NixOS manual
motivation: https://nixos.wiki/wiki/FAQ/Why_not_use_nix-env_-i_foo%3F
2019-08-17 18:04:43 +02:00
worldofpeace
dd49cf711e
Merge pull request #66338 from worldofpeace/installer/no-root
installer: Don't run as root
2019-08-14 11:20:54 -04:00
Maximilian Bosch
551230b7f6
nixos/doc: document that services defined with systemd.users aren't restarted by nixos-rebuild 2019-08-13 16:26:09 +02:00
worldofpeace
397c7d26fc installer: Don't run as root
There's many reason why it is and is going to
continue to be difficult to do this:

1. All display-managers (excluding slim) default PAM rules
   disallow root auto login.

2. We can't use wayland

3. We have to use system-wide pulseaudio

4. It could break applications in the session.
   This happened to dolphin in plasma5
   in the past.

This is a growing technical debt, let's just use
passwordless sudo.
2019-08-12 14:45:27 -04:00
Jan Tojnar
a3f2131eb6 doc: Use prompt more often 2019-06-17 13:25:50 +02:00
Jan Tojnar
11cb382a4c
nixos/doc: Fix spurious indentation 2019-06-17 12:28:26 +02:00
Matthew O'Gorman
da035d3ad6
nixos/manual: update 17.03 -> 19.03 in upgrading section 2019-04-12 12:16:30 -04:00
Frederik Rietdijk
23e431387b Merge staging-next into staging 2019-03-23 09:20:09 +01:00
Vladimír Čunát
4c3ec0e325
nixos docs: run the formatting tool (no content change)
As documented in the docs themselves :-)
2019-03-22 14:44:11 +01:00
Jörg Thalheim
b488c60cdb network-manager: rename systemd service back to match upstream
Compatibility with other distributions/software and expectation
of users coming from other systems should have higher priority over consistency.
In particular this fixes #51375, where the NetworkManager-wait-online.service
broke as a result of this.
2019-03-19 23:48:08 +01:00
Graham Christensen
777e94d903
Merge pull request #55436 from layus/warn-manual-ids
Nixos manual: error out on missing IDs
2019-03-09 08:21:07 -05:00
matix2267
6ab2aea003 nixos/doc: Small updates about wireless configuration. (#55918)
* Reference networking section from installation
* Add info about pskRaw option in networking.wireless.networks
2019-03-05 04:27:15 +02:00
Guillaume Maudoux
473a3ef606 nixos/manual: add dummy ids to silence warnings 2019-02-08 10:23:57 +01:00
Matthew Bauer
6604240a4b nixos/manual: use default bs value
Apparently this is a little slower but much safer & not prone to
potential argument errors.
2019-01-26 22:48:32 -05:00
Matthew Bauer
1ff9a93e1c nixos/doc: bs=1000000 for dd args (#54280)
Not all dd implementations take ‘bs=1m’. Better to just list it out
fully to reduce potential for problems.

Fixes #54181.
2019-01-18 19:19:00 +02:00
step21
586bbd20e8 nixos/nixpkgs: virtualbox docs update (#54247) 2019-01-18 09:22:15 +00:00
Samuel Dionne-Riel
467bec34bb nixos/doc: Actually fix partitioning instructions.
The previous tentative to the fix got the order mixed up a bit. This
new fix has been re-verified to get them in the good order as per the
instructions in the following chapters.
2018-10-08 12:35:04 -04:00
Samuel Dionne-Riel
6cfbf403ca doc: Reviews partitioning instructions to use parted.
The tests in <nixos/tests/installer.nix> are using `parted`, so they are
bound to be better tested than `fdisk`.

This is brought on by a couple issues, plus reports on IRC that the
`fdisk` instructions didn't work as expected.

 * #39354
 * #46309
 * #39942
 * #45478

Care was taken so that the other documented steps did not need changes.

In all this kerfufle, a slight re-organization of the Chapter has been
made, allowing better deep linking.
2018-10-03 22:34:58 -04:00
Samuel Dionne-Riel
8467dc857b doc: installing-usb: removes notes about unetbootin.
They are known to cause more issues than solving issues; futhermore
using `dd` should work everywhere without fail.
2018-10-03 22:34:58 -04:00
Samuel Dionne-Riel
8192fcd0fd doc: installing-usb make macOS note a note.
While it seemingly brings more attention to the macOS notes with the
default docbook template, it better represents which parts of the
section are about macOS, and which parts are simply in the flow of the
text; otherwise the last paragraph may be lost into the details for
macOS.
2018-10-03 22:34:57 -04:00
Graham Christensen
8413f22bb3
docs: format 2018-09-29 20:51:11 -04:00
Sarah Brofeldt
66f6105978 nixos/doc: Add stable pre-release warning (#46473) 2018-09-11 15:42:15 +02:00
Graham Christensen
18fd616351
nixos docs: Give sections IDs 2018-09-01 16:20:49 -04:00
Venkateswara Rao Mandela
cb1ca42009 nixos/doc: add instructions for installation behind a proxy (#45854)
The instructions to install nixos behind a proxy were not clear. While
one could guess that setting http_proxy variables can get the install
rolling, one could end up with an installed system where the proxy
settings for the nix-daemon are not configured.

This commit updates the documentation with

1. steps to install behind a proxy

2. configure the global proxy settings so that nix-daemon can access
internet.

3. Pointers to use nesting.clone in case one has to use different proxy
settings on different networks.
2018-09-01 16:12:35 +02:00
Sarah Brofeldt
05d85a267f nixos/doc: New installer note on unattended installs 2018-08-19 19:54:10 +02:00
Florian Klink
6cabce9abd manual: rename users.extraUsers to users.users
Is called like this since 14321ae243, but
docs were still using the old option in some cases.

Reported-By: Cedric Shahabi <cedric.shahabi@gmail.com>
2018-06-28 23:54:02 +02:00
Samuel Dionne-Riel
88ca2b1ec4 nixos/doc: ran make format
With visual inspection that nothing got worse.
2018-05-31 21:03:51 -04:00
Walter Franzini
205a9f2576 minor improvement to nix installation instructions (#40521)
* improve nix installation instructions

in the command

	$ bash <(curl https://nixos.org/nix/install)

<(..) is a bashism.  The documentation now show a command that does
not require to be executed by bash.
2018-05-16 00:23:00 -05:00
Graham Christensen
eca5c99bf8
nixos docs: format =) 2018-05-01 19:57:09 -04:00
edef
1a18fedae4 nixos doc: mananager -> manager 2018-05-01 19:58:50 +02:00
Graham Christensen
d1165dba99
Merge pull request #38831 from rdnetto/improve-cross-refs
Improve cross referencing in NixOS Manual
2018-04-30 21:30:20 -04:00
Christian Kauhaus
bca80d67a0 Clarify installation steps w.r.t. disk partitions
- mkfs.fat needs `-n` to set a partition label, not `-L`.
- create /mnt/boot before mounting
- leave out detailed LVM example as advanced users already how to create
  LVs while it is detracting for novices.

Re #38674
2018-04-17 14:29:07 +02:00
Reuben D'Netto
7292c5a570 Fixed indentation 2018-04-17 09:19:55 +10:00
Raphael Das Gupta
368947a3a5
nixos manual: add missing space after "copytoram" 2018-04-16 01:14:23 +02:00
Reuben D'Netto
42a84598fb Added cross-references to NixOS manual 2018-04-12 09:39:14 +10:00
obadz
ee9a785c30 nixos doc: give context and definition re NIXOS_LUSTRATE
Re #36272
2018-03-07 01:23:20 +00:00
obadz
7af0aa846e nixos doc: document the installation process from other distros as well as NIXOS_LUSTRATE 2018-03-04 16:19:52 +00:00
Ben Creasy
385369eeb2 nixos/doc: document password-promptless installation (#35210) 2018-02-20 08:59:13 +00:00
Markus Hauck
0525e82392 docs: Explain how to login into built vm 2018-02-07 21:34:50 +01:00
Rommel Martinez
f716cdb9be nixos manual: fix typo 2018-01-22 09:39:24 +02:00
Matthieu Coudron
8b9429008e doc: add wpa_supplicant command to connect to wifi
New thin laptops don't have an ethernet port and so rely on wifi to get
access. With the minimal installer, setup wpa_supplicant can be hard if
it is the first time so here we provide an example.
2018-01-22 11:54:17 +09:00
Vincent Murphy
bd09ef9c21
Update macos USB instructions
"Ejecting" from the Finder ejects the entire device which is then not available for dd. diskutil unmountDisk does the right thing. Furthermore writing to diskN instead of rdiskN failed to complete even after waiting >10 minutes.
2018-01-06 18:13:58 +00:00
Samuel Dionne-Riel
0e6346f16a doc: Obtaining NixOS: New link to section in wiki.
This adds a link to the new section in the new wiki that refers to the
same contents as the previously removed link.
2018-01-03 19:35:40 -05:00
Samuel Dionne-Riel
dd602120a0 doc: Obtaining NixOS now refers to USB media creation chapter.
This:

 * Removes contradiction with information in the later paragraph.
 * Removes a dead link to the Wiki.
2018-01-03 19:34:32 -05:00