v5/nix/INSTALL
Shawn Iverson 0a87daf349
Update 5.2.1-1 (#410)
* Initial Refactor for 5.1.4-1

* Reorder docs and patch processing

* Explicit targets for copy

* Update install phase of specs

* Disable AutoReqProv

* Update install splash

* Refactor post install

* Update README

* Distinguish rhel and suse rpms in naming
Clarify naming in README
Log ms-configure to /var/log

* Do not automatically enable mailscanner on debian builds
Move notes in packages to end of ms-configure
Alter notes in specs to notify user to run ms-configure

* Correct package name in copy

* Move mtagroup creation back to spec

* patch.diff no longer valid

* Remove patch.diff from spec and build

* Bump to version 5.2.1-1 for major changes

* ATTENTION block added to README

* Cosmetic changes to README

* Tab cleanup of README

* Revert not enabling mailscanner during install

* Explicit destination file for copy on suse builds

* Reorder doc copies for tarballing

* Remove unneeded subdirectory in suse build

* 5.2.1-1 Builds
2019-11-03 18:40:24 -05:00

53 lines
1.4 KiB
Plaintext

# Welcome to MailScanner!
#
# All the documentation is on-line at:
#
# Wiki: http://github.com/MailScanner/v5
# Info: http://www.mailscanner.info
#
# See /etc/MailScanner/MailScanner.conf for config details.
#
# Manual: https://s3.amazonaws.com/msv5/docs/ms-admin-guide.pdf
#
# Support: http://lists.mailscanner.info/mailman/listinfo/mailscanner
#
# Updated: 2 Nov 2019
# MailScanner Team <https://www.mailscanner.info>
#
The install for NIX* is very straightforward. It simply copies the files into place. From
there you will need to create the links to get MailScanner to start at boot.
Requirements: perl, perldoc, curl, cpan, and network access if you want to install missing Perl modules
via CPAN.
Important files to note:
/etc/MailScanner/defaults
This file contains the system level settings for MailScanner. You will need to edit this file
and at a minimum set run_mailscanner=1 for the daemon to start.
/etc/MailScanner/MailScanner.conf
The main configuration file for MailScanner's engine. You will also need to customize this file.
/usr/lib/MailScanner/init/ms-init
This is the initialization script for MailScanner. This is the script you would symlink to control
MailScanner using start/stop/restart/reload/kill.
/usr/sbin/ms-perl-check
This executable will tell you what Perl modules you are missing, if any.
/usr/sbin/ms-*
Many MailScanner executables. Most are self explanatory from the name alone.