Skip to content

Commit

Permalink
INSTALL: Use markdown style
Browse files Browse the repository at this point in the history
  • Loading branch information
cmouse authored and GitLab committed Oct 12, 2016
1 parent 73650a8 commit 335ac4a
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 39 deletions.
39 changes: 0 additions & 39 deletions INSTALL

This file was deleted.

39 changes: 39 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
Build Instructions
==================

For most people, the usual:

```
./configure
make
sudo make install
```

is enough. This installs Dovecot under /usr/local.

If you have installed some libraries into locations which require special include or library paths, you can give them in CPPFLAGS and LDFLAGS environment variables. For example:

`CPPFLAGS=-I/opt/openssl/include LDFLAGS=-L/opt/openssl/lib ./configure`

See `./configure --help` for a list of all available configure options.
See [http://wiki2.dovecot.org/CompilingSource](http://wiki2.dovecot.org/CompilingSource) for more information.

Running
=======

Start with the example configuration:

```
cp -r /usr/local/share/doc/dovecot/example-config/* /usr/local/etc/dovecot/
```

Read through, and make needed modifications.

Once everything is configured, start Dovecot by running "dovecot" binary.

See Wiki for more information about configuration. If you're in a hurry, go at least through [http://wiki2.dovecot.org/QuickConfiguration](http://wiki2.dovecot.org/QuickConfiguration)

SSL/TLS
=======

Dovecot used to support both GNUTLS and OpenSSL libraries, but nowadays only the OpenSSL code is working.
5 changes: 5 additions & 0 deletions Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ EXTRA_DIST = \
ChangeLog \
README \
README.md \
INSTALL \
INSTALL.md \
update-version.sh \
run-test-valgrind.supp \
$(conf_DATA)
Expand All @@ -26,6 +28,9 @@ nodist_pkginclude_HEADERS = config.h
README: README.md
$(PANDOC) -f markdown_github -t plain -o $@ $<

INSTALL: INSTALL.md
$(PANDOC) -f markdown_github -t plain -o $@ $<

ChangeLog:
git log --name-status --pretty="format:%ai %aN <%aE> (%h)%n%n%w(80,4,4)%s%n%n%b" 5d5c4f2bfb812c767084c0338dae692db476da10^.. > ChangeLog || rm -f ChangeLog

Expand Down

0 comments on commit 335ac4a

Please sign in to comment.