Skip to content

Commit

Permalink
Remove Markdown from the README file
Browse files Browse the repository at this point in the history
- Strip [name](URL)
- Wrap long lines (with the exception of commands)
- Remove redundant # in sections
  • Loading branch information
mulander committed Jun 12, 2015
1 parent 8ccd9fc commit fdcda19
Showing 1 changed file with 39 additions and 30 deletions.
69 changes: 39 additions & 30 deletions README
@@ -1,29 +1,31 @@
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
* NetBSD
* 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!

Expand All @@ -35,13 +37,14 @@ Dependencies
------------

Portable OpenSMTPD relies on:
* [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)
* 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
Expand All @@ -64,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

Expand All @@ -86,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
Expand All @@ -95,37 +100,41 @@ 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
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

Expand Down

2 comments on commit fdcda19

@nitrocode
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why would you remove markdown from your readme file?

@mulander
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nitrocode #590 that's why.

Please sign in to comment.