Update documentation
This commit is contained in:
Frederic Guillot
parent
c1f05371bc
commit
4b22db5400
|
|
@ -32,6 +32,9 @@ Available commands:
|
|||
help Displays help for a command
|
||||
list Lists commands
|
||||
worker Execute queue worker
|
||||
db
|
||||
db:migrate Execute SQL migrations
|
||||
db:version Show database schema version
|
||||
export
|
||||
export:daily-project-column-stats Daily project column stats CSV export (number of tasks per column and per day)
|
||||
export:subtasks Subtasks CSV export
|
||||
|
|
@ -203,3 +206,19 @@ Note: Installed files will have the same permissions as the current user
|
|||
```bash
|
||||
./cli worker
|
||||
```
|
||||
|
||||
### Execute database migrations
|
||||
|
||||
If the parameter `DB_RUN_MIGRATIONS` is set to `false`, you have run the database migrations manually:
|
||||
|
||||
```bash
|
||||
./cli db:migrate
|
||||
```
|
||||
|
||||
### Check database schema version
|
||||
|
||||
```bash
|
||||
./cli db:version
|
||||
Current version: 95
|
||||
Last version: 96
|
||||
```
|
||||
|
|
|
|||
|
|
@ -30,6 +30,12 @@ Enable/disable plugin installation from the user interface:
|
|||
define('PLUGIN_INSTALLER', true); // Default is true
|
||||
```
|
||||
|
||||
Change default plugin directory URL:
|
||||
|
||||
```php
|
||||
define('PLUGIN_API_URL', 'https://kanboard.net/plugins.json');
|
||||
```
|
||||
|
||||
Folder for uploaded files
|
||||
-------------------------
|
||||
|
||||
|
|
@ -80,6 +86,11 @@ Database settings
|
|||
-----------------
|
||||
|
||||
```php
|
||||
// Run automatically database migrations
|
||||
// If set to false, you will have to run manually the SQL migrations from the CLI during the next Kanboard upgrade
|
||||
// Do not run the migrations from multiple processes at the same time (example: web page + background worker)
|
||||
define('DB_RUN_MIGRATIONS', true);
|
||||
|
||||
// Database driver: sqlite, mysql or postgres (sqlite by default)
|
||||
define('DB_DRIVER', 'sqlite');
|
||||
|
||||
|
|
@ -315,4 +326,7 @@ define('DISABLE_LOGOUT', false);
|
|||
|
||||
// Override API token stored in the database, useful for automated tests
|
||||
define('API_AUTHENTICATION_TOKEN', 'My unique API Token');
|
||||
|
||||
// TOTP (2FA) issuer name
|
||||
define('TOTP_ISSUER', 'Kanboard');
|
||||
```
|
||||
|
|
|
|||
|
|
@ -12,7 +12,8 @@ Choses importantes à faire avant la mise à jour
|
|||
- **Vérifiez que votre sauvegarde est valide !**
|
||||
- Vérifiez encore
|
||||
- Toujours lire la [liste des changements](https://github.com/kanboard/kanboard/blob/master/ChangeLog) pour vérifier sil y a des opérations manuelles à faire
|
||||
- Toujours fermer les sessions des utilisateurs sur le serveur
|
||||
- Stoppez le _worker_
|
||||
- Mettez le serveur web en mode maintenance pour éviter que les gens utilisent l'application pendant la mise à jour
|
||||
|
||||
Depuis l'archive (version stable)
|
||||
---------------------------------
|
||||
|
|
@ -33,3 +34,21 @@ Depuis le dépôt git (version de développement)
|
|||
3. Testez que tout fonctionne correctement
|
||||
|
||||
Cette méthode va installer **la version en cours de développement**, utilisez là à vos risques.
|
||||
|
||||
Appliquer les migrations SQL manuellement
|
||||
-----------------------------------------
|
||||
|
||||
Par défaut, les migrations SQL sont exécutées automatiquement.
|
||||
La version du schéma est vérifiée à chaque requête.
|
||||
De cette manière, les changements de base de données sont appliqués automatiquement.
|
||||
|
||||
Vous pouvez désactiver ce comportement si vous le souhaitez en fonction de votre configuration.
|
||||
Par exemple, si plusieurs processus essaient de mettre à jour le schéma en même temps, il se peut que vous ayez des problèmes même si chaque opération se fait dans une transaction.
|
||||
|
||||
Pour désactiver cette fonctionnalité, mettez le paramètre `DB_RUN_MIGRATIONS` à `false` dans votre fichier de [configuration](config.markdown).
|
||||
|
||||
Lorsque vous allez mettre à jour Kanboard, exécutez cette commande :
|
||||
|
||||
```bash
|
||||
./cli db:migrate
|
||||
```
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ The `data` folder is used to store:
|
|||
- Uploaded files: `files/*`
|
||||
- Image thumbnails: `files/thumbnails/*`
|
||||
|
||||
People who are using a remote database (Mysql/Postgresql) and a remote file storage (Aws S3 or similar) don't necessarily need to have a persistent local data folder or to change the permission.
|
||||
People who are using a remote database (Mysql/Postgresql) and a remote object storage (Aws S3 or similar) don't necessarily need to have a persistent local data folder or to change the permission.
|
||||
|
||||
From the git repository (development version)
|
||||
---------------------------------------------
|
||||
|
|
@ -54,7 +54,16 @@ The `.htaccess` is optional because its content can be included directly in the
|
|||
|
||||
You can also define a custom location for the plugins and files folders by changing the [config file](config.markdown).
|
||||
|
||||
Optional installation
|
||||
|
||||
Other Database Types
|
||||
--------------------
|
||||
|
||||
Kanboard supports Mysql and Postgres as alternative to Sqlite.
|
||||
|
||||
- [Mysql configuration](mysql-configuration.markdown]
|
||||
- [Postgres configuration](postgresql-configuration.markdown)
|
||||
|
||||
Optional Installation
|
||||
---------------------
|
||||
|
||||
- Some features of Kanboard require that you run [a daily background job](cronjob.markdown) (Reports and analytics)
|
||||
|
|
|
|||
|
|
@ -6,11 +6,9 @@ By default, Kanboard use Sqlite to store its data but it's also possible to use
|
|||
Requirements
|
||||
------------
|
||||
|
||||
- Postgresql server already installed and configured
|
||||
- Postgresql >= 9.3
|
||||
- The PHP extension `pdo_pgsql` installed (Debian/Ubuntu: `apt-get install php5-pgsql`)
|
||||
|
||||
Note: Kanboard is tested with **Postgresql 9.3 and 9.4**
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
|
|
@ -43,10 +41,10 @@ Note: You can also rename the template file `config.default.php` to `config.php`
|
|||
|
||||
For the first time, Kanboard will run one by one each database migration and this process can take some time according to your configuration.
|
||||
|
||||
To avoid any issues or potential timeouts you can initialize the database directly by importing the SQL schema:
|
||||
To avoid any issues or potential timeouts, you can initialize the database directly by importing the SQL schema:
|
||||
|
||||
```bash
|
||||
psql -U postgres my_database < app/Schema/Sql/postgres.sql
|
||||
```
|
||||
|
||||
The file `app/Schema/Sql/postgres.sql` is a sql dump that represents the last version of the database.
|
||||
The file `app/Schema/Sql/postgres.sql` is a SQL dump that represents the last version of the database.
|
||||
|
|
|
|||
|
|
@ -12,83 +12,51 @@
|
|||
- Выполните команду `./cli`
|
||||
|
||||
|
||||
Kanboard version master
|
||||
```bash
|
||||
Kanboard version master
|
||||
|
||||
Usage:
|
||||
command [options] [arguments]
|
||||
|
||||
Options:
|
||||
-h, --help Display this help message
|
||||
-q, --quiet Do not output any message
|
||||
-V, --version Display this application version
|
||||
--ansi Force ANSI output
|
||||
--no-ansi Disable ANSI output
|
||||
-n, --no-interaction Do not ask any interactive question
|
||||
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
|
||||
|
||||
Usage:
|
||||
|
||||
command [options] [arguments]
|
||||
|
||||
|
||||
|
||||
Options:
|
||||
|
||||
-h, --help Display this help message
|
||||
|
||||
-q, --quiet Do not output any message
|
||||
|
||||
-V, --version Display this application version
|
||||
|
||||
--ansi Force ANSI output
|
||||
|
||||
--no-ansi Disable ANSI output
|
||||
|
||||
-n, --no-interaction Do not ask any interactive question
|
||||
|
||||
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
|
||||
|
||||
|
||||
|
||||
Available commands:
|
||||
|
||||
cronjob Execute daily cronjob
|
||||
|
||||
help Displays help for a command
|
||||
|
||||
list Lists commands
|
||||
|
||||
export
|
||||
|
||||
export:daily-project-column-stats Daily project column stats CSV export (number of tasks per column and per day)
|
||||
|
||||
export:subtasks Subtasks CSV export
|
||||
|
||||
export:tasks Tasks CSV export
|
||||
|
||||
export:transitions Task transitions CSV export
|
||||
|
||||
locale
|
||||
|
||||
locale:compare Compare application translations with the fr_FR locale
|
||||
|
||||
locale:sync Synchronize all translations based on the fr_FR locale
|
||||
|
||||
notification
|
||||
|
||||
notification:overdue-tasks Send notifications for overdue tasks
|
||||
|
||||
plugin
|
||||
|
||||
plugin:install Install a plugin from a remote Zip archive
|
||||
|
||||
plugin:uninstall Remove a plugin
|
||||
|
||||
plugin:upgrade Update all installed plugins
|
||||
|
||||
projects
|
||||
|
||||
projects:daily-stats Calculate daily statistics for all projects
|
||||
|
||||
trigger
|
||||
|
||||
trigger:tasks Trigger scheduler event for all tasks
|
||||
|
||||
user
|
||||
|
||||
user:reset-2fa Remove two-factor authentication for a user
|
||||
|
||||
user:reset-password Change user password
|
||||
Available commands:
|
||||
cronjob Execute daily cronjob
|
||||
help Displays help for a command
|
||||
list Lists commands
|
||||
worker Execute queue worker
|
||||
db
|
||||
db:migrate Execute SQL migrations
|
||||
db:version Show database schema version
|
||||
export
|
||||
export:daily-project-column-stats Daily project column stats CSV export (number of tasks per column and per day)
|
||||
export:subtasks Subtasks CSV export
|
||||
export:tasks Tasks CSV export
|
||||
export:transitions Task transitions CSV export
|
||||
locale
|
||||
locale:compare Compare application translations with the fr_FR locale
|
||||
locale:sync Synchronize all translations based on the fr_FR locale
|
||||
notification
|
||||
notification:overdue-tasks Send notifications for overdue tasks
|
||||
plugin
|
||||
plugin:install Install a plugin from a remote Zip archive
|
||||
plugin:uninstall Remove a plugin
|
||||
plugin:upgrade Update all installed plugins
|
||||
projects
|
||||
projects:daily-stats Calculate daily statistics for all projects
|
||||
trigger
|
||||
trigger:tasks Trigger scheduler event for all tasks
|
||||
user
|
||||
user:reset-2fa Remove two-factor authentication for a user
|
||||
user:reset-password Change user password
|
||||
```
|
||||
|
||||
|
||||
Доступные команды[¶](#available-commands "Ссылка на этот заголовок")
|
||||
|
|
|
|||
|
|
@ -11,8 +11,9 @@ Important things to do before updating
|
|||
- **Always make a backup of your data before upgrading**
|
||||
- **Check that your backup is valid!**
|
||||
- Check again
|
||||
- Always read the [change log](https://github.com/kanboard/kanboard/blob/master/ChangeLog) to check for breaking changes
|
||||
- Always close all user sessions (flush all sessions on the server)
|
||||
- Always read the [change history](https://github.com/kanboard/kanboard/blob/master/ChangeLog) to check for breaking changes
|
||||
- Stop the worker if you use it
|
||||
- Put the web server in maintenance mode to avoid people use the software while upgrading
|
||||
|
||||
From the archive (stable version)
|
||||
---------------------------------
|
||||
|
|
@ -33,3 +34,20 @@ From the repository (development version)
|
|||
3. Login and check if everything is ok
|
||||
|
||||
Note: This method will install the **current development version**, use at your own risk.
|
||||
|
||||
Running SQL migrations manually
|
||||
-------------------------------
|
||||
|
||||
By default, SQL migrations are executed automatically. The schema version is checked at each request.
|
||||
In this way, when you upgrade Kanboard to another version, the database schema is updated for you.
|
||||
|
||||
You may want to disable this behaviour is case you have a specific configuration.
|
||||
For example, if multiple processes try to apply the migrations in the same time you might have some concurrency problems even if each operation is executed inside a transaction.
|
||||
|
||||
To disable this feature, set the parameter `DB_RUN_MIGRATIONS` at `false` in your [config file](config.markdown).
|
||||
|
||||
When you will have to upgrade Kanboard, run this command:
|
||||
|
||||
```bash
|
||||
./cli db:migrate
|
||||
```
|
||||
|
|
|
|||
Loading…
Reference in New Issue