idrist.1 - drist - a remote deployment tool Err bitreich.org 70 hgit clone git://bitreich.org/drist/ git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65d7roiv6bfj7d652fid.onion/drist/ URL:git://bitreich.org/drist/ git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65d7roiv6bfj7d652fid.onion/drist/ bitreich.org 70 1Log /scm/drist/log.gph bitreich.org 70 1Files /scm/drist/files.gph bitreich.org 70 1Refs /scm/drist/refs.gph bitreich.org 70 1Tags /scm/drist/tag bitreich.org 70 1README /scm/drist/file/README.gph bitreich.org 70 1LICENSE /scm/drist/file/LICENSE.gph bitreich.org 70 i--- Err bitreich.org 70 idrist.1 (2863B) Err bitreich.org 70 i--- Err bitreich.org 70 i 1 .Dd $Mdocdate: April 27 2020 $ Err bitreich.org 70 i 2 .Dt DRIST 1 Err bitreich.org 70 i 3 .Os Err bitreich.org 70 i 4 .Sh NAME Err bitreich.org 70 i 5 .Nm drist Err bitreich.org 70 i 6 .Nd dumb remote installer shell tool, a remote deployment tool Err bitreich.org 70 i 7 .Sh SYNOPSIS Err bitreich.org 70 i 8 .Op Fl p Err bitreich.org 70 i 9 .Op Fl d Err bitreich.org 70 i 10 .Op Fl s Op Fl e Ar sudo|doas Err bitreich.org 70 i 11 .Ar destination Err bitreich.org 70 i 12 .Sh OPTIONS Err bitreich.org 70 i 13 .Bl -tag -width Ds Err bitreich.org 70 i 14 .It Op Fl p Err bitreich.org 70 i 15 to use persistent ssh connection, allowing to ssh only once Err bitreich.org 70 i 16 for the differents steps. Err bitreich.org 70 i 17 This uses ControlMaster feature from Err bitreich.org 70 i 18 .Xr ssh 1 . Err bitreich.org 70 i 19 .It Op Fl d Err bitreich.org 70 i 20 to truncate reported hostname. Err bitreich.org 70 i 21 Tells Err bitreich.org 70 i 22 .Nm Err bitreich.org 70 i 23 to truncate the reported remote hostname to the left-most component. Err bitreich.org 70 i 24 .It Op Fl s Err bitreich.org 70 i 25 use a program to execute a command as root on the remote server. Err bitreich.org 70 i 26 Default is sudo. Err bitreich.org 70 i 27 .It Op Fl e Ar binary Err bitreich.org 70 i 28 binary to use for executing the commands as root. Err bitreich.org 70 i 29 This flag is only useful when used with Err bitreich.org 70 i 30 .Fl s . Err bitreich.org 70 i 31 .It Ar destination Err bitreich.org 70 i 32 Specify the remote servers you want drist to work on. Err bitreich.org 70 i 33 .Ar destination Err bitreich.org 70 i 34 can be a file containing a list of hosts, one per line or Err bitreich.org 70 i 35 it can be addresses passed in the command line. Err bitreich.org 70 i 36 If you specify multiples servers, Err bitreich.org 70 i 37 .Nm Err bitreich.org 70 i 38 will loop over the list respecting the list order. Err bitreich.org 70 i 39 Note that only one file can be used in the command line. Err bitreich.org 70 i 40 .El Err bitreich.org 70 i 41 .Sh DESCRIPTION Err bitreich.org 70 i 42 .Nm Err bitreich.org 70 i 43 is a tool to configure remote servers using Err bitreich.org 70 i 44 .Xr ssh 1 Err bitreich.org 70 i 45 and Err bitreich.org 70 i 46 .Xr rsync 1 . Err bitreich.org 70 i 47 .Nm Err bitreich.org 70 i 48 has been designed to be simple, so it may not offer all the features you want. Err bitreich.org 70 i 49 .Pp Err bitreich.org 70 i 50 When you run Err bitreich.org 70 i 51 .Nm Err bitreich.org 70 i 52 , it will look at a set of special directories in the current working Err bitreich.org 70 i 53 directory. Err bitreich.org 70 i 54 .Nm Err bitreich.org 70 i 55 will connect to Err bitreich.org 70 i 56 .Ar server Err bitreich.org 70 i 57 via Err bitreich.org 70 i 58 .Xr ssh 1 Err bitreich.org 70 i 59 and request the remote Err bitreich.org 70 i 60 .Em HOSTNAME Err bitreich.org 70 i 61 by calling Err bitreich.org 70 i 62 .Ql uname -n . Err bitreich.org 70 i 63 .Pp Err bitreich.org 70 i 64 After that following steps will be executed: Err bitreich.org 70 i 65 .Bl -enum -offset indent -compact Err bitreich.org 70 i 66 .It Err bitreich.org 70 i 67 If directory Err bitreich.org 70 i 68 .Ar files Err bitreich.org 70 i 69 exists, its content is copied to Err bitreich.org 70 i 70 .Ar server Err bitreich.org 70 i 71 using Err bitreich.org 70 i 72 .Xr rsync 1 Err bitreich.org 70 i 73 in a temporary directory in ~/.drist_files_XXXXXXXX Err bitreich.org 70 i 74 .It Err bitreich.org 70 i 75 If directory Err bitreich.org 70 i 76 .Ar files- Ns Em HOSTNAME Err bitreich.org 70 i 77 exists, its content is copied to Err bitreich.org 70 i 78 .Ar server Err bitreich.org 70 i 79 using Err bitreich.org 70 i 80 .Xr rsync 1 Err bitreich.org 70 i 81 in a temporary directory in ~/.drist_files_XXXXXXXX . Err bitreich.org 70 i 82 .It Err bitreich.org 70 i 83 If file Err bitreich.org 70 i 84 .Ar script Err bitreich.org 70 i 85 exists, it is copied to Err bitreich.org 70 i 86 .Ar server Err bitreich.org 70 i 87 and executed from the temporary directory. Err bitreich.org 70 i 88 .It Err bitreich.org 70 i 89 If file Err bitreich.org 70 i 90 .Ar script- Ns Em HOSTNAME Err bitreich.org 70 i 91 exists, it is copied to Err bitreich.org 70 i 92 .Ar server Err bitreich.org 70 i 93 and executed from the temporary directory. Err bitreich.org 70 i 94 .El Err bitreich.org 70 i 95 .Pp Err bitreich.org 70 i 96 The presence of each of those files or directories is optional. Err bitreich.org 70 i 97 .Pp Err bitreich.org 70 i 98 All files in either Err bitreich.org 70 i 99 .Ar files Err bitreich.org 70 i 100 or Err bitreich.org 70 i 101 .Ar files- Ns Em HOSTNAME Err bitreich.org 70 i 102 etc. are relative to the root (/) directory. Err bitreich.org 70 i 103 The specific files for Err bitreich.org 70 i 104 .Em HOSTNAME Err bitreich.org 70 i 105 are worked on after the common files. Err bitreich.org 70 i 106 .Pp Err bitreich.org 70 i 107 I recommend to write small "modules" which would install the required Err bitreich.org 70 i 108 packages for a task and provide the files needed, rather than writing a Err bitreich.org 70 i 109 full-blown module for deploying an entire system at once. Err bitreich.org 70 i 110 .Nm Err bitreich.org 70 i 111 does not handle file permissions and ownership. Err bitreich.org 70 i 112 Those should be modified by the Err bitreich.org 70 i 113 .Ar script Err bitreich.org 70 i 114 file. Err bitreich.org 70 i 115 .Sh EXAMPLES Err bitreich.org 70 i 116 Please see the Err bitreich.org 70 i 117 .Ar examples Err bitreich.org 70 i 118 directory in the Err bitreich.org 70 i 119 .Nm Err bitreich.org 70 i 120 distribution. Err bitreich.org 70 i 121 .Sh EXIT Err bitreich.org 70 i 122 .Ex -std drist Err bitreich.org 70 i 123 .Sh SEE ALSO Err bitreich.org 70 i 124 .Xr rsync 1 , Err bitreich.org 70 i 125 .Xr ssh 1 , Err bitreich.org 70 i 126 .Xr ssh_config 5 Err bitreich.org 70 i 127 .Sh Authors Err bitreich.org 70 i 128 .An -nosplit Err bitreich.org 70 i 129 The Err bitreich.org 70 i 130 .Nm Err bitreich.org 70 i 131 program was written by Err bitreich.org 70 i 132 .An Solène Rapenne Aq Mt solene@perso.pw Err bitreich.org 70 .