Skip to content

nixos/manual: document auto-login #57561

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 27, 2019
Merged

nixos/manual: document auto-login #57561

merged 2 commits into from
Apr 27, 2019

Conversation

aaronjanse
Copy link
Member

#29526: document x11 auto-login

Motivation for this change

fix #29526

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nox --run "nox-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Assured whether relevant documentation is up to date
  • Fits CONTRIBUTING.md.

Sorry, something went wrong.

@GrahamcOfBorg GrahamcOfBorg added 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: documentation This PR adds or changes documentation 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10 labels Mar 13, 2019
<para>
To enable auto-login, you need to define your default window manager and
desktop environment. If you wanted no desktop environment and i3 as your your
windowzmanager, you'd define:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

windowmanager

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed. Thank you

@jtojnar
Copy link
Member

jtojnar commented Mar 15, 2019

Do we really want to duplicate every option in the manual itself? Domen’s suggestion sounds better to me:

Issue tracker is good. I think these docs should be in autoLogin.enable description

Also, would not it be better to improve the option defaults as described in the issue?

If only one displayManager and one windowManager is enabled, I'd expect the defaults to be set to automatically. The setup above seems unnecessarily verbose.

@aaronjanse
Copy link
Member Author

Defaults being set automatically makes sense.

Of course auto-login is something that should be enabled manually.

Unlike a lot of other options in the manual, I'd argue that auto-login is not something many users would know about. Therefore, unlike nginx etc, users would not know to look for it if it was not easily discoverable in the manual

I think it's placement after the window manager & desktop environment section should make it very discoverable for new users.

@Lassulus Lassulus merged commit f099d3d into NixOS:master Apr 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: documentation This PR adds or changes documentation 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document autoLogin setup and/or improve default behaviour
6 participants