1SETUP-DS.PL(8) System Manager's Manual SETUP-DS.PL(8)
2
6 setup-ds.pl - Set up an instance of Directory Server
7
9 setup-ds.pl [--options] -- [args]
10
12 Set up a Directory Server instance. Creates the configuration files
13 for an instance of Directory Server based on a few parameters like the
14 hostname, port number, and directory manager information. Can be run
15 in interactive mode with different levels of verbosity, or in silent
16 mode with parameters supplied in a .inf format file or on the command
17 line.
18
20 A summary of options is included below:
21 --help This message
23 --version
25 Print the version and exit
26 --debug
28 Turn on debugging
29 --silent
31 Use silent setup - no user input
32 --file=name
34 Use the file 'name' in .inf format to supply the default answers
35 --keepcache
37 Do not delete the temporary .inf file generated by this program
38 --logfile
40 Log setup messages to this file - otherwise, a temp file will be
41 used
42 --update
44 Update existing installations - add/update schema files,
45 add/change configuration, add new instance scripts, etc. You
46 must run setup-ds.pl -u after upgrading your packages. You will
47 usually have to restart your servers in order for all of the
48 changes to take effect (e.g. adding/changing plug-in configura‐
49 tion), so schedule this when you can afford a little downtime.
50 --continue
52 (Update only) Keep going even if errors occur. You will usually
53 not need to use this option unless your installation is broken
54 and you need to force it to update in order to fix it.
55 For all options, you can also use the short name e.g. -h, -d, etc. For
57 the -d argument, specifying it more than once will increase the debug
58 level e.g. -ddddd
59 args: You can supply default .inf data in this format:
61 section.param=value
63 e.g.
65 General.FullMachineName=foo.example.com
67 or
69 "slapd.Suffix=dc=example, dc=com"
71 Values passed in this manner will override values in an .inf file given
73 with the -f argument.
74
76 The update process (setup-ds.pl -u) can work in one of two modes:
77 Online: Configuration changes are made to the running directory servers
79 using LDAP. The operations must be performed as an administrative
80 user. You must provide the name and password, for each instance if
81 there is more than one instance of directory server. Some changes (e.g.
82 plug-ins) may require a directory server restart to take effect. The
83 update script will notify you if a restart is required.
84 Offline: The changes are made to the server configuration files. The
86 servers MUST FIRST BE SHUTDOWN BY YOU. The script will not shutdown
87 the servers for you. You MUST shutdown the servers in order to use
88 this mode. A username and password are not required to use Offline
89 mode. If the servers are not shutdown, CHANGES WILL BE LOST.
90 To summarize:
92 Online - servers remain running - you must provide admin name and pass‐
94 word for each server - servers may need to be restarted
95 Offline - servers must be shutdown - no username or password required
97
99 setup-ds.pl was written by the 389 Project.
100
102 Report bugs to https://pagure.io/389-ds-base/new_issue
103
105 Copyright © 2017 Red Hat, Inc.
106 This manual page was written by Michele Baldessari
107 <michele@pupazzo.org>, for the Debian project (but may be used by oth‐
108 ers).
109 This is free software. You may redistribute copies of it under the
110 terms of the Directory Server license found in the LICENSE file of this
111 software distribution. This license is essentially the GNU General
112 Public License version 2 with an exception for plug-in distribution.
113 March 31, 2017 SETUP-DS.PL(8)