diff options
| author | Oleg Pykhalov <go.wigust@gmail.com> | 2021-01-01 13:37:37 +0300 |
|---|---|---|
| committer | Oleg Pykhalov <go.wigust@gmail.com> | 2021-01-12 14:40:36 +0300 |
| commit | 79ba12a1dbb3e40b623dd0945a277f8720d9780a (patch) | |
| tree | e1dc85a75aea7f08f5c29402b4fba352554f8001 /doc | |
| parent | dd42c528dbaaaf7380a53c3eef92789bce738d89 (diff) | |
services: Add syncthing service.
* gnu/services/syncthing.scm: New file.
* gnu/local.mk: Add this.
* doc/guix.texi: Document this.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/guix.texi | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi index d0a1ab76933..c752815975c 100644 --- a/doc/guix.texi +++ b/doc/guix.texi | |||
| @@ -16507,6 +16507,55 @@ Group name or group ID that will be used when accessing the module. | |||
| 16507 | @end table | 16507 | @end table |
| 16508 | @end deftp | 16508 | @end deftp |
| 16509 | 16509 | ||
| 16510 | The @code{(gnu services syncthing)} module provides the following services: | ||
| 16511 | @cindex syncthing | ||
| 16512 | |||
| 16513 | You might want a syncthing daemon if you have files between two or more | ||
| 16514 | computers and want to sync them in real time, safely protected from | ||
| 16515 | prying eyes. | ||
| 16516 | |||
| 16517 | @deffn {Scheme Variable} syncthing-service-type | ||
| 16518 | This is the service type for the @uref{https://syncthing.net/, | ||
| 16519 | syncthing} daemon, The value for this service type is a | ||
| 16520 | @command{syncthing-configuration} record as in this example: | ||
| 16521 | |||
| 16522 | @lisp | ||
| 16523 | (service syncthing-service-type | ||
| 16524 | (syncthing-configuration (user "alice"))) | ||
| 16525 | @end lisp | ||
| 16526 | |||
| 16527 | See below for details about @code{syncthing-configuration}. | ||
| 16528 | |||
| 16529 | @deftp {Data Type} syncthing-configuration | ||
| 16530 | Data type representing the configuration for @code{syncthing-service-type}. | ||
| 16531 | |||
| 16532 | @table @asis | ||
| 16533 | @item @code{syncthing} (default: @var{syncthing}) | ||
| 16534 | @code{syncthing} package to use. | ||
| 16535 | |||
| 16536 | @item @code{arguments} (default: @var{'()}) | ||
| 16537 | List of command-line arguments passing to @code{syncthing} binary. | ||
| 16538 | |||
| 16539 | @item @code{logflags} (default: @var{0}) | ||
| 16540 | Sum of loging flags, see | ||
| 16541 | @uref{https://docs.syncthing.net/users/syncthing.html#cmdoption-logflags, Syncthing documentation logflags}. | ||
| 16542 | |||
| 16543 | @item @code{user} (default: @var{#f}) | ||
| 16544 | The user as which the Syncthing service is to be run. | ||
| 16545 | This assumes that the specified user exists. | ||
| 16546 | |||
| 16547 | @item @code{group} (default: @var{"users"}) | ||
| 16548 | The group as which the Syncthing service is to be run. | ||
| 16549 | This assumes that the specified group exists. | ||
| 16550 | |||
| 16551 | @item @code{home} (default: @var{#f}) | ||
| 16552 | Common configuration and data directory. The default configuration | ||
| 16553 | directory is @file{$HOME} of the specified Syncthing @code{user}. | ||
| 16554 | |||
| 16555 | @end table | ||
| 16556 | @end deftp | ||
| 16557 | @end deffn | ||
| 16558 | |||
| 16510 | Furthermore, @code{(gnu services ssh)} provides the following services. | 16559 | Furthermore, @code{(gnu services ssh)} provides the following services. |
| 16511 | @cindex SSH | 16560 | @cindex SSH |
| 16512 | @cindex SSH server | 16561 | @cindex SSH server |
