mirror of
https://github.com/YunoHost-Apps/kimai2_ynh.git
synced 2024-09-03 19:26:26 +02:00
Auto-update README
This commit is contained in:
parent
606645263b
commit
6a0d9156b7
2 changed files with 90 additions and 33 deletions
61
README.md
61
README.md
|
@ -1,37 +1,37 @@
|
|||
# Kimai2 app for YunoHost
|
||||
<!--
|
||||
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||||
It shall NOT be edited by hand.
|
||||
-->
|
||||
|
||||
# Kimai2 for YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/kimai2)  
|
||||
[](https://install-app.yunohost.org/?app=kimai2)
|
||||
[](https://install-app.yunohost.org/?app=kimai2)
|
||||
|
||||
> *This package allows you to install kimai2 quickly and simply on a YunoHost server.
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *This package allows you to install Kimai2 quickly and simply on a YunoHost server.
|
||||
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||||
|
||||
## Overview
|
||||
|
||||
This is the reloaded version of the open source timetracker Kimai. Right now its in an early development phase, its usable but some advanced features from Kimai v1 are missing by now.
|
||||
|
||||
Kimai v2 has nothing in common with its predecessor Kimai v1 besides the basic ideas of time-tracking and the current development team. It is based on a lot of great frameworks. Special thanks to Symfony v4, Doctrine, AdminThemeBundle (based on AdminLTE).
|
||||
https://github.com/kevinpapst/kimai2
|
||||
|
||||
Shipped Version: **1.11.1**
|
||||
|
||||
**Shipped version:** 1.11.1~ynh1
|
||||
|
||||
**Demo:** https://www.kimai.org/demo/
|
||||
|
||||
## Screenshots
|
||||
|
||||

|
||||

|
||||
|
||||
## Demo
|
||||
## Disclaimers / important information
|
||||
|
||||
* [Official demo](https://www.kimai.org/demo/)
|
||||
|
||||
### Guidelines
|
||||
|
||||
1. Require dedicated domain like **kimai.domain.tld**.
|
||||
1. This app is multi-instance (you can have more then one Kimai instance running on a YunoHost server)
|
||||
|
||||
## Documentation
|
||||
|
||||
* Official documentation: https://www.kimai.org/documentation
|
||||
|
||||
## YunoHost specific features
|
||||
* Require dedicated domain like **kimai.domain.tld**.
|
||||
* This app is multi-instance (you can have more then one Kimai instance running on a YunoHost server)
|
||||
|
||||
#### Multi-user support
|
||||
|
||||
|
@ -44,22 +44,15 @@ Defaul Kimai2 roles are:
|
|||
* ROLE_SUPER_ADMIN => Kimai2 (Super_Admin) YunoHost permission
|
||||
Those roles are directly managed using YunoHost permission system. User choosen during installation is granted the ROLE_SUPER_ADMIN
|
||||
|
||||
#### Supported architectures
|
||||
## Documentation and resources
|
||||
|
||||
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/kimai2/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/kimai2/)
|
||||
* Official app website: https://www.kimai.org
|
||||
* Official admin documentation: https://www.kimai.org/documentation/
|
||||
* Upstream app code repository: https://github.com/kevinpapst/kimai2
|
||||
* YunoHost documentation for this app: https://yunohost.org/app_kimai2
|
||||
* Report a bug: https://github.com/YunoHost-Apps/kimai2_ynh/issues
|
||||
|
||||
## Links
|
||||
|
||||
* Report a bug: https://github.com/YunoHost-Apps/kimai2_ynh/issues
|
||||
* App website: https://www.kimai.org/
|
||||
* Upstream app repository: https://github.com/kevinpapst/kimai2
|
||||
* YunoHost website: https://yunohost.org/
|
||||
|
||||
---
|
||||
|
||||
Developer info
|
||||
----------------
|
||||
## Developer info
|
||||
|
||||
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/kimai2_ynh/tree/testing).
|
||||
|
||||
|
@ -69,3 +62,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/kimai2_ynh/tree/testi
|
|||
or
|
||||
sudo yunohost app upgrade kimai2 -u https://github.com/YunoHost-Apps/kimai2_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
62
README_fr.md
Normal file
62
README_fr.md
Normal file
|
@ -0,0 +1,62 @@
|
|||
# Kimai2 pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/kimai2)  
|
||||
[](https://install-app.yunohost.org/?app=kimai2)
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *Ce package vous permet d'installer Kimai2 rapidement et simplement sur un serveur YunoHost.
|
||||
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||||
|
||||
## Vue d'ensemble
|
||||
|
||||
This is the reloaded version of the open source timetracker Kimai. Right now its in an early development phase, its usable but some advanced features from Kimai v1 are missing by now.
|
||||
|
||||
Kimai v2 has nothing in common with its predecessor Kimai v1 besides the basic ideas of time-tracking and the current development team. It is based on a lot of great frameworks. Special thanks to Symfony v4, Doctrine, AdminThemeBundle (based on AdminLTE).
|
||||
|
||||
|
||||
**Version incluse :** 1.11.1~ynh1
|
||||
|
||||
**Démo :** https://www.kimai.org/demo/
|
||||
|
||||
## Captures d'écran
|
||||
|
||||

|
||||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
* Require dedicated domain like **kimai.domain.tld**.
|
||||
* This app is multi-instance (you can have more then one Kimai instance running on a YunoHost server)
|
||||
|
||||
#### Multi-user support
|
||||
|
||||
LDAP is supported
|
||||
HTTP auth is not supported
|
||||
Defaul Kimai2 roles are:
|
||||
* ROLE_USER
|
||||
* ROLE_TEAMLEAD => Kimai2 (Teamlead) YunoHost permission
|
||||
* ROLE_ADMIN => Kimai2 (Admin) YunoHost permission
|
||||
* ROLE_SUPER_ADMIN => Kimai2 (Super_Admin) YunoHost permission
|
||||
Those roles are directly managed using YunoHost permission system. User choosen during installation is granted the ROLE_SUPER_ADMIN
|
||||
|
||||
## Documentations et ressources
|
||||
|
||||
* Site officiel de l'app : https://www.kimai.org
|
||||
* Documentation officielle de l'admin : https://www.kimai.org/documentation/
|
||||
* Dépôt de code officiel de l'app : https://github.com/kevinpapst/kimai2
|
||||
* Documentation YunoHost pour cette app : https://yunohost.org/app_kimai2
|
||||
* Signaler un bug : https://github.com/YunoHost-Apps/kimai2_ynh/issues
|
||||
|
||||
## Informations pour les développeurs
|
||||
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/kimai2_ynh/tree/testing).
|
||||
|
||||
Pour essayer la branche testing, procédez comme suit.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/kimai2_ynh/tree/testing --debug
|
||||
ou
|
||||
sudo yunohost app upgrade kimai2 -u https://github.com/YunoHost-Apps/kimai2_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
|
Loading…
Add table
Reference in a new issue