Commit d8847e4a authored by Reto Gantenbein's avatar Reto Gantenbein Committed by GitHub

Merge pull request #26 from ganto/doc-fixes

Various minor doc fixes
parents 3948b485 1cc3087d
......@@ -78,8 +78,8 @@ Changed
consistent with other DebOps roles. [ganto_]
- Changed default configuration of :envvar:`roundcube__www` from
``/srv/www/{{ roundcube__user }}`` to ``/srv/www`` to be more consistent with
other system-wide Web applications. [ganto_]
:file:`/srv/www/{{ roundcube__user }}` to :file:`/srv/www` to be more
consistent with other system-wide Web applications. [ganto_]
Fixed
......@@ -110,7 +110,7 @@ Fixed
~~~~~
- Fix documentation build error due to deleted link definition to deprecated
`debops.php5` role repository. [ganto_]
``debops.php5`` role repository. [ganto_]
- Probe if :envvar:`roundcube__domain` is a string and construct :envvar:`roundcube__git_checkout` accordingly. [cultcom]
......
......@@ -4,7 +4,7 @@
instead have a look at the files in the ./meta/ directory. -->
[![Travis CI](https://img.shields.io/travis/debops-contrib/ansible-roundcube.svg?style=flat)](https://travis-ci.org/debops-contrib/ansible-roundcube)
[![test-suite](https://img.shields.io/badge/test--suite-ansible--roundcube-blue.svg?style=flat)](https://github.com/debops-contrib/test-suite/tree/master/ansible-roundcube/)
[![test-suite](https://img.shields.io/badge/test--suite-ansible--roundcube-blue.svg?style=flat)](https://github.com/debops/test-suite/tree/master/ansible-roundcube/)
[![Ansible Galaxy](https://img.shields.io/badge/galaxy-debops--contrib.roundcube-660198.svg?style=flat)](https://galaxy.ansible.com/debops-contrib/roundcube/)
......@@ -21,7 +21,7 @@ ansible-galaxy install debops-contrib.roundcube
### Documentation
More information about `debops-contrib.roundcube` can be found in the
[official debops-contrib.roundcube documentation](https://docs.debops.org/en/latest/ansible/roles/ansible-roundcube/docs/).
[official debops-contrib.roundcube documentation](https://debops-contrib.readthedocs.io/en/latest/ansible/roles/ansible-roundcube/docs/).
### Role dependencies
......
......@@ -18,7 +18,7 @@ default values, your setup is likely to break if you simply execute the
updated role. To avoid this, take care of the following issues:
- If you are using a custom playbook, make sure to review the changes in
:ref:`roundcube__ref_example_playbook`.
the :ref:`roundcube__ref_example_playbook`.
- The following variables were replaced and therefore are not defined
anymore in the default variables:
......@@ -67,7 +67,7 @@ defined in the example playbook.
# rm /etc/nginx/{sites-available,sites-enabled}/roundcube.example.com.conf
# rm /etc/nginx/conf.d/upstream_php5_roundcube.conf
4. Run the role (e.g. via example playbook):
4. Run the role (e.g. via example playbook):
.. code:: shell
......@@ -84,8 +84,7 @@ defined in the example playbook.
6. In case Roundcube was installed into a new directory but you didn't use the
default :envvar:`roundcube__www` configuration before the update or you
experience SQL schema issues, you need to manually run the upstream post
update script on the Roundcube server. The given ``--version`` parameter
indicates the previous Roundcube version you were updating from.
update script on the Roundcube server.
.. code:: shell
......@@ -93,5 +92,5 @@ defined in the example playbook.
-c "php /srv/www/sites/roundcube.example.com/public/bin/updatedb.sh \
--package=roundcube --dir=/srv/www/sites/roundcube.example.com/public/SQL"
7. If you manually installed some additional plugins you might need to re-
install or update them for the new Roundcube version.
7. If you manually installed some additional plugins you might need to reinstall
or update them for the new Roundcube version.
......@@ -9,6 +9,7 @@
#
# .. include:: includes/all.rst
# Packages and installation [[[
# -----------------------------
......@@ -43,7 +44,7 @@ roundcube__optional_php_packages:
# List of user defined PHP packages for Roundcube.
roundcube__custom_php_packages: []
# ]]]
# ]]]
# .. envvar:: roundcube__base_php_packages [[[
#
# List of base PHP packages required by Roundcube.
......@@ -59,7 +60,7 @@ roundcube__base_php_packages:
#
# PHP packages which are installed via APT repository if they are available
# in a sufficiently new version in the current distribution. The required
# minimal versions are taken from the composer.json.dist of the Roundcube
# minimal versions are taken from the file:`composer.json.dist` of the Roundcube
# 1.3.0 release. If you install an older version of Roundcube you may want
# to adjust this list.
roundcube__apt_php_packages: '{{ [ "mail-mime", "net-smtp", "pear" ]
......@@ -103,12 +104,11 @@ roundcube__composer_phar: '{{ True
# ]]]
# .. envvar:: roundcube__composer_phar_url [[[
#
# URL to the composer.phar script which will be used to install PHP packages
# not available in the APT repository on distribution releases which don't
# package PHP composer. If this is set to `False`, :command:`composer` will
# be installed via APT package manager.
# URL to the file:`composer.phar` script which will be used to install PHP
# packages not available in the APT repository on distribution releases which
# don't package PHP composer. If this is set to ``False``, :command:`composer`
# will be installed via APT package manager.
roundcube__composer_phar_url: 'https://getcomposer.org/composer.phar'
# ]]]
# ]]]
# Roundcube user account [[[
......@@ -125,7 +125,7 @@ roundcube__user: 'roundcube'
# Roundcube system user group.
roundcube__group: 'roundcube'
# ]]]
# ]]]
# .. envvar:: roundcube__home [[[
#
# Path to the home directory of the Roundcube system account.
......@@ -162,7 +162,7 @@ roundcube__git_repo: 'https://github.com/roundcube/roundcubemail.git'
roundcube__git_dest: '{{ roundcube__src + "/" + roundcube__git_repo.split("://")[1] }}'
# ]]]
# .. envvar:: roundcube__git_tag [[[
# .. envvar:: roundcube__git_version [[[
#
# Roundcube release tag to deploy.
roundcube__git_version: '1.3.0'
......@@ -201,7 +201,6 @@ roundcube__webserver_user: '{{ ansible_local.nginx.user
ansible_local.nginx|d() and
ansible_local.nginx.user|d())
else "www-data" }}'
# ]]]
# ]]]
# Database configuration [[[
......@@ -225,6 +224,7 @@ roundcube__database_user: 'roundcube'
roundcube__database_password_path: '{{ secret + "/credentials/" + ansible_fqdn
+ "/roundcube/" + roundcube__database
+ "/" + roundcube__database_user + "/password" }}'
# ]]]
# .. envvar:: roundcube__database_password [[[
#
......@@ -262,7 +262,6 @@ roundcube__database_map:
# Initial Roundcube database schema loaded by Ansible.
roundcube__database_schema: '{{ roundcube__git_checkout + "/SQL/mysql.initial.sql"
if (roundcube__database_map[roundcube__database].dbtype == "mysql") else ""}}'
# ]]]
# ]]]
# Roundcube application options [[[
......
Credits
=======
* Reto Gantenbein <reto.gantenbein_at_linuxmonk_ch>
* author of the Ansible roundcube role
......@@ -9,16 +9,20 @@ To enable local spell checking of your email content, you have to install
dictionaries. For example for english and french spell checking, you would
add the following packages to your Roundcube role configuration:
roundcube__extra_packages: [ 'php5-enchant', 'aspell', 'aspell-en', 'aspell-fr' ]
.. code:: yaml
roundcube__packages: [ 'php5-enchant', 'aspell', 'aspell-en', 'aspell-fr' ]
Additionally you have to tell Roundcube that you want to use the local
spell checking library:
roundcube__local_config_map:
spellcheck_engine: 'enchant'
spellcheck_languages: "array('en', 'fr')"
.. code:: yaml
roundcube__local_config_map:
spellcheck_engine: 'enchant'
spellcheck_languages: "array('en', 'fr')"
Of course, many more languages are supported. You can find more information
about the required packages and configuration at the Roundcube `Aspell-Howto`_.
about the required packages and configuration in the Roundcube `Aspell-Howto`_.
.. _Aspell-Howto: http://trac.roundcube.net/wiki/Howto_Config/Aspell
......@@ -11,7 +11,6 @@ Ansible role: debops-contrib.roundcube
defaults
guides
copyright
credits
changelog
upgrade
......
......@@ -10,7 +10,7 @@ IMAP Web client written in PHP.
Installation
~~~~~~~~~~~~
This role requires at least Ansible ``v1.8.0``. To install it, run:
This role requires at least Ansible ``v2.3.0``. To install it, run:
.. code-block:: console
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment