Commit graph

195 commits

Author SHA1 Message Date
Matthew Harm Bekkema
a6c7132abc doc: change git:// links to https:// (#44395)
The server is not verified over the git:// transfer protocol. If you
clone a repository over git://, you should check if the latest commit's
hash is correct.

On the other hand, https:// will always verify the server automatically,
using certificate authorities.
2018-08-03 14:01:34 +01:00
Florian Klink
329983f6c7 manual: rename user added to networkmanager from "youruser" to "alice"
to be consistent with the rest of the manual

Reported-By: Cedric Shahabi <cedric.shahabi@gmail.com>
2018-06-28 23:54:35 +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
Matthieu Coudron
eb7e0d42db doc: Explain how to hack on kernel
Presents the options available (linuxManualConfig versus overriding
extraConfig, ignoreConfigErrors, autoModules, kernelPreferBuiltin.

For advanced hostPlatform customization refer to the commands shared by ericson1234 at
https://github.com/NixOS/nixpkgs/pull/33813 but it is too advanced to
put in the doc.
2018-06-08 10:36:21 +03: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
aszlig
a7f79620ac
nixos: Fix build of the manual
The manual still had a reference to an option that was already renamed
ages ago and a7ed44ccad made it 'visible'.

With the visible attribute set to false for extraKernelModules, the
option no longer appears in the manual and thus breaks the link from the
manual to the options.

This is easily fixed by referring to boot.initrd.kernelModules instead
of the obsolete option boot.initrd.extraKernelModules.

Signed-off-by: aszlig <aszlig@nix.build>
Cc: @rycee, @matthewbauer
2018-05-15 14:54:57 +02:00
Graham Christensen
eca5c99bf8
nixos docs: format =) 2018-05-01 19:57:09 -04: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
Graham Christensen
59f8b1e844
nixos docs: Move generated XML in to a specific subdirectory to allow easier hacking 2018-04-27 22:44:51 -04:00
Felix Dietze
2ac306c91c
nixos manual: Fix typo in Syntax Summary 2018-04-24 21:57:51 +02:00
Reuben D'Netto
7292c5a570 Fixed indentation 2018-04-17 09:19:55 +10:00
Reuben D'Netto
42a84598fb Added cross-references to NixOS manual 2018-04-12 09:39:14 +10:00
Ben Creasy
e8ddba2bcf
Remove Xfce-specific display manager tip
This is already covered in the previous chapter https://github.com/NixOS/nixpkgs/blob/master/nixos/doc/manual/configuration/x-windows.xml#L38-L46 - Xfce also depends on X and it doesn't need a special section on display managers.
2018-02-19 15:18:07 -08:00
rnhmjoj
c1bed05e34
nixos/networking-interfaces: rename IP addresses/routes options 2018-02-17 14:01:24 +01:00
Orivej Desh
b679079045
Merge pull request #32540 from rnhmjoj/portrange
nixos/doc: document the firewall port ranges options
2017-12-20 23:51:08 +00:00
rnhmjoj
63af1f7807
nixos/doc: document the firewall port ranges options 2017-12-21 00:46:34 +01:00
Yegor Timoshenko
a0aeb2381e doc: system.environmentPackages -> environment.systemPackages 2017-12-20 02:19:43 +00:00
Bert Moens
a5398a7663 nixos/doc/x-windows: update touchpad to libinput 2017-12-03 05:05:21 +02:00
Rovanion Luckey
99864c4a79 nixos/manual: extraUsers -> users in user-mgmt.xml
Changed extraUsers -> users and one case of extraGroups -> groups in nixos manual chapter 7.

According to chatter on IRC these are the proper names for these configuration options nowadays.

