diff options
Diffstat (limited to 'doc')
85 files changed, 346 insertions, 323 deletions
diff --git a/doc/.htaccess b/doc/.htaccess deleted file mode 100644 index c47998cb..00000000 --- a/doc/.htaccess +++ /dev/null @@ -1,7 +0,0 @@ -<IfVersion >= 2.3> - Require all denied -</IfVersion> -<IfVersion < 2.3> - Order allow,deny - Deny from all -</IfVersion> diff --git a/doc/automatic-actions.markdown b/doc/automatic-actions.markdown index db56ccc0..d109a95b 100644 --- a/doc/automatic-actions.markdown +++ b/doc/automatic-actions.markdown @@ -14,17 +14,13 @@ Each project has a different set of automatic actions, the configuration panel i Add a new action ---------------- -### Choose an action +Click on the link **Add a new automatic action**. - + -### Choose an event - - - -### Define action parameters - - +- Choose an action +- Then, select an event +- And finally, define the parameters List of available actions ------------------------- diff --git a/doc/board-collapsed-expanded.markdown b/doc/board-collapsed-expanded.markdown index 594676bc..0164da95 100644 --- a/doc/board-collapsed-expanded.markdown +++ b/doc/board-collapsed-expanded.markdown @@ -7,7 +7,7 @@ Switching from one view to another can be done with the keyboard shortcut **"s"* Collapsed mode -------------- - + - If the task is assigned to someone, the initials of the person are shown next to the task number - If the task title is too long, you can put your mouse over the task to show a tooltip with the full title. @@ -15,5 +15,4 @@ Collapsed mode Expanded mode ------------- - - + diff --git a/doc/board-horizontal-scrolling-and-compact-view.markdown b/doc/board-horizontal-scrolling-and-compact-view.markdown index 323d0de5..51885529 100644 --- a/doc/board-horizontal-scrolling-and-compact-view.markdown +++ b/doc/board-horizontal-scrolling-and-compact-view.markdown @@ -5,8 +5,6 @@ When the board cannot fit on your screen, a horizontal scroll bar will appear at However, it's possible to switch to the compact the view to display all columns in your screen. - + Switching between horizontal scrolling and compact view can be done with the keyboard shortcut **"c"** or by using the drop-down menu on the top left. - -Note: It's possible that text overlaps in compact mode, that will be improved over the next releases.
\ No newline at end of file diff --git a/doc/board-show-hide-columns.markdown b/doc/board-show-hide-columns.markdown index 40edc5d8..c3f22424 100644 --- a/doc/board-show-hide-columns.markdown +++ b/doc/board-show-hide-columns.markdown @@ -3,9 +3,10 @@ Show and hide columns on the board You can hide or display columns very easily on the board: - + -- To hide a column, just click on the column title -- To show a hidden column, click on the vertical title +Pour cacher une colonne, ouvrez le menu déroulant de la colonne. -When a column is hidden, the number of tasks is displayed at the top. + + +To show again the column, click on the "plus icon". diff --git a/doc/cli.markdown b/doc/cli.markdown index 9334d84b..d38d8b53 100644 --- a/doc/cli.markdown +++ b/doc/cli.markdown @@ -45,6 +45,9 @@ Available commands: 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 @@ -147,3 +150,17 @@ This command send a "daily cronjob event" to all open tasks of each project. ./kanboard trigger:tasks Trigger task event: project_id=2, nb_tasks=1 ``` + +### Reset user password + +```bash +./kanboard user:reset-password my_user +``` + +You will be prompted for a password and confirmation. Characters are not printed to the screen. + +### Remove two-factor authentication for a user + +```bash +./kanboard user:reset-2fa my_user +``` diff --git a/doc/creating-projects.markdown b/doc/creating-projects.markdown index a87dbca0..373d93eb 100644 --- a/doc/creating-projects.markdown +++ b/doc/creating-projects.markdown @@ -14,7 +14,7 @@ Creating projects for multiple users From the dashboard, click on the link **New project**: - + It's very easy, you just have to find a name for your project! @@ -27,6 +27,13 @@ Creating a private project From the dashboard, click on the link **New private project**. - +Creating projects from another project +-------------------------------------- -Note: project names must be unique across the application. +When you create a new project, your can choose to duplicate the properties of another project : + +- Permissions +- Actions +- Swimlanes +- Catégories +- Tasks diff --git a/doc/editing-projects.markdown b/doc/editing-projects.markdown index 781a7cc6..e7fea212 100644 --- a/doc/editing-projects.markdown +++ b/doc/editing-projects.markdown @@ -5,7 +5,7 @@ Projects can be renamed and disabled at any time. To rename a project, just click on the link "Edit project" on the left. - + - The start date and end date are used to generate the project Gantt chart - The description is visible as tooltip on the board and on the projects listing page diff --git a/doc/faq.markdown b/doc/faq.markdown index 953f98e1..0a9129f2 100644 --- a/doc/faq.markdown +++ b/doc/faq.markdown @@ -20,6 +20,12 @@ I get a blank page after installing or upgrading Kanboard - If you use an aggressive OPcode caching, reload your web-server or php-fpm +I have the error "There is no suitable CSPRNG installed on your system" +----------------------------------------------------------------------- + +If you use PHP < 7.0, you need to have the openssl extension enabled or `/dev/urandom` accessible from the application if restricted by an `open_basedir` restriction. + + Page not found and the URL seems wrong (&amp;) -------------------------------------------------- diff --git a/doc/fr/automatic-actions.markdown b/doc/fr/automatic-actions.markdown index 844354a5..f136b98c 100644 --- a/doc/fr/automatic-actions.markdown +++ b/doc/fr/automatic-actions.markdown @@ -1,5 +1,5 @@ Actions automatiques -================= +==================== Pour réduire au minimum l'interaction avec les utilisateurs, Kanboard dispose d'actions automatiques. @@ -12,22 +12,18 @@ Chaque action automatique est définie ainsi : Chaque projet a une série d'actions automatisées qui lui sont propres, le panneau de configuration est situé sur la page qui liste les projets, il vous suffit de cliquer sur le lien **Actions automatiques**. Ajouter une nouvelle action ----------------- +--------------------------- -### Choisir une action +Cliquez sur le lien **Ajouter une nouvelle action**. - + -### Choisir un évènement - - - -### Définir les paramètres d'une action - - +- Commencez par choisir une action +- Ensuite, sélectionnez un évènement +- Et pour finir, les paramètres de l'action Liste des évènements disponibles ------------------------- +-------------------------------- - Déplacement d'une tâche vers une autre colonne - Déplacement d'une tâche à un autre emplacement de la même colonne @@ -56,7 +52,7 @@ Liste des évènements disponibles - Création d'un commentaire d'une *issue* de Bitbucket Liste des actions disponibles -------------------------- +----------------------------- - Fermer une tâche - Ouvrir une tâche @@ -110,7 +106,7 @@ Supposons que nous ayons deux projets : "Commande du client" et "Production". Un - Choisir l'évènement : **Fermer une tâche** - Définir les paramètres de l'action : **Colonne = Validé** et **Projet = Production** -### Quand une tâche est déplacée vers la toute dernière colonne, déplacer la même tâche exactement vers un autre projet +### Quand une tâche est déplacée vers la toute dernière colonne, déplacer la même tâche exactement vers un autre projet Supposons que nous ayons deux projets : "Idées" et "Développement". Une fois validée l'idée, la basculer vers le projet "Développement". diff --git a/doc/fr/board-collapsed-expanded.markdown b/doc/fr/board-collapsed-expanded.markdown index f72d990d..29396772 100644 --- a/doc/fr/board-collapsed-expanded.markdown +++ b/doc/fr/board-collapsed-expanded.markdown @@ -1,19 +1,18 @@ -Mode Replié et Déplié -=========================== +Mode replié et déplié +===================== +Les tâches peuvent être affichées sur le tableau en mode replié ou déplié. +Basculer d'un mode à l'autre peut être fait à l'aide du raccourci clavier **« s »** ou en utilisant le menu déroulant sur la gauche. -Les tâches peuvent être affichées sur le Tableau en mode Replié ou Déplié. -Basculer d'un mode à l'autre peut être fait à l'aide du raccourci clavier **"s"** ou en utilisant le menu déroulant sur la gauche. +Mode replié +----------- -Mode Replié --------------- - + - Si la tâche est affectée à quelqu'un, les initiales de la personne sont affichées à côté du numéro de la tâche. - Si le titre de la tâche est trop long, mettez le curseur de la souris au-dessus de la tâche pour voir une boite flottante avec le titre entier. -Mode Déplié -------------- - - +Mode déplié +----------- + diff --git a/doc/fr/board-horizontal-scrolling-and-compact-view.markdown b/doc/fr/board-horizontal-scrolling-and-compact-view.markdown index 51d28bbb..7ad9c23c 100644 --- a/doc/fr/board-horizontal-scrolling-and-compact-view.markdown +++ b/doc/fr/board-horizontal-scrolling-and-compact-view.markdown @@ -1,13 +1,11 @@ Défilement horizontal et mode compact ===================================== -Lorsque le tableau ne tient pas dans votre écran, une barre de défilement horizontal appaîtra au bas de l'écran. +Lorsque le tableau ne loge pas dans votre écran, une barre de défilement horizontal appaîtra en bas de l'écran. Cependant, il est possible de basculer vers la vue compacte pour afficher toutes les colonnes dans votre écran. - + -Basculer entre le défilement horizontal et la vue compacte s'effectue avec le raccourci clavier **"c"** ou en utilisant le menu déroulant sur la gauche. - -Note : Il est possible que du texte se superpose dans le mode compact, ceci sera amélioré dans les prochaines versions. +Basculer entre le défilement horizontal et la vue compacte s'effectue avec le raccourci clavier **« c »** ou en utilisant le menu déroulant sur la gauche. diff --git a/doc/fr/board-show-hide-columns.markdown b/doc/fr/board-show-hide-columns.markdown index e1e02c6b..8eac0b2c 100644 --- a/doc/fr/board-show-hide-columns.markdown +++ b/doc/fr/board-show-hide-columns.markdown @@ -1,12 +1,12 @@ Afficher ou cacher des colonnes dans le tableau -================================== +=============================================== Vous pouvez très facilement cacher ou afficher des colonnes dans le tableau : - + -- Pour cacher une colonne, cliquez juste sur le titre de la colonne -- Pour afficher une colonne cachée, cliquez sur le titre vertical +Pour cacher une colonne, ouvrez le menu déroulant de la colonne. -Lorsqu'une colonne est cachée, le nombre de tâches est affiché en haut de la colonne. + +Pour afficher de nouveau la colonne, cliquez sur l'icône avec le « plus ». diff --git a/doc/fr/captures/kanboard-acces-prive.png b/doc/fr/captures/kanboard-acces-prive.png Binary files differdeleted file mode 100644 index 8528ef4c..00000000 --- a/doc/fr/captures/kanboard-acces-prive.png +++ /dev/null diff --git a/doc/fr/captures/kanboard-acces-public.png b/doc/fr/captures/kanboard-acces-public.png Binary files differdeleted file mode 100644 index e7ff5531..00000000 --- a/doc/fr/captures/kanboard-acces-public.png +++ /dev/null diff --git a/doc/fr/captures/kanboard-board.png b/doc/fr/captures/kanboard-board.png Binary files differdeleted file mode 100644 index 9e81e48e..00000000 --- a/doc/fr/captures/kanboard-board.png +++ /dev/null diff --git a/doc/fr/captures/kanboard-creer-utilisateur.png b/doc/fr/captures/kanboard-creer-utilisateur.png Binary files differdeleted file mode 100644 index 37a72311..00000000 --- a/doc/fr/captures/kanboard-creer-utilisateur.png +++ /dev/null diff --git a/doc/fr/captures/kanboard-nouveauprojet-prive.png b/doc/fr/captures/kanboard-nouveauprojet-prive.png Binary files differdeleted file mode 100644 index 1523a9d8..00000000 --- a/doc/fr/captures/kanboard-nouveauprojet-prive.png +++ /dev/null diff --git a/doc/fr/captures/kanboard-nouveauprojet.png b/doc/fr/captures/kanboard-nouveauprojet.png Binary files differdeleted file mode 100644 index 6ee30681..00000000 --- a/doc/fr/captures/kanboard-nouveauprojet.png +++ /dev/null diff --git a/doc/fr/captures/kanboard-swimlanes.png b/doc/fr/captures/kanboard-swimlanes.png Binary files differdeleted file mode 100644 index 06602ad9..00000000 --- a/doc/fr/captures/kanboard-swimlanes.png +++ /dev/null diff --git a/doc/fr/captures/kanboard-vue-calendrier.png b/doc/fr/captures/kanboard-vue-calendrier.png Binary files differdeleted file mode 100644 index 799add41..00000000 --- a/doc/fr/captures/kanboard-vue-calendrier.png +++ /dev/null diff --git a/doc/fr/captures/kanboard-vue-gantt.png b/doc/fr/captures/kanboard-vue-gantt.png Binary files differdeleted file mode 100644 index 445e8a87..00000000 --- a/doc/fr/captures/kanboard-vue-gantt.png +++ /dev/null diff --git a/doc/fr/captures/kanboard-vue-liste.png b/doc/fr/captures/kanboard-vue-liste.png Binary files differdeleted file mode 100644 index 41311245..00000000 --- a/doc/fr/captures/kanboard-vue-liste.png +++ /dev/null diff --git a/doc/fr/creating-projects.markdown b/doc/fr/creating-projects.markdown index e869e89f..e5da7cc6 100644 --- a/doc/fr/creating-projects.markdown +++ b/doc/fr/creating-projects.markdown @@ -7,26 +7,33 @@ Kanboard peut gérer de multiples projets. Voici deux sortes de projets : - Les projets privés, réservés à un seul utilisateur Créer des projets multi-utilisateurs -------------------------------------- +------------------------------------ -- Seuls les administrateurs et administrateurs de projets peuvent créer ce type de projets +- Seuls les administrateurs et les gestionnaires de projets peuvent créer ce type de projets - La gestion des utilisateurs est disponible -Depuis le tableau principal, cliquez sur le lien **Nouveau projet** : +Depuis le tableau de bord, cliquez sur le lien **Nouveau projet** : - + C'est vraiment très simple, il vous suffit de trouver un nom pour votre projet ! Créer un projet privé --------------------------- +--------------------- -- Tout le monde peut créer un projet privé +- Tout le monde peut créer un projet privé (sauf si désactivé par l'administrateur) - Il n'y a **pas** de gestion des utilisateurs - Seuls le propriétaire et les administrateurs peuvent accéder au projet Depuis le tableau principal, cliquez sur le lien **Nouveau projet privé**. - +Créer un projet depuis un autre projet +-------------------------------------- -Remarque : les noms de projets doivent être uniques dans toute l'application. +Lorsque vous créez un nouveau projet, vous pouvez choisir de dupliquer les propriétés d'un projet existant : + +- Permissions +- Catégories +- Actions +- Swimlanes +- Tâches diff --git a/doc/fr/editing-projects.markdown b/doc/fr/editing-projects.markdown index 67f8a0db..2186a1b9 100644 --- a/doc/fr/editing-projects.markdown +++ b/doc/fr/editing-projects.markdown @@ -1,11 +1,11 @@ Modifier des projets -================ +==================== Les projets peuvent être renommés et désactivés à tout moment. Pour renommer un projet, il suffit de cliquer sur le lien « Modifier un projet » sur la gauche. - + - Les dates de début et de fin sont utilisées pour créer le diagramme de Gantt du projet - La description est visible en infobulle sur le tableau et sur la page qui liste les projets @@ -13,4 +13,3 @@ Pour renommer un projet, il suffit de cliquer sur le lien « Modifier un projet - Vous pouvez également convertir un projet multi-utilisateur en projet privé. Remarque : quand vous rendez un projet privé, tous les utilisateurs existants auront accès au projet. Ajustez la liste des utilisateurs selon vos besoins. - diff --git a/doc/fr/index.markdown b/doc/fr/index.markdown index 3f7930f3..f74c3fce 100644 --- a/doc/fr/index.markdown +++ b/doc/fr/index.markdown @@ -19,6 +19,7 @@ Utiliser Kanboard ### Travailler avec les projets +- [Types de projets](project-types.markdown) - [Créer des projets](creating-projects.markdown) - [Modifier des projets](editing-projects.markdown) - [Partager des tableaux et des tâches](sharing-projects.markdown) @@ -46,6 +47,7 @@ Utiliser Kanboard ### Travailler avec les utilisateurs +- [Rôles](roles.markdown) - [Gestion des utilisateurs](user-management.markdown) - [Notifications](notifications.markdown) - [Authentification à deux facteurs](2fa.markdown) diff --git a/doc/fr/project-permissions.markdown b/doc/fr/project-permissions.markdown index 9e21e1ad..c4ef4df4 100644 --- a/doc/fr/project-permissions.markdown +++ b/doc/fr/project-permissions.markdown @@ -1,49 +1,22 @@ Permissions des projets -=================== +======================= -Deux sortes d'utilisateurs sont en charge d'un projet : les **gestionnaires de projet** et les **membres du projet**. +Chaque projet est isolé des autres. +Les accès au projet doivent être autorisés par le chef de projet. -- Les gestionnaires de projet peuvent gérer la configuration du projet et accéder aux rapports. -- Les membres du projet ne peuvent effectuer que des opérations de base (créer ou déplacer des tâches). +Chaque utilisateur et chaque groupe peut avoir un rôle différent. +Il y a 3 types de [rôles pour les projets](roles.markdown) : -Quand vous créez un nouveau projet, le statut de gestionnaire de projet vous est automatiquement attribué. +- Chef de projet +- Membre du projet +- Visualiseur -Les administrateurs de Kanboard peuvent accéder à tout mais ils ne sont pas nécessairement gestionnaires de projet ni membres du projet. **Ces permissions sont définies au niveau du projet**. +L'assignation des rôles est disponible depuis **Paramètres du projet > Permissions**: -Permissions selon chaque rôle -------------------------- + -### Membres du projet +Si vous choisissez d'autoriser tout le monde, tous les utilisateurs de Kanboard seront considérés comme **Membre du projet**. +Ce qui signifie qu'il n'y a plus des gestion de rôles. +Les permissions par utilisateur ou par groupe ne peuvent plus être appliquées. -- Utiliser le tableau (créer, déplacer et modifier les tâches) -- Supprimer seulement les tâches créées par eux-mêmes - -### Gestionnaires du projet - -- Utiliser le tableau -- Configurer le projet -- Partager, renommer, dupliquer et désactiver le projet -- Gérer les swimlanes, les catégories, colonnes et utilisateurs -- Modifier les actions automatisées -- Exporter en CSV -- Supprimer les tâches de n'importe quel membre du projet -- Accéder à la section analytique - -Ils ne **peuvent pas supprimer un projet**. - -Gérer les utilisateurs et les permissions ----------------------------- - -Pour définir les rôles dans un projet, allez sur la page de **configuration de projet** puis cliquez sur **Gestion des utilisateurs**. - -### Gestion des utilisateurs - - - -C'est l'endroit où vous pouvez choisir de nouveaux membres, modifier leur rôle ou interrompre l'accès d'un utilisateur. - -### Permission générale - -Si vous choisissez d'autoriser tout le monde (tous les utilisateurs de Kanboard), le projet est considéré comme public. - -Cela signifie qu'il n'y a plus de rôle de gestionnaire de projet. Les permissions par utilisateur ne peuvent pas s'appliquer. +Les projets privés ne peuvent pas définir de permissions. diff --git a/doc/fr/project-types.markdown b/doc/fr/project-types.markdown new file mode 100644 index 00000000..70434ec8 --- /dev/null +++ b/doc/fr/project-types.markdown @@ -0,0 +1,14 @@ +Types de projets +================ + +Il y a deux types de projets : + +| Type | Description | +|-------------------|-------------------------------------------------------------------------------------| +| Projet d'équipe | La gestion des utilisateurs est activée | +| Projet privé | Projet qui appartient à une seule personne, il n'y a pas de gestion d'utilisateurs | + +- Seulement les administrateurs et les gestionnaires peuvent créer des projets d'équipe. +- Les projets privés peuvent être créé par tout le monde. + +[Lire la documentation à propos des rôles dans Kanboard](roles.markdown) diff --git a/doc/fr/project-views.markdown b/doc/fr/project-views.markdown index 0f893d44..603108f6 100644 --- a/doc/fr/project-views.markdown +++ b/doc/fr/project-views.markdown @@ -1,44 +1,61 @@ Vues Tableau, Agenda et Liste -============================== -Pour chaque projet, les tâches peuvent être visualisées dans différentes vues : **Tableau, Agenda, Liste ou Gantt**. Chaque vue affiche le résultat filtré par le champ de recherche en haut de page. Le moteur de recherche utilise la [syntaxe avancée](search.markdown). +============================= + +Pour chaque projet, les tâches peuvent être visualisées dans différentes vues : **Tableau, Agenda, Liste ou Gantt**. +Chaque vue affiche le résultat filtré par le champ de recherche en haut de page. +Le moteur de recherche utilise la [syntaxe avancée](search.markdown). Vue Tableau ----------- - +----------- + + - Dans cette vue, il est possible de glisser-déposer facilement des tâches d'une colonne à l'autre. -- Il est également possible d'utiliser le raccourci clavier **"v b"** pour afficher la vue Tableau. +- Il est également possible d'utiliser le raccourci clavier **« v b »** pour afficher la vue Tableau. - Les tâches avec une ombre ont été modifiées récemment. - + -Lorsque la limite de tâches est atteinte pour une colonne, l'arrière-plan devient rouge. Ce qui signifie qu'il y a trop de tâches en cours en même temps. +Lorsque la limite de tâches est atteinte pour une colonne, l'arrière-plan devient rouge. +Ce qui signifie qu'il y a trop de tâches en cours en même temps. [En apprendre plus sur la configuration du Tableau](board-configuration.markdown) - + Vue Agenda --------------- +---------- - + - Dans cette vue, il est possible de voir les tâches avec des dates d'échéance. - Selon les paramètres, il est également possible de voir les tâches en cours. -- Il est également possible d'utiliser le raccourci clavier **"v c"** pour afficher la vue Agenda. +- Il est également possible d'utiliser le raccourci clavier **« v c »** pour afficher la vue Agenda. - [En apprendre plus sur la configuration de l'Agenda](calendar-configuration.markdown) Vue Liste ----------- +--------- - + - Dans cette vue, tous les résultats de votre recherche sont affichés dans un tableau. -- Il est également possible d'utiliser le raccourci clavier **"v l"** pour afficher la vue Liste. +- Il est également possible d'utiliser le raccourci clavier **« v l »** pour afficher la vue Liste. Vue Gantt ----------- +--------- - + - La vue Gantt affiche les tâches dans une fresque horizontale - Le diagramme utilise la date de début et la date d'échéance pour afficher les tâches -- Il est également possible d'utiliser le raccourci clavier **"v g"** pour afficher la vue Gantt. +- Il est également possible d'utiliser le raccourci clavier **« v g »** pour afficher la vue Gantt. + +Aperçu du projet +---------------- + + + +Ce mode permet d'afficher une vue d'ensemble du projet : + +- Vous pouvez voir la description du projet +- Attacher et visualiser des pièces-jointes au projet +- Visualiser la liste des membres +- Voir les dernières activités du projet diff --git a/doc/fr/roles.markdown b/doc/fr/roles.markdown new file mode 100644 index 00000000..e55a3969 --- /dev/null +++ b/doc/fr/roles.markdown @@ -0,0 +1,24 @@ +Rôles des utilisateurs +====================== + +Rôles au niveau de l'application +-------------------------------- + +Chaque utilisateur possède un de ces rôles : + +| Rôle | Description | +|----------------|----------------------------------------------------------------------------------------| +| Administrateur | Accès à tout | +| Gestionnaire | Peut créer des projets d'équipe mais ne peut pas changer les réglages de l'application | +| Utilisateur | Peut créer des projets privés | + +Rôles au niveau des projets +--------------------------- + +Chaque membre d'un projet peut avoir un rôle différent : + +| Rôle | Description | +|------------------------|----------------------------------------------------------------------| +| Chef de projet | Peut changer les paramètres du projet, accéder aux rapports | +| Membre du projet | Peut créer des tâches et utiliser le tableau Kanban | +| Visualiseur de projet | Accès en lecture seule au projet | diff --git a/doc/fr/screenshots/automatic-action-creation.png b/doc/fr/screenshots/automatic-action-creation.png Binary files differnew file mode 100644 index 00000000..ad90590d --- /dev/null +++ b/doc/fr/screenshots/automatic-action-creation.png diff --git a/doc/fr/screenshots/board-collapsed-mode.png b/doc/fr/screenshots/board-collapsed-mode.png Binary files differnew file mode 100644 index 00000000..a496faff --- /dev/null +++ b/doc/fr/screenshots/board-collapsed-mode.png diff --git a/doc/fr/screenshots/board-compact-mode.png b/doc/fr/screenshots/board-compact-mode.png Binary files differnew file mode 100644 index 00000000..872ceae5 --- /dev/null +++ b/doc/fr/screenshots/board-compact-mode.png diff --git a/doc/fr/screenshots/board-expanded-mode.png b/doc/fr/screenshots/board-expanded-mode.png Binary files differnew file mode 100644 index 00000000..19f61451 --- /dev/null +++ b/doc/fr/screenshots/board-expanded-mode.png diff --git a/doc/fr/screenshots/board-task-limit.png b/doc/fr/screenshots/board-task-limit.png Binary files differnew file mode 100644 index 00000000..8353f33c --- /dev/null +++ b/doc/fr/screenshots/board-task-limit.png diff --git a/doc/fr/screenshots/board-view.png b/doc/fr/screenshots/board-view.png Binary files differnew file mode 100644 index 00000000..0d1e18ea --- /dev/null +++ b/doc/fr/screenshots/board-view.png diff --git a/doc/fr/screenshots/calendar-view.png b/doc/fr/screenshots/calendar-view.png Binary files differnew file mode 100644 index 00000000..1226162b --- /dev/null +++ b/doc/fr/screenshots/calendar-view.png diff --git a/doc/fr/screenshots/gantt-view.png b/doc/fr/screenshots/gantt-view.png Binary files differnew file mode 100644 index 00000000..3caafa98 --- /dev/null +++ b/doc/fr/screenshots/gantt-view.png diff --git a/doc/fr/screenshots/hide-column.png b/doc/fr/screenshots/hide-column.png Binary files differnew file mode 100644 index 00000000..61015f9a --- /dev/null +++ b/doc/fr/screenshots/hide-column.png diff --git a/doc/fr/screenshots/list-view.png b/doc/fr/screenshots/list-view.png Binary files differnew file mode 100644 index 00000000..c40e807a --- /dev/null +++ b/doc/fr/screenshots/list-view.png diff --git a/doc/fr/screenshots/new-project.png b/doc/fr/screenshots/new-project.png Binary files differnew file mode 100644 index 00000000..42e5f196 --- /dev/null +++ b/doc/fr/screenshots/new-project.png diff --git a/doc/fr/screenshots/new-user.png b/doc/fr/screenshots/new-user.png Binary files differnew file mode 100644 index 00000000..116e9074 --- /dev/null +++ b/doc/fr/screenshots/new-user.png diff --git a/doc/fr/screenshots/project-disable-sharing.png b/doc/fr/screenshots/project-disable-sharing.png Binary files differnew file mode 100644 index 00000000..58832045 --- /dev/null +++ b/doc/fr/screenshots/project-disable-sharing.png diff --git a/doc/fr/screenshots/project-edition.png b/doc/fr/screenshots/project-edition.png Binary files differnew file mode 100644 index 00000000..ce8594fe --- /dev/null +++ b/doc/fr/screenshots/project-edition.png diff --git a/doc/fr/screenshots/project-enable-sharing.png b/doc/fr/screenshots/project-enable-sharing.png Binary files differnew file mode 100644 index 00000000..147ccc53 --- /dev/null +++ b/doc/fr/screenshots/project-enable-sharing.png diff --git a/doc/fr/screenshots/project-permissions.png b/doc/fr/screenshots/project-permissions.png Binary files differnew file mode 100644 index 00000000..54f38690 --- /dev/null +++ b/doc/fr/screenshots/project-permissions.png diff --git a/doc/fr/screenshots/project-view.png b/doc/fr/screenshots/project-view.png Binary files differnew file mode 100644 index 00000000..ff9a7f76 --- /dev/null +++ b/doc/fr/screenshots/project-view.png diff --git a/doc/fr/screenshots/show-column.png b/doc/fr/screenshots/show-column.png Binary files differnew file mode 100644 index 00000000..51f78ac8 --- /dev/null +++ b/doc/fr/screenshots/show-column.png diff --git a/doc/fr/screenshots/swimlane-configuration.png b/doc/fr/screenshots/swimlane-configuration.png Binary files differnew file mode 100644 index 00000000..d0b25e9c --- /dev/null +++ b/doc/fr/screenshots/swimlane-configuration.png diff --git a/doc/fr/screenshots/swimlanes.png b/doc/fr/screenshots/swimlanes.png Binary files differnew file mode 100644 index 00000000..e24a5b85 --- /dev/null +++ b/doc/fr/screenshots/swimlanes.png diff --git a/doc/fr/sharing-projects.markdown b/doc/fr/sharing-projects.markdown index af3d43b0..f3db3c68 100644 --- a/doc/fr/sharing-projects.markdown +++ b/doc/fr/sharing-projects.markdown @@ -1,5 +1,5 @@ Partager des tableaux et des tâches -======================== +=================================== Par défaut, les tableaux sont privés, mais il est possible de rendre un tableau public. @@ -15,11 +15,11 @@ Exemples d'utilisation : - Afficher le tableau sur un grand écran dans votre bureau Activer l'accès public -------------------- +---------------------- Choisissez votre projet, puis cliquez sur « Accès public » et enfin sur le bouton « Activer l'accès public ». - + Lorsque l'accès public est activé, plusieurs liens sont créés : @@ -27,11 +27,9 @@ Lorsque l'accès public est activé, plusieurs liens sont créés : - Lien de souscription au fil RSS - Lien d'abonnement à iCalendar - + Vous pouvez désactiver l'accès public à tout moment. À chaque fois que vous activez ou désactivez l'accès public, un nouveau jeton aléatoire est créé. **Les liens précédents ne fonctionneront pas**. - - diff --git a/doc/fr/swimlanes.markdown b/doc/fr/swimlanes.markdown index 48772117..92b4a9fa 100644 --- a/doc/fr/swimlanes.markdown +++ b/doc/fr/swimlanes.markdown @@ -2,12 +2,13 @@ Swimlanes ========= Les *swimlanes* sont des séparations horizontales de votre tableau (pensez à des « couloirs » ou « lignes d'eau » dans une piscine). + Par exemple, cela peut servir à séparer les sorties des différentes versions d'un logiciel, à diviser vos tâches selon différents produits, équipes ou tout autre critère de votre choix. Tableau avec des swimlanes --------------------- +-------------------------- - + Gestion des swimlanes ------------------ @@ -18,7 +19,7 @@ Gestion des swimlanes Pour configurer les swimlanes allez sur la page de **Configuration du projet** et choisissez la section **Swimlanes**. - + À partir de cet endroit, vous pouvez ajouter une nouvelle swimlane ou renommer celle qui existe par défaut. Vous pouvez aussi désactiver et modifier la position des diverses swimlanes. diff --git a/doc/fr/user-management.markdown b/doc/fr/user-management.markdown index 9fd03c43..bb9b0731 100644 --- a/doc/fr/user-management.markdown +++ b/doc/fr/user-management.markdown @@ -1,72 +1,26 @@ Gestion des utilisateurs -=============== - -Rôles au niveau de l'application ------------------------------- - -Kanboard utilise un système de permissions basique qui reconnaît 3 types d'utilisateurs : - -### Administrateur - -- Peut accéder à tout - -### Administrateur de projets - -- Peut créer des projets multi-utilisateurs et privés -- Peut convertir les projets multi-utilisateurs et privés -- Peut voir seulement ses propres projets -- Ne peut pas modifier les paramètres de l'application -- Ne peut pas gérer les utilisateurs - -### Utilisateur standard - -- Peut créer seulement des projets privés -- Peut voir seulement ses propres projets -- Ne peut pas supprimer de projets - -Rôles au niveau des projets --------------------------- - -Ces rôles sont liés aux permissions du projet. - -### Gestionnaire de projet - -- Peut gérer seulement ses propres projets -- Peut accéder aux rapports et à la section budget - -### Membre du projet - -- Peut pratiquer toutes les opérations quotidiennes sur son projet (créer et déplacer des tâches…) -- Ne peut pas configurer les projets - -Remarque : n'importe quel « utilisateur de base » peut être promu « Gestionnaire de projet » pour un projet donné, il n'est pas nécessaire d'être « Administrateur de projets ». - -Utilisateurs locaux et distants ----------------------- - -- Un utilisateur local est un compte qui utilise la base de données pour stocker ses identifiants. Les utilisateurs locaux utilisent le formulaire de connexion pour s'identifier. -- Un utilisateur distant est un compte qui utilise un système externe pour stocker ses identifiants. Par exemple, ce peut être un compte LDAP, Github ou Google. L'authentification de ces utilisateurs peut s'effectuer ou non avec le formulaire de connexion. +======================== Ajouter un nouvel utilisateur --------------- +----------------------------- Pour ajouter un nouvel utilisateur, vous devez être administrateur. -1. Depuis le tableau de bord, allez au menu **Gestion des utilisateurs** +1. Depuis le menu déroulant situé en haut à droite, cliquez sur **Gestion des utilisateurs** 2. Dans la partie haute vous avez un lien **Créer un utilisateur local** ou **Créer un utilisateur distant** 3. Informez les champs de saisie et enregistrez - + Quand vous créez un **utilisateur local**, vous devez préciser au moins deux valeurs : - **nom d'utilisateur** : c'est l'identifiant unique de votre utilisateur (login) - **mot de passe** : le mot de passe de votre utilisateur doit comporter au moins 6 caractères -Pour les **utilisateurs distants**, seul le nom d'utilisateur est obligatoire. Vous pouvez aussi leur associer leur compte Github ou Google si vous connaissez déjà leur id unique. +Pour les **utilisateurs distants**, seul le nom d'utilisateur est obligatoire. Modifier des utilisateurs ----------- +------------------------- Quand vous allez au menu **utilisateurs**, vous disposez d'une liste d'utilisateurs. Pour modifier un utilisateur cliquez sur le lien **Modifier**. @@ -74,7 +28,7 @@ Quand vous allez au menu **utilisateurs**, vous disposez d'une liste d'utilisate - vous devez être administrateur pour pouvoir modifier n'importe quel utilisateur Supprimer des utilisateurs ------------- +-------------------------- Depuis le menu **utilisateurs**, cliquez sur le lien **supprimer**. Ce lien n'est visible que si vous êtes administrateur. diff --git a/doc/installation.markdown b/doc/installation.markdown index dd4283f8..c796ac65 100644 --- a/doc/installation.markdown +++ b/doc/installation.markdown @@ -29,7 +29,7 @@ From the repository (development version) You must install [composer](https://getcomposer.org/) to use this method. 1. `git clone https://github.com/fguillot/kanboard.git` -2. `composer install` +2. `composer install --no-dev` 3. Go to the third step just above Note: This method will install the **current development version**, use at your own risk. diff --git a/doc/plugin-hooks.markdown b/doc/plugin-hooks.markdown index 9b511c78..a00aba16 100644 --- a/doc/plugin-hooks.markdown +++ b/doc/plugin-hooks.markdown @@ -28,15 +28,6 @@ Some hooks can have only one listener: - `$start` (DateTime) - `$end` (DateTime) -#### model:subtask-time-tracking:calendar:events - -- Override subtask time tracking events to display the calendar -- Arguments: - - `$user_id` (integer) - - `$events` (array) - - `$start` (string, ISO-8601 format) - - `$end` (string, ISO-8601 format) - ### Merge hooks "Merge hooks" act in the same way as the function `array_merge`. The hook callback must return an array. This array will be merged with the default one. @@ -163,6 +154,7 @@ List of template hooks: | `template:board:public:task:before-title` | Task in public board: before title | | `template:board:public:task:after-title` | Task in public board: after title | | `template:board:task:footer` | Task in board: footer | +| `template:board:task:icons` | Task in board: tooltip icon | | `template:config:sidebar` | Sidebar on settings page | | `template:config:application ` | Application settings form | | `template:config:integrations` | Integration page in global settings | @@ -177,9 +169,9 @@ List of template hooks: | `template:project:integrations` | Integration page in projects settings | | `template:project:sidebar` | Sidebar in project settings | | `template:project-user:sidebar` | Sidebar on project user overview page | -| `template:task:menu` | "Actions" menu on left in different task views | | `template:task:dropdown` | Task dropdown menu in listing pages | | `template:task:sidebar` | Sidebar on task page | +| `template:task:form:left-column` | Left column in task form | | `template:task:form:right-column` | Right column in task form | | `template:task:show:top ` | Show task page: top | | `template:task:show:bottom` | Show task page: bottom | diff --git a/doc/plugin-overrides.markdown b/doc/plugin-overrides.markdown index 722b4126..96a09e47 100644 --- a/doc/plugin-overrides.markdown +++ b/doc/plugin-overrides.markdown @@ -34,3 +34,9 @@ $this->template->setTemplateOverride('header', 'theme:layout/header'); ``` The first argument is the original template name and the second argument the template to use as replacement. + +You can still use the original template using the "kanboard:" prefix: + +```php +<?= $this->render('kanboard:header') ?> +``` diff --git a/doc/project-views.markdown b/doc/project-views.markdown index b45f8178..4ed464de 100644 --- a/doc/project-views.markdown +++ b/doc/project-views.markdown @@ -8,13 +8,13 @@ The search engine uses the [advanced syntax](search.markdown). Board View ---------- - + - With this view you can drag and drop tasks between columns easily. - You can also use the keyboard shortcut **"v b"** to switch to the board view. - Tasks with a shadow are recently modified. - + When the task limit is reached for a column, the background becomes red. That means there are too many tasks in progress at the same time. @@ -23,7 +23,7 @@ When the task limit is reached for a column, the background becomes red. That me Calendar View -------------- - + - With this view you can visualize tasks with a due date. - Depending of the settings, you can also see tasks in progress. @@ -41,8 +41,18 @@ List View Gantt View ---------- - + - The Gantt view displays tasks on a horizontal timeline - The start date and the due date are used to display the chart - For quick access, use the keyboard shortcut: **v g** + +Project Overview +---------------- + + + +- View the description of the project +- Attach and upload documents to the project +- View list of project members +- View the last activities of the project diff --git a/doc/roles.markdown b/doc/roles.markdown index 1b65a8c4..181904d5 100644 --- a/doc/roles.markdown +++ b/doc/roles.markdown @@ -22,4 +22,3 @@ Each individual team project can assign a different role to each user and group: | Project Manager | Can change project settings, access to the Gantt chart and reports | | Project Member | Can create tasks and use the board | | Project Viewer | Read-only access to the board and tasks | - diff --git a/doc/screenshots/automatic-action-creation.png b/doc/screenshots/automatic-action-creation.png Binary files differnew file mode 100644 index 00000000..5ce35dc6 --- /dev/null +++ b/doc/screenshots/automatic-action-creation.png diff --git a/doc/screenshots/board-collapsed-mode.png b/doc/screenshots/board-collapsed-mode.png Binary files differnew file mode 100644 index 00000000..ef51f811 --- /dev/null +++ b/doc/screenshots/board-collapsed-mode.png diff --git a/doc/screenshots/board-compact-mode.png b/doc/screenshots/board-compact-mode.png Binary files differnew file mode 100644 index 00000000..b9f06f08 --- /dev/null +++ b/doc/screenshots/board-compact-mode.png diff --git a/doc/screenshots/board-expanded-mode.png b/doc/screenshots/board-expanded-mode.png Binary files differnew file mode 100644 index 00000000..727dd00f --- /dev/null +++ b/doc/screenshots/board-expanded-mode.png diff --git a/doc/screenshots/board-task-limit.png b/doc/screenshots/board-task-limit.png Binary files differnew file mode 100644 index 00000000..87d58f21 --- /dev/null +++ b/doc/screenshots/board-task-limit.png diff --git a/doc/screenshots/board-view.png b/doc/screenshots/board-view.png Binary files differnew file mode 100644 index 00000000..ce5817a4 --- /dev/null +++ b/doc/screenshots/board-view.png diff --git a/doc/screenshots/calendar-view.png b/doc/screenshots/calendar-view.png Binary files differnew file mode 100644 index 00000000..67321c07 --- /dev/null +++ b/doc/screenshots/calendar-view.png diff --git a/doc/screenshots/gantt-view.png b/doc/screenshots/gantt-view.png Binary files differnew file mode 100644 index 00000000..084d17c5 --- /dev/null +++ b/doc/screenshots/gantt-view.png diff --git a/doc/screenshots/hide-column.png b/doc/screenshots/hide-column.png Binary files differnew file mode 100644 index 00000000..66c58f2a --- /dev/null +++ b/doc/screenshots/hide-column.png diff --git a/doc/screenshots/list-view.png b/doc/screenshots/list-view.png Binary files differnew file mode 100644 index 00000000..0e737dfd --- /dev/null +++ b/doc/screenshots/list-view.png diff --git a/doc/screenshots/new-project.png b/doc/screenshots/new-project.png Binary files differnew file mode 100644 index 00000000..be868a50 --- /dev/null +++ b/doc/screenshots/new-project.png diff --git a/doc/screenshots/new-user.png b/doc/screenshots/new-user.png Binary files differnew file mode 100644 index 00000000..c34fc321 --- /dev/null +++ b/doc/screenshots/new-user.png diff --git a/doc/screenshots/project-disable-sharing.png b/doc/screenshots/project-disable-sharing.png Binary files differnew file mode 100644 index 00000000..fcff064a --- /dev/null +++ b/doc/screenshots/project-disable-sharing.png diff --git a/doc/screenshots/project-edition.png b/doc/screenshots/project-edition.png Binary files differnew file mode 100644 index 00000000..3db21116 --- /dev/null +++ b/doc/screenshots/project-edition.png diff --git a/doc/screenshots/project-enable-sharing.png b/doc/screenshots/project-enable-sharing.png Binary files differnew file mode 100644 index 00000000..d95a8f25 --- /dev/null +++ b/doc/screenshots/project-enable-sharing.png diff --git a/doc/screenshots/project-permissions.png b/doc/screenshots/project-permissions.png Binary files differindex c4450755..139833e2 100644 --- a/doc/screenshots/project-permissions.png +++ b/doc/screenshots/project-permissions.png diff --git a/doc/screenshots/project-view.png b/doc/screenshots/project-view.png Binary files differnew file mode 100644 index 00000000..98209de5 --- /dev/null +++ b/doc/screenshots/project-view.png diff --git a/doc/screenshots/show-column.png b/doc/screenshots/show-column.png Binary files differnew file mode 100644 index 00000000..c45f1dd9 --- /dev/null +++ b/doc/screenshots/show-column.png diff --git a/doc/screenshots/swimlane-configuration.png b/doc/screenshots/swimlane-configuration.png Binary files differnew file mode 100644 index 00000000..4bc13ae0 --- /dev/null +++ b/doc/screenshots/swimlane-configuration.png diff --git a/doc/screenshots/swimlanes.png b/doc/screenshots/swimlanes.png Binary files differnew file mode 100644 index 00000000..700bc020 --- /dev/null +++ b/doc/screenshots/swimlanes.png diff --git a/doc/search.markdown b/doc/search.markdown index 1a97a7fc..37bb8625 100644 --- a/doc/search.markdown +++ b/doc/search.markdown @@ -1,7 +1,8 @@ Advanced Search Syntax ====================== -Kanboard uses a simple query language for advanced search. +Kanboard uses a simple query language for advanced search. +You can search in tasks, comments, subtasks, links but also in the activity stream. Example of query ---------------- @@ -12,23 +13,23 @@ This example will return all tasks assigned to me with a due date for tomorrow a assigne:me due:tomorrow my title ``` -Search by task id or title --------------------------- +Global search +------------- + +### Search by task id or title - Search by task id: `#123` - Search by task id and task title: `123` - Search by task title: anything that doesn't match any search attributes -Search by status ----------------- +### Search by status Attribute: **status** - Query to find open tasks: `status:open` - Query to find closed tasks: `status:closed` -Search by assignees -------------------- +### Search by assignee Attribute: **assignee** @@ -38,18 +39,28 @@ Attribute: **assignee** - Query for unassigned tasks: `assignee:nobody` - Query for my assigned tasks: `assignee:me` -Note: Kanboard will also search in assigned subtasks with the status todo and in progress. +### Search by task creator + +Attribute: **creator** + +- Tasks created by myself: `creator:me` +- Tasks created by John Doe: `creator:"John Doe"` +- Tasks created by the user id #1: `creator:1` + +### Search by subtask assignee + +Attribute: **subtask:assignee** + +- Example: `subtask:assignee:"John Doe"` -Search by color ---------------- +### Search by color Attribute: **color** - Query to search by color id: `color:blue` - Query to search by color name: `color:"Deep Orange"` -Search by the due date ----------------------- +### Search by the due date Attribute: **due** @@ -69,8 +80,7 @@ Operators supported with a date: - Greater than or equal: **due:>=2015-06-29** - Lower than or equal: **due:<=2015-06-29** -Search by modification date ---------------------------- +### Search by modification date Attribute: **modified** or **updated** @@ -80,29 +90,25 @@ There is also a filter by recently modified tasks: `modified:recently`. This query will use the same value as the board highlight period configured in settings. -Search by creation date ------------------------ +### Search by creation date Attribute: **created** Works in the same way as the modification date queries. -Search by description ---------------------- +### Search by description -Attribute: **description** +Attribute: **description** or **desc** Example: `description:"text search"` -Search by external reference ----------------------------- +### Search by external reference The task reference is an external id of your task, by example a ticket number from another software. - Find tasks with a reference: `ref:1234` or `reference:TICKET-1234` -Search by category ------------------- +### Search by category Attribute: **category** @@ -110,8 +116,7 @@ Attribute: **category** - Find all tasks that have those categories: `category:"Bug" category:"Improvements"` - Find tasks with no category assigned: `category:none` -Search by project ------------------ +### Search by project Attribute: **project** @@ -119,28 +124,56 @@ Attribute: **project** - Find tasks by project id: `project:23` - Find tasks for several projects: `project:"My project A" project:"My project B"` -Search by columns ------------------ +### Search by columns Attribute: **column** - Find tasks by column name: `column:"Work in progress"` - Find tasks for several columns: `column:"Backlog" column:ready` -Search by swim lane -------------------- +### Search by swim-lane Attribute: **swimlane** -- Find tasks by swim lane: `swimlane:"Version 42"` -- Find tasks in the default swim lane: `swimlane:default` -- Find tasks into several swim lanes: `swimlane:"Version 1.2" swimlane:"Version 1.3"` +- Find tasks by swim-lane: `swimlane:"Version 42"` +- Find tasks in the default swim-lane: `swimlane:default` +- Find tasks into several swim-lanes: `swimlane:"Version 1.2" swimlane:"Version 1.3"` -Search by task link ------------------- +### Search by task link Attribute: **link** - Find tasks by link name: `link:"is a milestone of"` - Find tasks into several links: `link:"is a milestone of" link:"relates to"` +### Search by comment + +Attribute: **comment** + +- Find comments that contains this title: `comment:"My comment message"` + +Activity stream search +---------------------- + +### Search events by task title + +Attribute: **title** or none (default) + +- Example: `title:"My task"` +- Search by task id: `#123` + +### Search events by task status + +Attribute: **status** + +### Search by event creator + +Attribute: **creator** + +### Search by event creation date + +Attribute: **created** + +### Search events by project + +Attribute: **project** diff --git a/doc/sharing-projects.markdown b/doc/sharing-projects.markdown index c10b0f39..614c3230 100644 --- a/doc/sharing-projects.markdown +++ b/doc/sharing-projects.markdown @@ -15,11 +15,11 @@ Usage examples: - Display the board on a large screen in your office Enable public access -------------------- +-------------------- Select your project, then click on "Public access" and finally click on the button "Enable public access". - + When the public access is enabled, a couple of links are generated: @@ -27,7 +27,7 @@ When the public access is enabled, a couple of links are generated: - RSS feed subscription link - iCalendar subscription link - + You can also disable the public access whenever you want. diff --git a/doc/swimlanes.markdown b/doc/swimlanes.markdown index 3a67fb89..f76336b9 100644 --- a/doc/swimlanes.markdown +++ b/doc/swimlanes.markdown @@ -1,13 +1,16 @@ -Swim lanes -========== +Swimlanes +========= Swimlanes are horizontal separations in your board. -By example, it's useful to separate software releases, divide your tasks in different products, teams or whatever you want. +For example, it's useful to separate software releases, divide your tasks in different products, teams or whatever you want. Board with swimlanes -------------------- - + + +- You can collapse swimlanes by clicking on the icon on the left +- The default swimlane is always shown at the top Managing swimlanes ------------------ @@ -18,7 +21,7 @@ Managing swimlanes To configure swimlanes go to the **project configuration page** and choose the section **Swimlanes**. - + From there, you can add a new swimlane or rename the default one. You can also disable and change the position of the different swimlanes. diff --git a/doc/ubuntu-installation.markdown b/doc/ubuntu-installation.markdown index ab4dfe7c..25ee2069 100644 --- a/doc/ubuntu-installation.markdown +++ b/doc/ubuntu-installation.markdown @@ -1,20 +1,35 @@ How to install Kanboard on Ubuntu? ================================== -Ubuntu Trusty 14.04 LTS +Ubuntu Xenial 16.04 LTS ----------------------- Install Apache and PHP: ```bash sudo apt-get update -sudo apt-get install -y php5 php5-sqlite php5-gd php5-json php5-mcrypt unzip +sudo apt-get install -y apache2 libapache2-mod-php7.0 php7.0-cli php7.0-mbstring php7.0-sqlite3 \ + php7.0-opcache php7.0-json php7.0-mysql php7.0-pgsql php7.0-ldap php7.0-gd +``` + +Install Kanboard: + +```bash +cd /var/www/html +sudo wget http://kanboard.net/kanboard-latest.zip +sudo unzip kanboard-latest.zip +sudo chown -R www-data:www-data kanboard/data +sudo rm kanboard-latest.zip ``` -In case your web server was running restart to make sure the php modules are reloaded: +Ubuntu Trusty 14.04 LTS +----------------------- + +Install Apache and PHP: ```bash -service apache2 restart +sudo apt-get update +sudo apt-get install -y php5 php5-sqlite php5-mysql php5-pgsql php5-ldap php5-gd php5-json php5-mcrypt unzip ``` Install Kanboard: @@ -27,4 +42,24 @@ sudo chown -R www-data:www-data kanboard/data sudo rm kanboard-latest.zip ``` +Ubuntu Precise 12.04 LTS +------------------------ + +Install Apache and PHP: + +```bash +sudo apt-get update +sudo apt-get install -y php5 php5-sqlite php5-mysql php5-pgsql php5-ldap php5-gd php5-json php5-mcrypt unzip +``` + +Install Kanboard: + +```bash +cd /var/www +sudo wget http://kanboard.net/kanboard-latest.zip +sudo unzip kanboard-latest.zip +sudo chown -R www-data:www-data kanboard/data +sudo rm kanboard-latest.zip +``` + Some features of Kanboard require that you run [a daily background job](cronjob.markdown). diff --git a/doc/update.markdown b/doc/update.markdown index 7be8a65a..12ac152d 100644 --- a/doc/update.markdown +++ b/doc/update.markdown @@ -27,7 +27,7 @@ From the repository (development version) ----------------------------------------- 1. `git pull` -2. `composer install` +2. `composer install --no-dev` 3. Login and check if everything is ok Note: This method will install the **current development version**, use at your own risk. diff --git a/doc/user-management.markdown b/doc/user-management.markdown index 38033eb3..3c53db99 100644 --- a/doc/user-management.markdown +++ b/doc/user-management.markdown @@ -1,4 +1,4 @@ -User management +User Management =============== Add a new user @@ -6,18 +6,18 @@ Add a new user To add a new user, you must be an administrator. -1. From the dashboard, go to the menu **User Management** +1. From the dropdown menu in the top right corner, go to the menu **Users Management** 2. On the top, you have a link **New local user** or **New remote user** -3. Fill out the form and save +3. Fill the form and save - + When you create a **local user**, you have to specify at least those values: - **username**: This is the unique identifier of your user (login) - **password**: The password of your user must have at least 6 characters -For **remote users**, only the username is mandatory. You can also pre-link Github or Google accounts if you already know their unique id. +For **remote users**, only the username is mandatory. Edit users ---------- diff --git a/doc/vagrant.markdown b/doc/vagrant.markdown index d11bca84..864f37b8 100644 --- a/doc/vagrant.markdown +++ b/doc/vagrant.markdown @@ -1,64 +1,10 @@ Run Kanboard with Vagrant ========================= -Vagrant is used to test Kanboard in different environments. +You can try Kanboard with Vagrant very easily: -Several configurations are available: +- Clone the project from the git repository +- Run `vagrant up` +- You can access to the application by using the URL `http://localhost:8001/` -- Ubuntu 14.04 LTS -- Debian 8 -- Debian 7 -- Debian 6 -- Centos 7 -- Centos 6.7 -- Freebsd 10 - -The installation process is not fully automated for all VM, manual configuration can be required. - -To use those configurations, you have to install the **last version of Virtualbox and Vagrant**. - -Standard boxes can be downloaded from Vagrant: - -```bash -vagrant box add ubuntu/trusty64 -vagrant box add debian/jessie64 -vagrant box add debian/wheezy64 -vagrant box add bento/debian-6.0.10 -vagrant box add centos/7 -vagrant box add bento/centos-6.7 -vagrant box add freebsd/FreeBSD-10.2-STABLE -``` - -### Example with Ubuntu and Sqlite - -If you want to test Kanboard on Ubuntu with Sqlite: - -```bash -vagrant up sqlite -``` - -The current directory is synced to the Apache document root. - -Composer dependencies have to be there, so if you didn't run `composer install` on your host machine you can also do it on the guest machine. - -Each box has its own TCP port: - -- ubuntu: http://localhost:8001/ -- debian8: http://localhost:8002/ -- debian7: http://localhost:8003/ -- debian6: http://localhost:8004/ -- centos7: http://localhost:8005/ -- centos6: http://localhost:8006/ -- freebsd10: http://localhost:8007/ - -Available boxes are: - -- `vagrant up ubuntu` -- `vagrant up debian8` -- `vagrant up debian7` -- `vagrant up debian6` -- `vagrant up centos7` -- `vagrant up centos6` -- `vagrant up freebsd10` - -Any specific configuration has to be done manually (Postgres or Mysql). +The virtual machine is based on Ubuntu 14.04 with PHP 5.5. |
