.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "UPSERVER 8" .TH UPSERVER 8 2024-02-03 OpenAFS "AFS Command Reference" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME upserver \- Initializes the server portion of the Update Server .SH SYNOPSIS .IX Header "SYNOPSIS" \&\fBupserver\fR [<\fIdirectory\fR>+] [\fB\-crypt\fR\ <\fIdirectory\fR>+] [\fB\-clear\fR\ <\fIdirectory\fR>+] [\fB\-auth\fR\ <\fIdirectory\fR>+] [\fB\-rxbind\fR] [\fB\-help\fR] .SH DESCRIPTION .IX Header "DESCRIPTION" The \fBupserver\fR command initializes the server portion of the Update Server (the \f(CW\*(C`upserver\*(C'\fR process). In the conventional configuration, its binary file is located in the \fI/usr/lib/openafs\fR directory on a file server machine. .PP The \fBupserver\fR command is not normally issued at the command shell prompt but rather placed into a file server machine's \fI/etc/openafs/BosConfig\fR file with the \fBbos create\fR command. If it is ever issued at the command shell prompt, the issuer must be logged onto a database server machine as the local superuser \f(CW\*(C`root\*(C'\fR. .PP The \fBupserver\fR command specifies which of the directories on the local disk are eligible for distribution in response to requests from the client portion of the Update Server (the \fBupclient\fR process) running on other machines. If no directories are specified, the \fBupserver\fR process distributes the contents of any directory on its local disk. .PP The \fBupserver\fR process can distribute a directory's contents in encrypted or unencrypted form. By default, it does not use encryption unless an \&\fBupclient\fR process requests it (this default is equivalent to setting the \&\fB\-clear\fR flag). When the \fB\-crypt\fR flag is provided, the \fBupserver\fR process only fulfills requests for encrypted transfer. .PP The \fBupclient\fR and \fBupserver\fR processes always mutually authenticate, whether or not the data they pass is encrypted; they use the key with the highest key version number in the \fI/etc/openafs/server/KeyFile\fR file to construct a server ticket for mutual authentication. .PP This command does not use the syntax conventions of the AFS command suites. Provide the command name and all option names in full. .SH CAUTIONS .IX Header "CAUTIONS" Do not use the Update Server to distribute the contents of the \&\fI/etc/openafs/server\fR directory without the \fB\-crypt\fR flag. The contents of this directory are sensitive. .SH OPTIONS .IX Header "OPTIONS" .IP <\fIdirectory\fR>+ 4 .IX Item "+" Names each directory to distribute in unencrypted form (because they appear before the first \fB\-crypt\fR or \fB\-clear\fR flag on the command line). If this argument is omitted, all directories on the machine's local disk are eligible for distribution. .IP "\fB\-crypt\fR <\fIdirectory\fR>+" 4 .IX Item "-crypt +" Precedes a list of one or more directories that the \fBupserver\fR process distributes only in encrypted form. .IP "\fB\-clear\fR <\fIdirectory\fR>+" 4 .IX Item "-clear +" Precedes a list of one or more directories that the \fBupserver\fR process distributes in unencrypted form unless the \fBupclient\fR process requests them in encrypted form. Use this argument only if a list of directories headed by the \fB\-crypt\fR flag precedes it on the command line. .IP "\fB\-auth\fR <\fIdirectory\fR>+" 4 .IX Item "-auth +" Precedes a list of one or more directories which the upserver process distributes using a form of encryption that is intermediate in complexity and security between the unencrypted and encrypted levels set by the \&\fB\-clear\fR and \fB\-crypt\fR arguments. Do not use this argument, because the \&\fBupclient\fR process does not have a corresponding argument that it can use to request data transfer at this level. .IP \fB\-rxbind\fR 4 .IX Item "-rxbind" Bind the Rx socket to the primary interface only. (If not specified, the Rx socket will listen on all interfaces.) .IP \fB\-help\fR 4 .IX Item "-help" Prints the online help for this command. All other valid options are ignored. .SH EXAMPLES .IX Header "EXAMPLES" The following example bos create command defines and starts an \fBupserver\fR process on the host machine \f(CW\*(C`fs1.example.com\*(C'\fR. The last parameter (enclosed in quotes) instructs the \fBupserver\fR process to distribute the contents of the \fI/usr/lib/openafs\fR directory in unencrypted form and the contents of the \&\fI/etc/openafs/server\fR directory in encrypted form. .PP .Vb 2 \& % bos create \-server fs1.example.com \-instance upserver \-type simple \e \& \-cmd "/usr/lib/openafs/upserver /usr/lib/openafs \-crypt /etc/openafs/server" .Ve .SH "PRIVILEGE REQUIRED" .IX Header "PRIVILEGE REQUIRED" The issuer must be logged in as the superuser \f(CW\*(C`root\*(C'\fR on a file server machine to issue the command at a command shell prompt. It is conventional instead to create and start the process by issuing the \fBbos create\fR command. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBBosConfig\fR\|(5), \&\fBbos_create\fR\|(8), \&\fBupclient\fR\|(8) .SH COPYRIGHT .IX Header "COPYRIGHT" IBM Corporation 2000. All Rights Reserved. .PP This documentation is covered by the IBM Public License Version 1.0. It was converted from HTML to POD by software written by Chas Williams and Russ Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.