This commit is contained in:
Zhang Huangbin 2014-12-04 11:11:39 +08:00
parent b0ebc209fe
commit 63cf626f9f
24 changed files with 49 additions and 44 deletions

View File

@ -1,25 +1,26 @@
We're migrating [old wiki documents](http://www.iredmail.org/wiki) to Markdown format for easier maintenance.
# Install iRedMail
* [Install iRedMail on Red Hat Enterprise Linux, CentOS](https://bitbucket.org/zhb/docs.iredmail.org/src/default/installation/0-install.iredmail.on.rhel.md)
* [Install iRedMail on Debian or Ubuntu Linux](https://bitbucket.org/zhb/docs.iredmail.org/src/default/installation/1-install.iredmail.on.debian.ubuntu.md)
* [Install iRedMail on FreeBSD](https://bitbucket.org/zhb/docs.iredmail.org/src/default/installation/2-install.iredmail.on.freebsd.md)
* [Install iRedMail on FreeBSD inside Jail (with ezjail)](https://bitbucket.org/zhb/docs.iredmail.org/src/default/installation/3-install.iredmail.on.freebsd.with.jail.md)
* [Install iRedMail on OpenBSD](https://bitbucket.org/zhb/docs.iredmail.org/src/default/installation/4-install.iredmail.on.openbsd.md)
* [Release notes and upgrade tutorials](https://bitbucket.org/zhb/docs.iredmail.org/src/default/installation/releases.md)
* [Install iRedMail on Red Hat Enterprise Linux, CentOS](https://bitbucket.org/zhb/docs.iredmail.org/src/default/installation/1-install.iredmail.on.rhel.md)
* [Install iRedMail on Debian or Ubuntu Linux](https://bitbucket.org/zhb/docs.iredmail.org/src/default/installation/2-install.iredmail.on.debian.ubuntu.md)
* [Install iRedMail on FreeBSD](https://bitbucket.org/zhb/docs.iredmail.org/src/default/installation/3-install.iredmail.on.freebsd.md)
* [Install iRedMail on FreeBSD inside Jail (with ezjail)](https://bitbucket.org/zhb/docs.iredmail.org/src/default/installation/4-install.iredmail.on.freebsd.with.jail.md)
* [Install iRedMail on OpenBSD](https://bitbucket.org/zhb/docs.iredmail.org/src/default/installation/5-install.iredmail.on.openbsd.md)
* [Setup DNS records for your iRedMail server](https://bitbucket.org/zhb/docs.iredmail.org/src/default/installation/setup.dns.md)
* [Perform silent/unattended iRedMail installation](https://bitbucket.org/zhb/docs.iredmail.org/src/default/installation/unattended.iredmail.installation.md)
# Release notes and upgrade tutorials
* [iRedMail: release notes and upgrade tutorials](https://bitbucket.org/zhb/docs.iredmail.org/src/default/upgrade/iredmail.releases.md)
# Configure mail client applications
* [Configure Thunderbird as mail client (POP3/IMAP, SMTP and global ldap address book)](https://bitbucket.org/zhb/docs.iredmail.org/src/default/mua/configure.thunderbird.md)
# How to
* [Allow certain users to send email as another user](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/0-allow.certain.users.to.send.email.as.different.user.md)
* [Change mail attachment size](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/0-change.mail.attachment.size.md)
* [Completely disable Amavisd + ClamAV + SpamAssassin](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/0-completely.disable.amavisd.clamav.spamassassin.md)
* [Enable SMTPS service (SMTP over SSL, port 465)](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/0-enable.smtps.md)
* [Disable spam virus scanning for outgoing mails](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/1-disable.spam.virus.scanning.for.outgoing.mails.md)
* [Amavisd + SpamAssassin not working, no mail header (X-Spam-*) inserted.](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/1-no.x-spam.headers.md)
* [Quarantining](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/1-quarantining.md)
* [Sign DKIM signature on outgoing emails for new mail domain](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/1-sign.dkim.signature.for.new.domain.md)
* [Allow insecure POP3/IMAP/SMTP connections without STARTTLS](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/2-allow.insecure.pop3.imap.smtp.connections.md)
* [Allow certain users to send email as another user](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/1-allow.certain.users.to.send.email.as.different.user.md)
* [Change mail attachment size](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/1-change.mail.attachment.size.md)
* [Completely disable Amavisd + ClamAV + SpamAssassin](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/1-completely.disable.amavisd.clamav.spamassassin.md)
* [Enable SMTPS service (SMTP over SSL, port 465)](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/1-enable.smtps.md)
* [Disable spam virus scanning for outgoing mails](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/2-disable.spam.virus.scanning.for.outgoing.mails.md)
* [Amavisd + SpamAssassin not working, no mail header (X-Spam-*) inserted.](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/2-no.x-spam.headers.md)
* [Quarantining](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/2-quarantining.md)
* [Sign DKIM signature on outgoing emails for new mail domain](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/2-sign.dkim.signature.for.new.domain.md)
* [Allow insecure POP3/IMAP/SMTP connections without STARTTLS](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/3-allow.insecure.pop3.imap.smtp.connections.md)
* [Allow user to send email without authentication](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/allow.user.to.send.email.without.authentication.md)
* [Force mail user to change password in 90 days](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/force.user.to.change.password.md)
* [Ignore Trash folder in mailbox quota](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/ignore.trash.folder.in.quota.md)

View File

@ -32,8 +32,13 @@
|- 1-what_is_iredmail.md
|- 2-why_choose_iredmail.md
|- 3-price.md
...
|- 0-hidden_article.md
```
* If you don't want to show an article in index page, prepend `0-` in its
file name as shown above.
* Run script `convert.sh` to convert Markdown files to HTML static files.
* It will generate index file `html/index.html` which includes all articles

View File

@ -53,10 +53,6 @@ for chapter_dir in ${all_chapter_dirs}; do
# Get articles
all_chapter_articles="$(find ${chapter_dir} -depth 1 -type f -iname '[0-9a-z]*.md')"
# Don't show chapter title and articles in index page.
hide_in_index='NO'
[ -f ${chapter_dir}/_hide_in_index ] && hide_in_index='YES'
# Output directory.
# Remove prefix '[number]-' in chapter directory name.
#chapter_dir_in_article="$(strip_name_prefix ${chapter_dir})"
@ -66,18 +62,16 @@ for chapter_dir in ${all_chapter_dirs}; do
_title_md="${chapter_dir}/_title.md"
_summary_md="${chapter_dir}/_summary.md"
if [ X"${hide_in_index}" != X'YES' ]; then
if [ -f ${_title_md} ]; then
# generate index info of chapter
_chapter_title="$(cat ${_title_md})"
echo -e "### ${_chapter_title}" >> ${INDEX_MD}
echo -e "# ${_chapter_title}" >> ${README_MD}
if [ -f ${_title_md} ]; then
# generate index info of chapter
_chapter_title="$(cat ${_title_md})"
echo -e "### ${_chapter_title}" >> ${INDEX_MD}
echo -e "# ${_chapter_title}" >> ${README_MD}
if [ -f ${_summary_md} ]; then
_chapter_summary="$(cat ${_summary_md})"
echo -e "${_chapter_summary}" >> ${INDEX_MD}
echo -e "${_chapter_summary}" >> ${README_MD}
fi
if [ -f ${_summary_md} ]; then
_chapter_summary="$(cat ${_summary_md})"
echo -e "${_chapter_summary}" >> ${INDEX_MD}
echo -e "${_chapter_summary}" >> ${README_MD}
fi
fi
@ -92,12 +86,17 @@ for chapter_dir in ${all_chapter_dirs}; do
# Replace '.md' suffix by '.html'
article_html_file="$(echo ${article_html_file/%.md/.html})"
hide_article_in_index='NO'
if echo "${article_file_basename}" | grep '^0-' &>/dev/null; then
hide_article_in_index='YES'
fi
# Get title.
_article_title="$(head -1 ${article_file} | awk -F'# ' '{print $2}')"
#_article_title="$(head -1 ${article_file} | awk -F'Title: ' '{print $2}')"
#echo "article title: ${_article_title}"
#echo "* [${_article_title}](${chapter_dir_in_article}/${article_html_file})" >> ${INDEX_MD}
if [ X"${hide_in_index}" != X'YES' ]; then
if [ X"${hide_article_in_index}" == X'NO' ]; then
echo "* [${_article_title}](${article_html_file})" >> ${INDEX_MD}
# 'src/default/' is path to view source file on bitbucket.org
@ -122,13 +121,11 @@ for chapter_dir in ${all_chapter_dirs}; do
done
# Append addition links at the chapter bottom on index page.
if [ X"${hide_in_index}" != X'YES' ]; then
_links_md="${chapter_dir}/_links.md"
_links_md="${chapter_dir}/_links.md"
if [ -f ${_links_md} ]; then
cat ${_links_md} >> ${INDEX_MD}
cat ${_links_md} >> ${README_MD}
fi
if [ -f ${_links_md} ]; then
cat ${_links_md} >> ${INDEX_MD}
cat ${_links_md} >> ${README_MD}
fi
done
@ -154,6 +151,7 @@ fi
# Sync newly generated HTML files to local diretories.
if echo "$@" | grep -q -- '--sync-local'; then
# Copy to local hg repo of http://www.iredmail.org/docs/
echo "* Syncing converted HTML files."
rm -rf ../web/docs/*
cp -rf html/* ../web/docs/

View File

@ -16,10 +16,13 @@
<li><a href="install.iredmail.on.freebsd.html">Install iRedMail on FreeBSD</a></li>
<li><a href="install.iredmail.on.freebsd.with.jail.html">Install iRedMail on FreeBSD inside Jail (with ezjail)</a></li>
<li><a href="install.iredmail.on.openbsd.html">Install iRedMail on OpenBSD</a></li>
<li><a href="releases.html">Release notes and upgrade tutorials</a></li>
<li><a href="setup.dns.html">Setup DNS records for your iRedMail server</a></li>
<li><a href="unattended.iredmail.installation.html">Perform silent/unattended iRedMail installation</a></li>
</ul>
<h3 id="release-notes-and-upgrade-tutorials">Release notes and upgrade tutorials</h3>
<ul>
<li><a href="iredmail.releases.html">iRedMail: release notes and upgrade tutorials</a></li>
</ul>
<h3 id="configure-mail-client-applications">Configure mail client applications</h3>
<ul>
<li><a href="configure.thunderbird.html">Configure Thunderbird as mail client (POP3/IMAP, SMTP and global ldap address book)</a></li>

View File

@ -1,7 +1,7 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Release notes and upgrade tutorials</title>
<title>iRedMail: release notes and upgrade tutorials</title>
<link href="./css/markdown.css" rel="stylesheet"></head>
</head>
<body>
@ -10,8 +10,7 @@
<a href="http://www.iredmail.org" target="_blank">iRedMail web site</a>
// <a href="./index.html">Document Index</a>
</div><h1 id="release-notes-and-upgrade-tutorials">Release notes and upgrade tutorials</h1>
<h2 id="iredmail">iRedMail</h2>
</div><h1 id="iredmail-release-notes-and-upgrade-tutorials">iRedMail: release notes and upgrade tutorials</h1>
<ul>
<li><strong>0.9.0</strong>, released on Dec ??, 2014. <a href="">Release notes</a>, <a href="./upgrade.iredmail.0.8.7-0.9.0.html">Upgrade from iRedMail-0.8.7</a></li>
<li><strong>0.8.7</strong>, released on May 13, 2014. <a href="http://www.iredmail.org/forum/topic6872-news-announcements-bug-fixes-iredmail087-has-been-released.html">Release notes</a>, <a href="./upgrade.iredmail.0.8.6-0.8.7.html">Upgrade from iRedMail-0.8.6</a></li>

View File

1
upgrade/_title.md Normal file
View File

@ -0,0 +1 @@
Release notes and upgrade tutorials

View File

@ -1,6 +1,4 @@
# Release notes and upgrade tutorials
## iRedMail
# iRedMail: release notes and upgrade tutorials
* __0.9.0__, released on Dec ??, 2014. [Release notes](), [Upgrade from iRedMail-0.8.7](./upgrade.iredmail.0.8.7-0.9.0.html)
* __0.8.7__, released on May 13, 2014. [Release notes](http://www.iredmail.org/forum/topic6872-news-announcements-bug-fixes-iredmail087-has-been-released.html), [Upgrade from iRedMail-0.8.6](./upgrade.iredmail.0.8.6-0.8.7.html)