diff --git a/README.md b/README.md index a7f62baa..95f399c6 100644 --- a/README.md +++ b/README.md @@ -1,67 +1 @@ -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/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/1-iredmail.releases.md) -* [iRedAdmin-Pro release notes and upgrade tutorial](https://bitbucket.org/zhb/docs.iredmail.org/src/default/upgrade/2-iredadmin-pro.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/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) -* [iRedAdmin-Pro: Default password restrictions](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/iredadmin-pro.default.password.policy.md) -* [LDAP: Add an alias domain](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/ldap.add.alias.domain.md) -* [LDAP: Add a mail alias account](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/ldap.add.mail.alias.md) -* [LDAP: Add a mail list account](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/ldap.add.mail.list.md) -* [LDAP: User mail forwarding.](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/ldap.user.mail.forwarding.md) -* [Monitor incoming and outgoing mails with BCC](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/monitor.incoming.and.outgoing.mails.with.bcc.md) -* [Pipe incoming email for certain user to external script ](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/pipe.incoming.email.for.certain.user.to.external.script.md) -* [Force Dovecot to recalculate mailbox quota](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/recalculate.mailbox.quota.md) -* [Reset user password](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/reset.user.password.md) -* [SQL: Create domain catch-all account for SQL backend](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/sql.create.domain.catchall.account.md) -* [SQL: Create an mail alias account with SQL command line](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/sql.create.mail.alias.md) -* [Store SpamAssassin bayes in SQL](https://bitbucket.org/zhb/docs.iredmail.org/src/default/howto/store.spamassassin.bayes.in.sql.md) - -Documents contributed by iRedMail users: - -* [Anti-spam with Dovecot antispam plugin and SpamAssassin](http://www.iredmail.org/forum/topic8169-iredmail-support-antispam-via-dovecot-and-spamassassin.html), contributed by Dexus. -# Third-party integrations -* [Integrate Microsoft Active Directory in iRedMail](https://bitbucket.org/zhb/docs.iredmail.org/src/default/integrations/active.directory.md) -* [SOGo: install SOGo on CentOS 6 with iRedMail (MySQL backend)](https://bitbucket.org/zhb/docs.iredmail.org/src/default/integrations/sogo-centos-6-mysql.md) - -Documents contributed by iRedMail users: - -* [Enabling Apache Solr 4.10 (using jetty) with Dovecot 2.2 for fulltext search results on Centos 6 (iRedMail compatible)](https://extremeshok.com/6622/enabling-apache-solr-4-10-using-jetty-with-dovecot-2-2-for-fulltext-search-results-on-centos-6-iredmail-compatible/) -# Cluster - -Documents contributed by iRedMail users: - -* [An Ultra-HA, full Mult-Master E-mail cluster with iRedMail, MariaDB, and IPVS](http://pastebin.com/JcYeQBrX), contributed by Joshua Boniface. -# Migrations -* [Migrate old iRedMail server to the latest stable release](https://bitbucket.org/zhb/docs.iredmail.org/src/default/migrations/migrate.to.new.iredmail.server.md) -* [Password hashes](https://bitbucket.org/zhb/docs.iredmail.org/src/default/migrations/password.hashes.md) -# Troubleshooting and Debug -* [Turn on debug mode in Amavisd and SpamAssassin](https://bitbucket.org/zhb/docs.iredmail.org/src/default/troubleshooting/turn.on.debug.mode.in.amavisd.md) -* [Turn on debug mode in Cluebringer](https://bitbucket.org/zhb/docs.iredmail.org/src/default/troubleshooting/turn.on.debug.mode.in.cluebringer.md) -* [Turn on debug mode in Dovecot](https://bitbucket.org/zhb/docs.iredmail.org/src/default/troubleshooting/turn.on.debug.mode.in.dovecot.md) -* [Turn on debug mode in iRedAPD](https://bitbucket.org/zhb/docs.iredmail.org/src/default/troubleshooting/turn.on.debug.mode.in.iredapd.md) -* [Turn on debug mode in OpenLDAP](https://bitbucket.org/zhb/docs.iredmail.org/src/default/troubleshooting/turn.on.debug.mode.in.openldap.md) -# Frequently Asked Questions -* [Locations of configuration and log files of mojor components](https://bitbucket.org/zhb/docs.iredmail.org/src/default/faq/file.locations.md) -* [Why append timestamp in maildir path](https://bitbucket.org/zhb/docs.iredmail.org/src/default/faq/why.append.timestamp.in.maildir.path.md) +Please visit http://www.iredmail.org/docs/ to read converted documents. diff --git a/convert.sh b/convert.sh index a015f9c0..5285381d 100644 --- a/convert.sh +++ b/convert.sh @@ -11,9 +11,6 @@ OUTPUT_DIR="${PWD}/html" # Markdown file used to store index of chapters/articles. INDEX_MD="${OUTPUT_DIR}/index.md" -# Markdown file used to be displayed automatically on bitbucket. -README_MD="${PWD}/README.md" - # Pack all converted HTML files for downloading PACK_NAME="iredmail-docs" PACK_TAR_NAME="iredmail-docs.tar.bz2" @@ -51,7 +48,6 @@ all_chapter_dirs="installation \ # - title: _title.md # - summary: _summary.md echo "We're migrating [old wiki documents](http://www.iredmail.org/wiki) to Markdown format for easier maintenance, all documents are available [here](https://bitbucket.org/zhb/docs.iredmail.org/src)." > ${INDEX_MD} -echo "We're migrating [old wiki documents](http://www.iredmail.org/wiki) to Markdown format for easier maintenance." > ${README_MD} for chapter_dir in ${all_chapter_dirs}; do # Get articles @@ -70,12 +66,10 @@ for chapter_dir in ${all_chapter_dirs}; do # 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 fi @@ -104,9 +98,6 @@ for chapter_dir in ${all_chapter_dirs}; do #echo "* [${_article_title}](${chapter_dir_in_article}/${article_html_file})" >> ${INDEX_MD} 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 - echo "* [${_article_title}](https://bitbucket.org/zhb/docs.iredmail.org/src/default/${article_file_without_prefix_path})" >> ${README_MD} fi # Convert file if it was modified @@ -130,7 +121,6 @@ for chapter_dir in ${all_chapter_dirs}; do if [ -f ${_links_md} ]; then cat ${_links_md} >> ${INDEX_MD} - cat ${_links_md} >> ${README_MD} fi done