Modified based on feedback from Jörg Talheim.
2017-11-23 10:22:00 +01:00
Robert
1b1fc65505 NixOS Manual: document assertions and warnings (#29206)
* NixOS Manual: document assertions and warnings

* NixOS manual: re-wrap assertions text
2017-09-11 17:12:50 +01:00
Manuel Bärenz
858c47c18e Manual: Add paragraph on xserver keyboard layout 2017-06-17 21:37:25 +02:00
Vladimír Čunát
eb4792a03f
nixos manual: add a note about "nofail" FS option
Close #1858, as I think the points have been well resolved.
2017-04-30 14:10:30 +02:00
Matthias Beyer
87f57de8e5 Wrap command in <command> 2017-03-05 14:21:45 +01:00
Matthias Beyer
0a18a56375 nixos doc xfce: Tabs -> spaces 2017-03-05 14:20:49 +01:00
Matthias Beyer
1e3dec3baa nixos doc xfce: Fix missing space 2017-03-05 14:20:48 +01:00
Matthias Beyer
c56587eb30 doc: Remove indention from program listings 2017-03-05 14:20:47 +01:00
Thomas Tuegel
ecb65eceaa
nixos/doc/manual: rename plasma5 desktop 2017-03-03 07:29:16 -06:00
Jörg Thalheim
27d4f8c717 Merge pull request #23046 from Zimmi48/patch-2
nixos/manual/networkmanager: add info on nm-applet
2017-02-22 01:40:50 +01:00
Théo Zimmermann
0994d6af9d nixos/manual/networkmanager: add info on nm-applet 2017-02-21 15:20:10 +01:00
Théo Zimmermann
361d730f35 nixos/manual/xserver: propose more alternatives 2017-02-21 14:56:26 +01:00
Linus Heckemann
b4cd251c54 Manual: document users.users.<name>.hashedPassword 2017-02-13 13:54:40 +01:00
Vladimír Čunát
d4bf624f96
nixos manual: add grub option to avoid #21830
Close #22659.  vcunat edited this slightly.
2017-02-11 12:47:15 +01:00
Graham Christensen
b12564cc1b
nixos: update default cases from KDM/KDE4 to SDDM/KDE5 2017-02-09 21:52:00 -05:00
Vladimír Čunát
a0505989c9
Xfce docs nitpicks
- fix validity
- XFCE -> Xfce, as that seems to be upstream preference
2017-02-09 18:38:01 +01:00
Matthias Beyer
de592483d1 Add xfce documentation 2017-02-07 17:55:40 +01:00
Matthias Beyer
bf56d17b2c fixup! Add documentation for XFCE 2017-02-06 09:17:52 +01:00
Matthias Beyer
4b5a230d1d Add documentation for XFCE 2017-02-06 09:10:05 +01:00
Nikolay Amiantov
4feb0a998a manual: mention needed options for IPv6 2017-02-02 01:53:00 +03:00
Domen Kožar
073cb330ca doc: remove last mention of <nixos> 2016-12-11 19:51:35 +01:00
Vladimír Čunát
559ddae410
nixos manual: clarify "attributes of function" 2016-11-05 11:02:04 +01:00
Aneesh Agrawal
3d99eea852 docs: use overrideAttrs instead of overrideDerivation 2016-10-30 14:34:40 -04:00
Langston Barrett
2ab6020930 nixos manual: disable ipv6 per interface
from a discussion on #13293
2016-09-08 18:12:05 +00:00
Langston Barrett
ee501fd49a networkmanager: add information from wiki to docs (#18245)
* networkmanager: add information from wiki to docs

Specifically:
 * mention nmcli, nmtui
 * mention gtk and kde applets

fixes #13273
2016-09-05 11:13:47 +02:00
Eric Sagnes
b50e627ef6 nixos manual: cleanup generation 2016-08-30 09:40:05 +09:00
Joachim Fasting
dab32a1fa6
nixos manual: move chapter on grsecurity to auto-generated module docs 2016-08-29 23:48:12 +02:00
Domen Kožar
e01e92f12f Merge pull request #15025 from ericsagnes/modules/manual
manual: automatically generate modules documentation
2016-08-28 13:57:34 +02:00
Joachim Fasting
f9c3076e58
grsecurity docs: mention chromium setuid sandbox 2016-08-15 20:36:47 +02:00
Joachim Fasting
567640d80c
grsecurity docs: add note about user namespaces 2016-08-15 20:36:46 +02:00
Eric Sagnes
898435d16e manual: automatically generate modules entries 2016-08-11 00:24:41 +09:00
Joachim F
772a7bb49b Merge pull request #17425 from joachifm/grsec-efi
grsecurity module: disable EFI runtime services by default
2016-08-03 10:48:25 +02:00
Rodney Lorrimar
6711e62d51 nixos manual: add Emacs section (fixes #13217)
In light of Emacs packaging improvements such as those mentioned
in #11503, and with the addition of a systemd service (#15807
and #16356), and considering that the wiki page is completely
out of date (#13217), it seems that some documentation is in order.
2016-08-02 11:17:52 +01:00
Joachim Fasting
43fc394a5c
grsecurity module: disable EFI runtime services by default
Enabling EFI runtime services provides a venue for injecting code into
the kernel.

When grsecurity is enabled, we close this by default by disabling access
to EFI runtime services.  The upshot of this is that
/sys/firmware/efi/efivars will be unavailable by default (and attempts
to mount it will fail).

This is not strictly a grsecurity related option, it could be made into
a general option, but it seems to be of particular interest to
grsecurity users (for non-grsecurity users, there are other, more
immediate kernel injection attack dangers to contend with anyway).
2016-08-02 10:24:49 +02:00
Joachim Fasting
190890cdac
nixos manual: add chapter on grsecurity/PaX
Explain the "what", "why", and "how" of grsecurity/PaX
on NixOS.
2016-07-23 19:09:43 +02:00
Nikolay Amiantov
1dfdc3e521 nixos manual: fix syntax
It appears I've cherry-picked wrong commit without this fix.
2016-06-03 19:23:17 +03:00
Nikolay Amiantov
1942957b53 nixos manual: document Gtk and Qt themes 2016-06-03 19:14:52 +03:00
Wilhelm Schuster
5f8d14546b Manual: Explicitly mark commands that require to be run as root (#15589)
* manual: Mark commands that require root

Mark every command that requires to be run as root by prefixing them
with '#' instead of '$'.

* manual: Add note about commands that require root
2016-06-01 15:23:32 +01:00
Eelco Dolstra
845c9b50bf boot.initrd.luks.devices: Change into an attribute set
This allows setting options for the same LUKS device in different
modules. For example, the auto-generated hardware-configuration.nix
can contain

  boot.initrd.luks.devices.crypted.device = "/dev/disk/...";

while configuration.nix can add

  boot.initrd.luks.devices.crypted.allowDiscards = true;

Also updated the examples/docs to use /disk/disk/by-uuid instead of
/dev/sda, since we shouldn't promote the use of the latter.
2016-05-25 18:04:21 +02:00
Joachim Fasting
d9796f44f6
manual: minor cleanups 2016-05-22 20:01:52 +02:00
Domen Kožar
9d745c6795 typo 2016-05-20 13:55:48 +01:00
Domen Kožar
2d6d731f24 nixos: add a small section about kernel module dev 2016-05-20 11:55:38 +01:00
iarizc Leuname
7e32b83d77 Manual: rephrase definition for indented strings
Closes #15076
2016-04-30 16:59:07 +03:00
Domen Kožar
d2dcbd3c00 Revert "Manual: rephrase definition for indented strings" (#15103) 2016-04-30 14:29:09 +01:00
NotaseCretagen
e704c90b50 Manual: rephrase definition for indented strings (#15086)
Closes #15076
2016-04-30 12:14:06 +01:00
aszlig
9ed9e268a2
Merge pull request #14476 (taskserver)
This adds a Taskserver module along with documentation and a small
helper tool which eases managing a custom CA along with Taskserver
organisations, users and groups.

Taskserver is the server component of Taskwarrior, a TODO list
application for the command line.

The work has been started by @matthiasbeyer back in mid 2015 and I have
continued to work on it recently, so this merge contains commits from
both of us.

Thanks particularly to @nbp and @matthiasbeyer for reviewing and
suggesting improvements.

I've tested this with the new test (nixos/tests/taskserver.nix) this
branch adds and it fails because of the changes introduced by the
closure-size branch, so we need to do additional work on base of this.
2016-04-15 00:21:49 +02:00
Eric Sagnes
de78fe8f2d manual: add chapter on input methods 2016-04-12 19:50:16 +09:00
aszlig
64e566a49c
nixos/taskserver: Add module documentation
It's not by any means exhaustive, but we're still going to change the
implementation, so let's just use this as a starting point.

Signed-off-by: aszlig <aszlig@redmoonstudios.org>
2016-04-07 14:26:12 +02:00
Eelco Dolstra
d4636fa254 Revert "Add a way to pin a NixOS version within the module system."
This reverts commit a5992ad61b. Motivation:

a5992ad61b (commitcomment-14986820)
2016-02-27 20:48:12 +01:00
Franz Pletz
cd0f14f23e gitlab: Add documentation
Fixes #13303.
2016-02-26 08:56:39 +01:00
Aneesh Agrawal
3c5fca9618 filesystems: use list of strings for fs options
Allow usage of list of strings instead of a comma-separated string
for filesystem options. Deprecate the comma-separated string style
with a warning message; convert this to a hard error after 16.09.
15.09 was just released, so this provides a deprecation period during
the 16.03 release.

closes #10518

Signed-off-by: Robin Gloster <mail@glob.in>
2016-02-06 19:48:30 +00:00
Joachim Schiele
2a88417f03 nixos/doc: fix to: ~/.nix-defexpr wasn't created, fixes #6606 2016-01-20 04:59:16 +01:00
Robin Gloster
246f0e91cd wpa_supplicant service: Warn about plaintext keys in docs 2016-01-06 03:58:39 +00:00
Robin Gloster
d03b35f881 wpa_supplicant module: add networks option 2016-01-06 03:58:39 +00:00
Peter Simons
49d18bdfcb Revert "Basic Declaritive Network Configuration in wpa_supplicant Service" 2016-01-05 19:32:41 +01:00
Robin Gloster
56a53ff458 wpa_supplicant module: add networks option 2015-12-29 18:49:39 +00:00
Franz Pletz
1685b9d06e nixos/acme: Add module documentation 2015-12-12 16:06:53 +01:00
Nicolas B. Pierron
a5992ad61b Add a way to pin a NixOS version within the module system.
This modification add a way to re-evaluate the module system with a
different version of NixOS, or with a different set of arguments.
2015-11-19 20:58:45 +00:00
Bjørn Forsman
bd84ebaa1e nixos: document nvidia legacy driver options 2015-09-02 13:25:50 +02:00
Eelco Dolstra
2cd7c1f198 Unify NixOS and Nixpkgs channel structure
This is primarily to ensure that

  -I nixpkgs=https://nixos.org/channels/nixos-unstable/nixexprs.tar.xz

and

  -I nixpkgs=https://github.com/NixOS/nixpkgs-channels/archive/nixos-unstable.tar.gz

and

  -I nixpkgs=https://nixos.org/channels/nixpkgs-unstable/nixexprs.tar.xz

behave consistently.

It also allows installing packages via "nix-env -iA nixos.<pkg>"
rather than "nixos.pkgs.<pkg>". It would be even better to allow
"nixpkgs.<pkg>", but that requires a change to nix-channel.

Fixes #7659.
2015-08-05 17:37:11 +02:00
Vladimír Čunát
dfaded0b8e nixos docs: fix typo 2015-03-07 14:44:13 +01:00
Nikita Mikhailov
25e29b3870 Correct NetworkManager documentation 2015-02-24 22:09:36 +05:00
Khalid Jebbari
b385d14b81 Fix typo in recursive set example 2015-01-04 19:28:16 +01:00
Domen Kožar
91bdca38a0 NetworkManager.service -> network-manager.service 2014-11-27 12:10:20 +01:00
Rene Donner
8bd2f6bfc1 some typos 2014-11-14 13:05:55 +01:00
Mateusz Kowalczyk
1ffe41b34f Merge branch 'dev/ati-drivers' of https://github.com/nathanielbaxter/nixpkgs 2014-09-22 01:27:00 +01:00
Eelco Dolstra
585983bc95 Merge remote-tracking branch 'origin/staging'
Conflicts:
	pkgs/applications/version-management/subversion/default.nix
2014-09-08 11:42:09 +02:00
Nathaniel Baxter
5856fbc7d2 nixos-manual: Fix reference to obsolete configuration option 2014-09-07 11:58:06 +02:00
Nathaniel Baxter
fb9a6221b6 ati_unfree: Update nixos-manual for AMD driver support 2014-09-07 12:42:32 +10:00
Peter Simons
1c0d15b90e Merge branch 'origin/master' into staging.
Conflicts:
	pkgs/development/libraries/ffmpeg/2.x.nix
	pkgs/development/libraries/serf/default.nix
2014-09-02 12:31:03 +02:00
William A. Kennington III
3d037ebb94 Revert "Revert "Merge pull request #3182 from wkennington/master.ipv6""
This reverts commit ea8910652f.
2014-08-31 09:46:16 -07:00
Rob Vermaas
ea8910652f Revert "Merge pull request #3182 from wkennington/master.ipv6"
This reverts commit b23fd65854, reversing
changes made to 43654cba2c.
2014-08-31 10:58:54 +02:00
William A. Kennington III
86c0f8c549 Refactor nixos files relying on the old ipAddress / prefixLength / subnetMask attributes 2014-08-30 07:33:38 -07:00
Vladimír Čunát
e51f73652d Merge recent master into staging
Hydra: ?compare=1149952

Conflicts:
	nixos/doc/manual/configuration.xml (changed split file)
	nixos/modules/config/users-groups.nix (choosing filterNull instead of inline definition)
	pkgs/development/libraries/readline/readline6.3.nix (auto-solved)
2014-08-30 10:04:02 +02:00
Eelco Dolstra
41788255ab Manual: Start of module-specific documentation 2014-08-27 12:24:44 +02:00
Eelco Dolstra
60e6cc81b5 No caps in filenames 2014-08-26 19:04:02 +02:00
Mikey Ariel
a099ca4505 Chunk NixOS manual
[Squashed commits to make git blame etc. more likely to work. -ED]
2014-08-26 19:03:49 +02:00