aboutsummaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Expand)Author
2020-09-15services: docker: Fix service definition....This commit follows a404716d411cf7cd49ff02e3100f0bbf6622d6d5. * gnu/services/docker.scm (docker-configuration)[docker-cli]: New record field. (docker-service-type): Use this. * doc/guix.texi (Miscellaneous Services)[Docker Service]: Document this. Oleg Pykhalov
2020-09-14doc: Fix docker configuration options....* doc/guix.texi (Docker Service): Fix typo in enable-proxy? default. Efraim Flashner
2020-09-13services: certbot: Support registration without email....* gnu/services/certbot.scm (certbot-configuration): Add default for the email option. (certbot-command): Pass email for registration only when specified. * doc/guix.texi (Certificate Services): "mandatory"→"optional" email. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Timotej Lazar
2020-09-12doc: Document the use of snippets vs phases....* doc/contributing.texi (Snippets versus phases): New section. Maxim Cournoyer
2020-09-11Revert "services: dovecot: Use modules via symlink to system profile."...This reverts commit bcfe0f0c1e9a2b91049d7c6c591c7f0c6a002c14 for now. It breaks most current use(r)s of the Dovecot service and needs to be combined with an extra modules configuration field of some kind. See <https://issues.guix.gnu.org/43347>. Tobias Geerinckx-Rice
2020-09-11doc: Distinguish the "nar bundle" format from "nar"....* doc/guix.texi (Invoking guix archive): Introduce the term "nar bundle" and clarify what the output of "guix archive --export" really is. * guix/nar.scm (restore-one-item, restore-file-set): Use the term "nar bundle" in docstrings. Ludovic Courtès
2020-09-10services: php-fpm: Add 'php-ini-file' configuration....* gnu/services/web.scm: (<php-fpm-configuration>)[php-ini-file]: New record field. (php-fpm-shepherd-service): Use it. * doc/guix.texi (Web Services): Document it. Jelle Licht
2020-09-09services: dovecot: Use modules via symlink to system profile....* gnu/services/mail.scm (%dovecot-activation): Link the location with multiple plugins (dovecot-pigeonhole, etc), to a place where dovecot can find them. * gnu/services/mail.scm (dovecot-configuration): Use the symlink. Signed-off-by: Tobias Geerinckx-Rice <me@tobias.gr> Alexey Abramov
2020-09-09doc: cookbook: Adding a section "Running Guix on a Linode Server"...* doc/guix-cookbook.texi (Running Guix on a Linode Server): I added a section that explains how to run guix on a linode server. Thanks Chris Webber! Signed-off-by: Ludovic Courtès <ludo@gnu.org> Joshua Branson
2020-09-08doc: Tweak .texi to avoid po4a-translate infinite loop....* doc/guix.texi (Requirements): Keep @uref on one line as splitting it would lead po4a-translate to enter an infinite loop. Ludovic Courtès
2020-09-08Remove (guix json) and require Guile-JSON 4.3.0+....This is a followup to 4071879c86d059ee087c8986915ea72b8c742b72. * guix/json.scm: Remove. * Makefile.am (MODULES): Adjust accordingly. * m4/guix.m4 (GUIX_CHECK_GUILE_JSON): Check for 'define-json-mapping'. * doc/guix.texi (Requirements): Require Guile-JSON 4.3.0+. * guix/ci.scm, guix/cve.scm, guix/import/cpan.scm, guix/import/crate.scm, guix/swh.scm: Remove (guix json) import. * guix/import/gem.scm, guix/import/pypi.scm: Likewise, and import (json). * guix/self.scm (specification->package): Switch to GUILE-JSON-4. * guix/git-download.scm (git-fetch): Likewise. Ludovic Courtès
2020-09-04doc: Document 'file-system-label' and 'uuid'....* doc/guix.texi (File Systems): Document 'file-system-label' and 'uuid'. Ludovic Courtès
2020-09-04doc: Syntax highlighting now handles @var within @lisp....* doc/build.scm (syntax-highlighted-html)[build](concatenate-pieces): Handle @var{name}. Ludovic Courtès
2020-09-04doc: Balance parens in R Shiny example....* doc/guix.texi (Miscellaneous Services): Balance parens in R Shiny example. Ludovic Courtès
2020-09-03doc: Add "Getting Started" section....* doc/guix.texi (Getting Started): New node. (Binary Installation): Refer to it and to "Application Setup". (After System Installation): Refer to "Getting Started". (Features): Add introductory sentence. Ludovic Courtès
2020-09-01services: childhurd: Support installing secrets from the host....* gnu/services/virtualization.scm (%hurd-vm-operating-system): Add secret-service. (hurd-vm-shepherd-service): Use it to install secrets. * doc/guix.texi (The Hurd in a Virtual Machine): Document it. Jan (janneke) Nieuwenhuizen
2020-09-01gexp: computed-file: Prevent mistakenly overriding default option values....In order to do so, default to an empty options list, and expose options whose default values are sensitive directly as keyword arguments. * guix/gexp.scm (computed-file): Extract the LOCAL-BUILD? parameter from the OPTIONS parameter to make it a stand-alone keyword argument. Introduce an OPTIONS* binding which is obtained by combining the LOCAL-BUILD? keyword and its value with OPTIONS. * doc/guix.texi (G-Expressions): Adjust doc. Suggested-by: Ludovic Courtès <ludo@gnu.org> Maxim Cournoyer
2020-08-31guix: system: Add `--label' option....* guix/scripts/system.scm (%options): Add `--label'. (system-derivation-for-action): Take a #:label key to set volume ID. (perform-action): Take a #:label key. (%default-options): Add default label value. (process-action): Pass label value from command-line to perform-action. * gnu/system/image.scm (image-with-label): New procedure. Julien Lepiller
2020-08-28doc: Document the 'description' and 'default-value' of <service-type>....* doc/guix.texi (Service Reference): Document the 'description' and 'default-value' fields of <service-type>. Ludovic Courtès
2020-08-27doc: Improve the instructions regarding `guix git authenticate`....* doc/contributing.texi (Building from Git): Instruct the user to fetch the 'keyring' branch. Fix a typo. Signed-off-by: Leo Famulari <leo@famulari.name> Joshua Branson
2020-08-25offload: Modify the build-machine record to accept multiple systems....* guix/scripts/offload.scm (<build-machine>)[systems]: New field. [system]: Accessor changed to %build-machine-system. Default to #f. * guix/scripts/offload.scm (build-machine-system): Wrap %build-machine-system with a deprecation warning. (build-machine-systems): Access the new systems field or fallback to use build-machine-system, for backward compatibility. (machine-matches?): Adjust. * tests/offload.scm: Add tests... * Makefile.am (SCM_TESTS): ...and register them. * doc/guix.texi (Daemon Offload Setup): Update doc. Maxim Cournoyer
2020-08-25doc: Fix typo....* doc/guix.texi (Virtualization Services): Fix typo. Tobias Geerinckx-Rice
2020-08-24services: unattended-upgrade: Add 'operating-system-file' field....* gnu/services/admin.scm (<unattended-upgrade-configuration>)[operating-system-file]: New field. (unattended-upgrade-mcron-jobs): Honor it. * doc/guix.texi (Unattended Upgrades): Document it. Ludovic Courtès
2020-08-24Use "guile-zlib" and "guile-lzlib" instead of (guix config)....* Makefile.am (MODULES): Remove guix/zlib.scm and guix/lzlib.scm, (SCM_TESTS): remove tests/zlib.scm, tests/lzlib.scm. * build-aux/build-self.scm (make-config.scm): Remove unused %libz variable. * configure.ac: Remove LIBZ and LIBLZ variables and check instead for Guile-zlib and Guile-lzlib. * doc/guix.texi ("Requirements"): Remove zlib requirement and add Guile-zlib and Guile-lzlib instead. * gnu/packages/package-management.scm (guix)[native-inputs]: Add "guile-zlib" and "guile-lzlib", [inputs]: remove "zlib" and "lzlib", [propagated-inputs]: ditto, [arguments]: add "guile-zlib" and "guile-lzlib" to Guile load path. * guix/config.scm.in (%libz, %liblz): Remove them. * guix/lzlib.scm: Remove it. * guix/man-db.scm: Use (zlib) instead of (guix zlib). * guix/profiles.scm (manual-database): Do not stub (guix config) in imported modules list, instead add "guile-zlib" to the extension list. * guix/scripts/publish.scm: Use (zlib) instead of (guix zlib) and (lzlib) instead of (guix lzlib), (string->compression-type, effective-compression): do not check for zlib and lzlib availability. * guix/scripts/substitute.scm (%compression-methods): Do not check for lzlib availability. * guix/self.scm (specification->package): Add "guile-zlib" and "guile-lzlib" and remove "zlib" and "lzlib", (compiled-guix): remove "zlib" and "lzlib" arguments and add guile-zlib and guile-lzlib to the dependencies, also do not pass "zlib" and "lzlib" to "make-config.scm" procedure, (make-config.scm): remove "zlib" and "lzlib" arguments as well as %libz and %liblz variables. * guix/utils.scm (lzip-port): Use (lzlib) instead of (guix lzlib) and do not check for lzlib availability. * guix/zlib.scm: Remove it. * m4/guix.m4 (GUIX_LIBZ_LIBDIR, GUIX_LIBLZ_FILE_NAME): Remove them. * tests/lzlib.scm: Use (zlib) instead of (guix zlib) and (lzlib) instead of (guix lzlib), and do not check for zlib and lzlib availability. * tests/publish.scm: Ditto. * tests/substitute.scm: Do not check for lzlib availability. * tests/utils.scm: Ditto. * tests/zlib.scm: Remove it. Mathieu Othacehe
2020-08-23doc: cookbook: Add chapter about Guix environment....* doc/guix-cookbook.texi (Environment management): New chapter. Oleg Pykhalov
2020-08-17doc: Fix a typo in the AutoSSH service documentation....* doc/guix.texi (Networking Services)[autossh-configuration]: Fix typo. Maxim Cournoyer
2020-08-16services: docker: Add 'enable-iptables?' argument....* gnu/services/docker.scm (docker-configuration): Define the argument. * gnu/services/docker.scm (docker-shepherd-service): Use it. * doc/guix.texi (Docker Service): Document it. Signed-off-by: Mathieu Othacehe <othacehe@gnu.org> Alexey Abramov
2020-08-10doc: Fix a typo....* doc/guix.texi (operating-system Reference): Fix a typo & sigh. Reported by Jakub Kądziołka <kuba@kadziolka.net>. Tobias Geerinckx-Rice
2020-08-09doc: Shrink width of deeply-indented code sample....This follows up on commit 4cafdce2102e3ebc7b3a6152464a62a454b6be45. * doc/guix.texi (operating-system Reference): Shorten comments to fit everything on an 80-character punch card. Tobias Geerinckx-Rice
2020-08-09doc: Explain how to select system package outputs....* doc/guix.texi (operating-system Reference): Document that PACKAGES may contain traces of tuples and give an example. Tobias Geerinckx-Rice
2020-08-09doc: Fix typo....* doc/guix.texi (operating-system Reference): Add missing ‘of’. Tobias Geerinckx-Rice
2020-08-03doc: Document 'mount-may-fail?' field....This is a followup to 7c27bd115b14afd142da7684cc349369965f9eab. * doc/guix.texi (File Systems): Document 'mount-may-fail?'. Ludovic Courtès
2020-08-02services: Add zram-device-service....* gnu/services/linux.scm (<zram-device-configuration>): New record. (zram-device-service-type): New variable. * doc/guix.texi (Linux Services): Document it. * tests/services/linux.scm (zram-swap-device-test): New tests. Efraim Flashner
2020-08-01doc: Explain how to use psql with peer authentication....* doc/guix.texi (Database Services): Add example of shell commands to use psql as system user. Also add troubleshooting tip when service fails to start because of incompatible cluster. Pierre Neidhardt
2020-07-29doc: Extend tlp-service-type example....* doc/guix.texi (Power Management Services): Demonstrate tlp-configuration usage. Suggested by rovanion on #guix. Tobias Geerinckx-Rice
2020-07-28doc: Warn against using the .scm extension for the channel news file....* doc/guix.texi (Writing Channel News): Explain the issue with using the .scm extension and possible workarounds; fix the example to use the .txt extension instead. Pierre Neidhardt
2020-07-27services: auditd: Provide default configuration directory....* gnu/services/auditd.scm (auditd.conf) (%default-auditd-configuration-directory): New variables. (<auditd-configuration>): Switch to 'define-record-type*'. [configuration-directory]: New field. (auditd-shepherd-service): Honor 'configuration-directory'. Pass #:pid-file. (auditd-service-type)[description]: Tweak. [default-value]: Provide 'configuration-directory'. * doc/guix.texi (Miscellaneous Services): Update docs to reflect changes. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Robin Green
2020-07-27services: Add 'unattended-upgrade-service-type'....* gnu/services/admin.scm (<unattended-upgrade-configuration>): New record type. (%unattended-upgrade-log-file): New variable. (unattended-upgrade-mcron-jobs, unattended-upgrade-log-rotations): New procedures. (unattended-upgrade-service-type): New variable. * doc/guix.texi (Service Reference): Add 'provenance-service-type' anchor. (Unattended Upgrades): New section. Ludovic Courtès
2020-07-27machine: ssh: Check for potential system downgrades....This is a followup to 8e31736b0a60919cc1bfc5dc22c395b09243484a. * guix/scripts/system/reconfigure.scm (check-forward-update): Add #:current-channels. Use it instead of OLD. * gnu/services.scm (sexp->system-provenance): New procedure. (system-provenance): Use it. * gnu/machine/ssh.scm (<machine-ssh-configuration>)[allow-downgrades?]: New field. (machine-check-forward-update): New procedure. (check-deployment-sanity)[assertions]: Call it. * doc/guix.texi (Invoking guix deploy): Document 'allow-downgrades?' field. Ludovic Courtès
2020-07-25services: nix: Add extra-options....* gnu/services/nix.scm (<nix-configuration>)[extra-options]: New field. (nix-shepherd-service): Add this. (nix-activation): Add new line to the end of /etc/nix/nix.conf file. * doc/guix.texi (Miscellaneous Services)[Nix service]: Document this. Oleg Pykhalov
2020-07-24doc: Mention the channel keyring branch....Reported by Pierre Neidhardt <mail@ambrevar.xyz>. * doc/guix.texi (Channels): Mention the keyring branch and the 'keyring-reference' bit in '.guix-channel'. Ludovic Courtès
2020-07-24doc: Use an existing commit in channel example....Suggested by zimoun <zimon.toutoune@gmail.com>. * doc/guix.texi (Channels): Use the commit for 'v1.0.0' instead of a non-existing commit in example. Ludovic Courtès
2020-07-23guix system: 'reconfigure' disallows downgrades by default....This is similar to what 9744cc7b4636fafb772c94adb8f05961b5b39f16 did for 'guix pull'. * guix/scripts/system/reconfigure.scm (ensure-forward-reconfigure) (warn-about-backward-reconfigure, channel-relations) (check-forward-update): New procedures. * guix/scripts/system.scm (perform-action): Add #:validate-reconfigure. Call 'check-forward-update' when ACTION is 'reconfigure. (%options, show-help): Add "--allow-downgrades". (%default-options): Add 'validate-reconfigure' key. (process-action): Pass #:validate-reconfigure to 'perform-action'. * doc/guix.texi (Invoking guix system): Document 'guix system describe' more prominently, and document '--allow-downgrades'. Ludovic Courtès
2020-07-23doc: Tweak mcron example....* doc/guix.texi (Scheduled Job Execution): In example, move '%min-level' definition after 'use-modules'. Ludovic Courtès
2020-07-23doc: Recommend running 'guix git authenticate' when cloning the repo....* doc/contributing.texi (Building from Git): Adjust instruction and recommend 'guix git authenticate'. Ludovic Courtès
2020-07-22services: nix: Fix sandbox....* gnu/tests/package-management.scm: New file. * gnu/local.mk: Add this. * gnu/services/nix.scm (<nix-configuration>): New record. (nix-activation): Generate Nix config file which fixes sandbox. (nix-service-type): Add default value. (nix-shepherd-service): Allow provide Nix package. * doc/guix.texi (Miscellaneous Services)[Nix service]<nix-configuration>: Document record. Oleg Pykhalov
2020-07-21doc: Mention the 'savannah' updater....* doc/guix.texi (Invoking guix refresh): Mention 'savannah' updater. Ludovic Courtès
2020-07-20ssh: Speed up RPCs by using #:nodelay....Partly fixes <https://bugs.gnu.org/41702>. * guix/ssh.scm (open-ssh-session): Enable #:nodelay. * m4/guix.m4 (GUIX_CHECK_GUILE_SSH): Add feature check for this new parameter. * doc/guix.texi (Requirements): Adjust. Co-authored-by: Ludovic Courtès <ludo@gnu.org> Lars-Dominik Braun
2020-07-19doc: Fix Ganeti blog post URL....* doc/guix.texi (Virtualization Services): Adjust Ganeti blog post URL. Marius Bakke
2020-07-19services: ganeti: Use TLS on the remote API by default....* gnu/services/ganeti.scm (<ganeti-rapi-configuration>): Set SSL? to #t. * gnu/tests/ganeti.scm (%ganeti-os): Set SSL? to #f. * doc/guix.texi (Virtualization Services): Adjust accordingly. Marius Bakke