1Looking for help?
2[![Gitter chat](https://badges.gitter.im/cfengine/core.png)](https://gitter.im/cfengine/core) | [![IRC channel](https://kiwiirc.com/buttons/irc.cfengine.com/cfengine.png)](https://web.libera.chat?channel=#cfengine)
3
4# CFEngine 3 masterfiles
5
6CFEngine 3 is a popular open source configuration management system. Its primary
7function is to provide automated configuration and maintenance of large-scale
8computer systems.
9
10The MPF or Masterfiles Policy Framework is intended to provide a stable base
11policy installations and upgrades, and is used by both CFEngine Enterprise and
12CFEngine community in versions 3.6 and newer.
13The
14[documentation for the MPF](https://docs.cfengine.com/docs/master/reference-masterfiles-policy-framework.html) is
15highly recommended.
16
17## Installation
18
19There are several methods available for installing the CFEngine Masterfiles
20Policy Framework.
21
22* From pkg tarball
23* From git
24* From source tarball
25
26### From pkg tarball
27
28If you have downloaded
29a [package tarball from our website](https://cfengine.com/product/community/)
30(not from github), you don't need to `autogen`, `configure` or `make` anything.
31Instead simply unpack the tarball to the desired location using `tar`.
32
33For example:
34
35```
36tar zxvf cfengine-masterfiles-MAJOR.MINOR.PATCH.pkg.tar.gz /var/cfengine/masterfiles
37```
38
39### From git
40
41Clone this repository
42
43```
44git clone https://github.com/cfengine/masterfiles
45```
46
47If you have cloned the repository from github:
48
49Run autogen and make to build masterfiles.
50
51```
52./autogen.sh
53make
54```
55
56Optionally configure masterfiles to install to a different location (perhaps your
57own version control checkout)
58
59```
60./configure --prefix=/tmp/cfengine/
61make
62```
63
64```
65make install
66```
67
68### From source tarball
69
70If you have downloaded
71a [release tarball from our website](https://cfengine.com/product/community/)
72(not from github), you don't need to run `autogen.sh`. By default it installs in
73`/var/cfengine/masterfiles` but you can override that easily:
74
75```
76./configure --prefix=/install/directory
77make install
78```
79
80Note that the last directory component will always be called `masterfiles`.
81
82## Host report
83
84A very important piece of functionality, which you may want for your
85own use but will certainly be helpful for debugging or submitting bugs
86to CFEngine (core, masterfiles, or any other are) is the host report.
87
88Run the host report like so: `cf-agent -b host_info_report`
89
90You should see output like:
91
92```
93R: Host info report generated and available at '/var/cfengine/reports/host_info_report.txt'
94```
95
96Take a look at the resulting file, it has lots of useful information about the system.
97
98## Contributing
99
100Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file.
101
102The CFEngine masterfiles are under the MIT license, see [LICENSE](LICENSE)
103
104# Authors
105
106CFEngine was originally created by Mark Burgess with many contributions from
107around the world. Thanks [everyone](https://github.com/cfengine/core/blob/master/AUTHORS)!
108
109[CFEngine](https://cfengine.com) is sponsored by [Northern.tech AS](https://northern.tech)
110