aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGilles Chehade <gilles@poolp.org>2015-06-12 16:33:43 +0200
committerGilles Chehade <gilles@poolp.org>2015-06-12 16:33:43 +0200
commit634eb0f9313e673892cb9162b57fa072a3d955fe (patch)
tree02cff09367b7ce608792d518d81c306c1a6b7645 /README.md
parentMerge branch 'master' into portable (diff)
parentMerge pull request #591 from mulander/remove-markdown-from-readme (diff)
downloadOpenSMTPD-634eb0f9313e673892cb9162b57fa072a3d955fe.tar.xz
OpenSMTPD-634eb0f9313e673892cb9162b57fa072a3d955fe.zip
Merge branch 'master' into portable
Diffstat (limited to 'README.md')
-rw-r--r--README.md70
1 files changed, 39 insertions, 31 deletions
diff --git a/README.md b/README.md
index d6763ce5..67b8b40c 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,14 @@
Preliminary note
================
-OpenSMTPD is a FREE implementation of the server-side SMTP protocol as defined
-by RFC 5321, with some additional standard extensions.
+OpenSMTPD is a FREE implementation of the server-side SMTP protocol as
+defined by RFC 5321, with some additional standard extensions.
-It allows ordinary machines to exchange e-mails with other systems speaking
-the SMTP protocol.
+It allows ordinary machines to exchange e-mails with other systems
+speaking the SMTP protocol.
-OpenSMTPD runs on top of the OpenBSD operating system but also has a portable
-version that can build and run on several systems, including:
+OpenSMTPD runs on top of the OpenBSD operating system but also has a
+portable version that can build and run on several systems, including:
* Linux
* FreeBSD
@@ -16,14 +16,16 @@ version that can build and run on several systems, including:
* DragonFly
* MacOSX
-For more information: [http://www.opensmtpd.org/portable.html](http://www.opensmtpd.org/portable.html)
+For more information: http://www.opensmtpd.org/portable.html
-People interested about OpenSMTPD are encouraged to subscribe to our mailing
-list: [http://www.opensmtpd.org/list.html](http://www.opensmtpd.org/list.html)
+People interested about OpenSMTPD are encouraged to subscribe to our
+mailing list: http://www.opensmtpd.org/list.html
and to join the IRC channel: #OpenSMTPD @ irc.freenode.net
-Also note that we have a [wiki](https://github.com/OpenSMTPD/OpenSMTPD/wiki) that you are encouraged to contribute to.
+Also note that we have a wiki at
+https://github.com/OpenSMTPD/OpenSMTPD/wiki that you are encouraged to
+contribute to.
Cheers!
@@ -35,14 +37,14 @@ Dependencies
------------
Portable OpenSMTPD relies on:
-* [autoconf](http://www.gnu.org/software/autoconf/)
-* [automake](http://www.gnu.org/software/automake/)
-* [Berkeley DB](http://www.oracle.com/technetwork/products/berkeleydb/overview/index.html) to be built with --enable-compat185 configure flag
-* [bison](http://www.gnu.org/software/bison/) (or [byacc](http://invisible-island.net/byacc/byacc.html))
-* [libevent](http://libevent.org/)
-* [libtool](http://www.gnu.org/software/libtool/)
-* [openssl](http://www.openssl.org/)
-* [libasr](https://opensmtpd.org/archives/libasr-1.0.2.tar.gz)
+ * autoconf (http://www.gnu.org/software/autoconf/)
+ * automake (http://www.gnu.org/software/automake/)
+ * bison (http://www.gnu.org/software/bison/)
+ or byacc (http://invisible-island.net/byacc/byacc.html)
+ * libevent (http://libevent.org/)
+ * libtool (http://www.gnu.org/software/libtool/)
+ * openssl (http://www.openssl.org/)
+ * libasr (https://opensmtpd.org/archives/libasr-1.0.2.tar.gz)
Get the source
@@ -65,15 +67,16 @@ Build
make
sudo make install
-### Special notes for FreeBSD/DragonFlyBSD/Mac OS X:
+# Special notes for FreeBSD/DragonFlyBSD/Mac OS X:
-Please launch configure with special directive about libevent and libasr directory:
+Please launch configure with special directive about libevent and
+libasr directory:
-#### FreeBSD / DragonFlyBSD:
+# FreeBSD / DragonFlyBSD:
./configure --with-asr=/usr/local
-#### Mac OS X:
+# Mac OS X:
./configure --with-libevent-dir=/opt/local --with-asr=/opt/local
@@ -87,7 +90,8 @@ Install
Configure /etc/smtpd.conf
-------------------------
-Please have a look at the complete format description of [smtpd.conf configuration file](http://opensmtpd.org/smtpd.conf.5.html)
+Please have a look at the complete format description of smtpd.conf
+configuration file (http://opensmtpd.org/smtpd.conf.5.html)
Add OpenSMTPD users
@@ -96,8 +100,9 @@ Add OpenSMTPD users
To operate, OpenSMTPD requires at least one user, by default _smtpd; and
preferably two users, by default _smtpd and _smtpq.
-Using two users instead of one will increase security by a large factor so...
-unless you want to voluntarily reduce security or you have absolute more faith in our code than we do, by all means use one.
+Using two users instead of one will increase security by a large factor
+so... unless you want to voluntarily reduce security or you have
+absolute more faith in our code than we do, by all means use one.
The instructions below assume the default users however, the configure
@@ -105,28 +110,31 @@ script allows overriding these using the options:
--with-privsep-user, --with-queue-user.
-### NetBSD, Linux (Debian, Arch Linux, ...)
+# NetBSD, Linux (Debian, Arch Linux, ...)
mkdir /var/empty
useradd -c "SMTP Daemon" -d /var/empty -s /sbin/nologin _smtpd
useradd -c "SMTPD Queue" -d /var/empty -s /sbin/nologin _smtpq
-### DragonFlyBSD, FreeBSD
+# DragonFlyBSD, FreeBSD
pw useradd _smtpd -c "SMTP Daemon" -d /var/empty -s /sbin/nologin
pw useradd _smtpq -c "SMTPD Queue" -d /var/empty -s /sbin/nologin
-### Mac OS X
+# Mac OS X
-First we need a group with an unused GID below 500, list the current ones used:
+First we need a group with an unused GID below 500, list the current
+ones used:
/usr/bin/dscl . -list /Groups PrimaryGroupID | sort -n -k2,2
Add a group - here we have picked 444:
- /usr/bin/sudo /usr/bin/dscl . -create /Groups/_smtpd PrimaryGroupID 444
+ /usr/bin/sudo /usr/bin/dscl . -create /Groups/_smtpd
+ PrimaryGroupID 444
-Then the user. Again we need an unused UID below 500, list the current ones used:
+Then the user. Again we need an unused UID below 500, list the current
+ones used:
/usr/bin/dscl . -list /Users UniqueID | sort -n -k2,2