1revisor.conf(5)                                                revisor.conf(5)
2
3
4

NAME

6       revisor.conf - Revisor main configuration file
7
8

SYNOPSIS

10       revisor.conf  is  the  main  configuration  file  revisor(8)  uses. The
11       default location is /etc/revisor/revisor.conf but from the CLI you  can
12       use --config to specify any other location or use the appropriate entry
13       fields from the GUI.
14

FILE FORMAT

16       The file consists of sections and parameters. A section begins with the
17       name  of  the  section  in square brackets and continues until the next
18       section begins, or the file ends. Sections contain  parameters  of  the
19       form:
20
21       name = value
22
23       The  file  is line-based - that is, each newline-terminated line repre‐
24       sents either a comment, a section name or a parameter.
25

SECTION DESCRIPTIONS

27       Each section in the configuration file (except for the  [revisor]  sec‐
28       tion) describes a so-called model. A model is used to specify a certain
29       type of compose such as a Fedora 7 i386 compose or a  Fedora  8  x86_64
30       compose.  The  section name is the name of the model and the parameters
31       within the section define the compose.
32
33       There is only one  special  section,  [revisor],  which  describes  any
34       options globally applied to all models.
35

OPTIONS

37       These  options  apply  to  both the global options as well as the model
38       options.
39
40       description
41           The description for this model, preferably a  descriptive  line  of
42       text  to indicate what this model is to be used for. Optional, and used
43       with CLI option --list-models only.
44
45       main
46           The yum configuration file to use with this model. For more  infor‐
47       mation on this configuration file's syntax, see man yum.conf(8)
48
49       architecture
50           The  architecture for this model. If not specified, revisor assumes
51       i386.
52
53       media_installation_cd
54           Whether to compose CD Installation Media. Defaults to 0.
55
56       media_installation_dvd
57           Whether to compose DVD Installation Media. Defaults to 0.
58
59       media_installation_dvd_duallayer
60           Whether to compose DVD Dual Layer Installation Media.  Defaults  to
61       0.
62
63       media_installation_tree
64           Whether  to  compose an Installation Tree for use with HTTP, FTP or
65       NFS installations. Defaults to 0.
66
67       media_installation_unified
68           Whether to compose a Unified Installation Media ISO. A Unified  ISO
69       is  one  large  ISO  which could be used for NFS or Hard Disk installa‐
70       tions, and allows
71           for easier transportation. Defaults to 0.
72
73       working_directory
74           The directory Revisor should use for temporary  data.  Defaults  to
75       /var/tmp/.
76
77       destination_directory
78           The   destination   directory   Revisor  should  use.  Defaults  to
79       /srv/revisor/.
80
81       media_live_optical
82           Whether to compose optical Live Media. Revisor at  this  moment  is
83       not  able to restrict Live Media to be composed for CD, DVD or DVD Dual
84       Layer but instead creates an ISO that
85           depending on the size needed for the installation of  the  selected
86       packages, will fit on one of these media.
87
88       repos_enabledevelopment
89           Only  relevant to the GUI. Enables displaying 'development' reposi‐
90       tories configured in the GUI. The default is 0 (not to display them).
91
92       repos_enabletesting
93           Only relevant to the GUI. Enables displaying 'testing' repositories
94       configured in the GUI. The default is 0 (not to display them).
95
96       repos_enabledebuginfo
97           Only  relevant to the GUI. Enables displaying 'debuginfo' reposito‐
98       ries configured in the GUI. The default is 0 (not to display them).
99
100       repos_enablesource
101           Only relevant to the GUI. Enables displaying 'source'  repositories
102       configured in the GUI. The default is 0 (not to display them).
103           Note  that  source  repositories do not need to be enabled to begin
104       with as they usually do not contain any valuable packages, and  Revisor
105       enables them when getsource = 1
106
107       dependency_resolve_allow_conflicts
108           Whether to allow conflicts between packages in the package set that
109       ends up on the Installation Media. Defaults to 0  to  allow  unattended
110       installation media to be composed.
111           For  media  that is going to be distributed among a number of users
112       you would want to set this to 1. Please refer to the section  "Allowing
113       Conflicts in Package Sets" further on
114           in this document.
115
116       mode_respin
117           Whether  to  use  respin mode when composing the media. Respin mode
118       has a different way of selecting the  packages  from  a  kickstart  and
119       dependency resolving. The default is 0,
120           and  you  will  want to set this to 1 in case you are going to dis‐
121       tribute the compose amongst a large number of users.
122
123       product_name
124           The name for your product. The default is "Fedora".
125
126       product_path
127           The path in which the RPMs end up on  the  media.  The  default  is
128       "Fedora" which means the packages end up in a subdirectory "Fedora/" on
129       the installation media.
130
131       iso_basename
132           The base name for the ISO(s) being composed.  This  is  a  seperate
133       setting  from  iso_label  as  the ISO label can only 32 characters. The
134       default is to use the value of iso_label,
135           specify this option of you want the ISO to be named  anything  dif‐
136       ferent from the ISO's label.
137
138       comps
139           The  comps  file to use for the media. Note that this has impact on
140       how the installation behaves.
141
142       version
143           The version of the composed distribution or operating system.
144
145       getsource
146           Whether to obtain the source along with the binaries  used  in  the
147       compose.
148
149       kickstart_file
150           The kickstart file to use.
151
152       kickstart_manifest
153           Whether  to  use  the  package  manifest  from  the kickstart file.
154       Defaults to 0.
155
156       kickstart_customize
157           Whether to customize the package manifest from the kickstart  file.
158       Defaults to 0. Only relevant if kickstart_manifest = 1.
159
160       kickstart_include
161           Whether  to  include  the  kickstart  file used on the installation
162       media. This enables you to specify the kickstart to be  used  with  the
163       installer. Revisor adds an item
164           to  the  bootloader  menu which uses the kickstart file included on
165       the media if this is set to 1. Defaults to 0.
166
167       kickstart_default
168           If kickstart_include = 1, make the bootloader menu entry  added  by
169       Revisor the default. Defaults to 0.
170
171

