Document missed core commands (#44)

* Document missed core commands * MySQL date limit, link to tz doc from migration command * Update source/command-line.rst Co-Authored-By: Cédric Anne <cedric.anne@gmail.com> Co-authored-by: Cédric Anne <cedric.anne@gmail.com>
glpi-project · Apr 14, 2020 · 76d2bbb · 76d2bbb
1 parent 64087d0
commit 76d2bbb
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/source/command-line.rst b/source/command-line.rst
@@ -31,6 +31,21 @@ For every console command, following options are available:
 
 .. _cdline_install:
 
+Additional install and update tools
+-----------------------------------
+
+Check requirements
+^^^^^^^^^^^^^^^^^^
+
+Before installing or upgrading, requirements are automatically checked; but you can run them separately and see state for all of them using the ``glpi:system:check_requirements`` command.
+
+Enable/Disable maintenance
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+GLPI provides a maintenance mode that can be activated prior to an update, and deactivated after all has been checked.
+
+Just use the ``glpi:maintenance:enable`` and ``glpi:maintenance:disable`` commands.
+
 Install
 -------
 
@@ -201,3 +216,16 @@ Missing timestamps builder
 Prior to GLPI 9.1.0, fields corresponding to creation and modification dates were not existing.
 
 The ``php bin/console glpi:migration:build_missing_timestamps`` command can be used to rebuild missing values using available logs.
+
+Use timestamp data type
+^^^^^^^^^^^^^^^^^^^^^^^
+
+   .. versionadded:: 9.5.0
+
+Many date fields were using the ``DATETIME`` type, but this does not allow to rely on timezones. Timezone support requires all fields to use ``TIMESTAMP`` data type, but this query can be very long and therefore is not included in the standard update process.
+
+Using the ``glpi:migration:timestamps`` command will change those fields to the correct data type, but read :doc:`documentation on timezones <timezones>` before.
+
+.. warning::
+
+   Ensure to backup your database before!
diff --git a/source/timezones.rst b/source/timezones.rst
@@ -7,6 +7,10 @@ In order to get timezones working on a MariaDB/MySQL instance, you will have to
 
    Enabling timezone support on your MySQL instance may affect other database in the same instance; be carefull!
 
+.. warning::
+
+   Currently, MySQL and MariaDB have a maximum date limited to 2038-01-19 on fields relying on ``timestamp`` type!
+
 Non windows users
 -----------------