majic-ansible-roles Changeset

Changeset - 4317e68e0ee5

Parent rev.

Child rev.

[Not reviewed]

0 2 0

Branko Majic (branko) - 21 months ago 2024-02-15 22:50:18
branko@majic.rs

MAR-197: Document the collapsible environment indicator in usage instructions and release notes.

2 files changed with 14 insertions and 2 deletions:

docs/releasenotes.rst

docs/usage.rst

0 comments (0 inline, 0 general)

docs/releasenotes.rst

➞

Show inline comments

@@ @@ -42,31 +42,42 @@ Dropped support for Debian 10 (Buster). @@
   * Dropped support for Python 2.7. Only Python 3 is supported now.
     The ``python_version`` role parameter has been dropped. The
     ``python_interpreter`` parameter is still available, but it
     defaults to Python 3 binary.
     Python (input) requirements files are now placed under the
     ``/etc/pip_check_requirements_upgrades`` path, in accordance to
     changes made in this release to the ``common`` role.
 **New features/improvements**
 * ``php_website`` role
   * Environment indicator can now be collapsed by clicking on the
     arrows on the left side.
 * ``web_server`` role
   * Added parameter ``environment_indicator`` which is used on the
     default page to indicate what environment the web server belongs
     to. Useful for distinguishing between test, staging, and
     production environments (similar to what is already available in
     the ``php_website`` and ``wsgi_website`` roles).
     the ``php_website`` and ``wsgi_website`` roles). Indicator can be
     collapsed by clicking on the arrows on the left side.
 * ``wsgi_website`` role
   * Environment indicator can now be collapsed by clicking on the
     arrows on the left side.
 **Bug fixes:**
 * ``common`` role
   * Fix deprecation warnings for Python requirements upgrade checks
     when using pip-tools 7.3.0. This would result in unnecessary
     notifications being sent out to server administrator.
 .1.0
 -----

docs/usage.rst

➞

Show inline comments

   does not have a dedicated group, and instead belongs to same group
   as the application user.
 * PHP applications are executed via FastCGI, using *PHP-FPM*.
 * If you ever need to set some additional PHP FPM settings, this can
   easily be done via the ``additional_fpm_config`` role
   parameter. This particular example does not set any, though.
 * Mails delivered to local admin/application users are forwarded to
   ``root`` account (configurable via ``website_mail_recipients`` role
   parameter.
 * If you ever find yourself mixing-up test and production websites,
   have a look at ``environment_indicator`` role parameter. It lets you
   insert small strip with environment information at bottom of each
   HTML page served by the web server.
   HTML page served by the web server. If the strip gets in the way, it
   can easily be collapsed using the arrows on the left side.
 * Static content (non-PHP) is served directly by *Nginx*.
 * Each web application gets distinct sub-directory under ``/var/www``,
   named after the FQDN. All sub-directories created under there are
   created with ``02750`` permissions, with ownership set to admin
   user, and group set to the application's group. In other words, all
   directories will have ``SGID`` bit set, allowing you to create
   files/directories that will have their group automatically set to
   the group of the parent directory.
 * Files are served (both by *Nginx* and *PHP-FPM*) from sub-directory
   called ``htdocs`` (located in website directory). For example
   ``/var/www/nextcloud.example.com/htdocs/``. Normally, this can be a
   symlink to some other sub-directory within the website directory

0 comments (0 inline, 0 general)