Allowing Conflicts in Package Sets

173       Presumably  when you're using a kickstart package manifest (the "%pack‐
174       ages" section in a kickstart, see pykickstart  documentation  for  more
175       details),  you  are  going  to  use  the kickstart for an unattended or
176       (partly) guided installation as well. Considering this,  allowing  con‐
177       flicts  within the Package Set should be a careful consideration as one
178       may need to customize the list of packages for installation before  the
179       actual  installation  starts,  or  the installation will fail over this
180       conflict. To allow the package set to be created with, or without, con‐
181       flicts     between     packages    Revisor    includes    the    depen‐
182       dency_resolve_allow_conflicts setting. By default, this setting is  set
183       to  False, or 0, so that it disallows conflicts within the package set,
184       enabling smoother package selection and guided or unattended  installa‐
185       tion.
186
187       However,  in  some  cases  you  will want Revisor to allow conflicts to
188       exist within the package set, such as when  you  are  composing  for  a
189       large  (public)  audience,  and  you  do not know what packages someone
190       might want to install but you do know two conlicting packages are  very
191       much  liked.  Another very valid use case for allowing packages to con‐
192       flict within a package set might be a  single  installation  tree  with
193       different kickstarts; the package set will, overall, have the conflicts
194       but you take care of never selecting both (or more)  conflicting  pack‐
195       ages yourself.
196
197

Example Model Configuration

199       Comments inline:
200
201           # The model name is also the section header. Note that the name isn't important but it should be unique.
202           [f7-i386]
203
204           # Description
205           description = Fedora 7 - Moonshine - i386
206
207           # Architecture
208           architecture = i386
209
210           # Yum configuration file to use. Note that this cannot be '/etc/yum.conf'
211           # This file should not (and can not) have any $releasever, $basearch or $arch variables so they need to be expanded
212           main = /etc/revisor/conf.d/revisor-f7-i386.conf
213
214           # The Product Name
215           # In case of Fedora Core 6, the product name would be 'Fedora Core'. Later versions use 'Fedora' as a product name, while RHEL uses 'Red Hat Enterprise Linux'
216           product_name = Fedora
217
218           # The product path is the name of the directory used to store the RPM files in. In case of Fedora 7 this would be 'Fedora', while in Fedora 8 this has become 'Packages'
219           product_path = Fedora
220
221           # The ISO Base Name.
222           # This piece gets prepended to the name of the ISO image. The iso name will become 'Fedora-$version-$arch-$media$discnum.iso'; in this example model
223           # 'Fedora-7-i386-CD1.iso'
224           iso_basename = Fedora
225
226           # The comps file to use. Note that this file is only used when you specify --revisor-comps.
227           comps = /usr/share/revisor/comps/comps-f7.xml
228
229           # The version of the distribution. This is used in a number of locations such as the ISO Image name and the ISO Image volume label.
230           version = 7
231
232           # Whether to obtain the source RPMs for all the packages used in this compose
233           getsource = 0
234
235           # The kickstart file for this compose. Note that although a kickstart file may be specified, Revisor allows further customization.
236           kickstart_file = /etc/revisor/conf.d/fedora-7-gold.cfg
237
238

SEE ALSO

240       http://revisor.fedoraunity.org/
241       https://hosted.fedoraproject.org/projects/revisor/
242
243

AUTHORS

245       See the Authors file included with this program.
246
247

BUGS

249       No bugs were harmed in the making of this software.
250
251
252
253Jeroen van Meeuwen           Fedora Unity Project              revisor.conf(5)
Impressum