Commit Graph

194 Commits

Author SHA1 Message Date
Asad Saeeduddin
ebbd29d695
nixos/doc: clarify command template parameter
squash-reworded from #284844
2024-05-14 00:05:24 +02:00
Arnaud Venturi
a01a9a3f5f doc: Fix nixos download page links
Those two links are currently broken, update them to point to the
up-to-date nixos download page.
2024-05-13 12:54:22 +02:00
Bjørn Forsman
74c1547424 nixos/doc: suggest mounting the ESP on /boot with umask=077
This prevents world-readable access to /boot, which is a security issue
that systemd-boot warns about.

Fixes https://github.com/NixOS/nixpkgs/issues/279362.
2024-04-10 19:34:07 +02:00
Janne Heß
fcc95ff817 treewide: Fix all Nix ASTs in all markdown files
This allows for correct highlighting and maybe future automatic
formatting. The AST was verified to work with nixfmt only.
2024-03-28 09:28:12 +01:00
Peder Bergebakken Sundt
298957b767
Merge pull request #283238 from D3vil0p3r/patch-1
doc: add note in Partitioning and formatting section
2024-03-10 04:01:18 +01:00
Moritz Sanft
66deaec720
nixos/appliance-repart-image: use UKI in docs 2024-02-07 17:45:22 +01:00
D3vil0p3r
67bfaf3d03
doc: add note in Partitioning and formatting section 2024-01-23 15:55:44 +01:00
Jörg Thalheim
745142de59
Merge pull request #263794 from Mic92/more-dd-flags
docs/installation-usb: add more flags to dd
2024-01-14 13:29:09 +01:00
Robert Hensing
0e062cb692 nixos-rebuild: Add nixos-rebuild repl
Apologies to the non-flake users; your repl isn't quite as fancy,
but at least evaluates your config exactly as you would expect,
unlike flakes which are only evaluated impurely for now.
2023-12-10 06:36:02 +01:00
figsoda
04220ed676
Release NixOS 23.11 2023-11-29 12:17:49 -05:00
Niklas Hambüchen
f9611764c6 manual: Fix QEMU_NET_OPTS VM-side address.
In my earlier commit

    manual: Don't suggest exposing VM port to local network.

I made a side change titled

    Use `127.0.0.1` also on the VM side, otherwise connections to
    services that, in the VM, bind to `127.0.0.1` only
    (doing the safe approach) do not work.

Unfortunately, that was wrong:

QEMU inside the VM always communicates via the virtualised
Ethernet interface, not via the VM's loopback interface.
So trying to connect to `127.0.0.1` on the VM's side cannot work.
2023-11-11 15:40:55 +01:00
Niklas Hambüchen
5d73d954cd manual: Don't suggest exposing VM port to local network.
The setting

    QEMU_NET_OPTS="hostfwd=tcp::2222-:22"

caused the VM's port 2222 to be advertised on the host as
`0.0.0.0:2222`, thus anybody in the local network of the host
could SSH into the VM.
Instead, port-forward to localhost only.

Use `127.0.0.1` also on the VM side, otherwise connections to
services that, in the VM, bind to `127.0.0.1` only
(doing the safe approach) do not work.

See e.g. https://github.com/NixOS/nixpkgs/issues/100192
for more info why localhost listening is the best default.
2023-11-10 22:29:12 +01:00
Arnout Engelen
97b0ae26f7
doc: avoid 'simply' (#266434)
While the word 'simply' is usually added to encourage readers, it often has the
opposite effect and may even appear condescending, especially when the reader
runs into trouble trying to apply the suggestions from the documentation. It is
almost always an improvement to simply drop the word from the sentence.

(there are more possible improvements like this, we can apply those in separate
PRs)
2023-11-09 21:48:05 +01:00
nikstur
84722633b7 nixos/image: move docs into manual 2023-10-31 11:27:56 +01:00
Jörg Thalheim
3c2efe61dc docs/installation-usb: add more flags to dd
oflag=direct is faster for writing because it by-passes the page cache
status=progress shows speed and progress
2023-10-27 16:08:26 +02:00
Pol Dellaiera
5763cc6221
Merge pull request #232491 from 6t8k/20230517_nixos_manual_installing_partitioning
nixos/manual: rectify partitioning commands for UEFI/GPT
2023-07-26 15:12:51 +02:00
Raito Bezarius
b8c2962807 nixos/doc/manual/installation: update the upgrading chapter for 23.05 2023-05-30 16:42:53 +02:00
6t8k
f652c83354
nixos/manual: rectify partitioning commands for UEFI/GPT
For GPT partition tables, there is no primary/logical/extended
partition type, and the layout of the mkpart command options slightly
differs depending on whether parted operates on an MBR or a GPT
partition table.

This has so far resulted in the string `primary` being assigned to the
GUID partition name field, which is probably unintended.

Rectify this by giving the GUID partitions sensible names and setting
`fs-type` where applicable.
2023-05-17 21:28:11 +02:00
pennae
407f6196a2 nixos-render-docs: add examples support
the nixos manual contains enough examples to support them as a proper
toc entity with specialized rendering, and if in the future the nixpkgs
wants to use nixos-render-docs we will definitely have to support them.
this also allows us to restore some examples that were lost in previous
translation steps because there were too few to add renderer support
back then.
2023-05-03 19:58:21 +02:00
D Anzorge
bf02778b76 nixos/manual: fix typos in install instructions 2023-02-22 15:40:33 +01:00
pennae
1229e735ac nixos-render-docs: add structural includes, use for manual
this adds support for structural includes to nixos-render-docs.
structural includes provide a way to denote the (sub)structure of the
nixos manual in the markdown source files, very similar to how we used
literal docbook blocks before, and are processed by nixos-render-docs
without involvement of xml tooling. this will ultimately allow us to
emit the nixos manual in other formats as well, e.g. html, without going
through docbook at all.

alternatives to this source layout were also considered:

a parallel structure using e.g. toml files that describe the document
tree and links to each part is possible, but much more complicated to
implement than the solution chosen here and makes it harder to follow
which files have what substructure. it also makes it much harder to
include a substructure in the middle of a file.

much the same goes for command-line arguments to the converter, only
that command-lined arguments are even harder to specify correctly and
cannot be reasonably pulled together from many places without involving
another layer of tooling. cli arguments would also mean that the manual
structure would be fixed in default.nix, which is also not ideal.
2023-02-12 13:02:42 +01:00
pennae
1c9f55ec64 nixos/manual: convert <kbd> elements to bracketed spans
since support for kbd elements was added with explicit intent in #175128
it seems like a good idea to support this in nixos-render-docs instead
of just dropping it in favor of `*F12*` etc. since it's a very rare
thing in the manual and purely presentational it makes sense to use
bracketed spans instead of a new myst role.

the html-elements.lua plugin is now somewhat misnamed, but it'll go away
very soon so we don't want to bother renaming it.
2023-02-10 06:40:01 +01:00
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