An open API service indexing awesome lists of open source software.

https://github.com/bodsch/ansible-kimai

Ansible role to install and configure kimai
https://github.com/bodsch/ansible-kimai

ansible ansible-role automation kimai kimai-timetracking kimai2 php8

Last synced: 2 months ago
JSON representation

Ansible role to install and configure kimai

Awesome Lists containing this project

README

          

# Ansible Role: `kimai`

Install an kimai from [sources](https://github.com/kimai/kimai).

> Kimai is a web-based multi-user time-tracking application.
> Works great for everyone: freelancers, companies, organizations - everyone can track their times,
> generate reports, create invoices and do so much more.

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/bodsch/ansible-kimai/main.yml?branch=main)][ci]
[![GitHub issues](https://img.shields.io/github/issues/bodsch/ansible-kimai)][issues]
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/bodsch/ansible-kimai)][releases]
[![Ansible Downloads](https://img.shields.io/ansible/role/d/bodsch/kimai?logo=ansible)][galaxy]

[ci]: https://github.com/bodsch/ansible-kimai/actions
[issues]: https://github.com/bodsch/ansible-kimai/issues?q=is%3Aopen+is%3Aissue
[releases]: https://github.com/bodsch/ansible-kimai/releases
[galaxy]: https://galaxy.ansible.com/ui/standalone/roles/bodsch/kimai

## Requirements & Dependencies

- running mariadb / mysql database
- PHP > 8.0
- nginx

### Ansible Collections

- [bodsch.core](https://github.com/bodsch/ansible-collection-core)
- [bodsch.scm](https://github.com/bodsch/ansible-collection-scm)
- [bodsch.php](https://github.com/bodsch/ansible-collection-php)

```bash
ansible-galaxy collection install bodsch.core
ansible-galaxy collection install bodsch.scm
ansible-galaxy collection install bodsch.php
```
or
```bash
ansible-galaxy collection install --requirements-file collections.yml
```

### Required PHP modules

| Category | Modules |
| :----- | :----- |
| Absolutely necessary | curl, mbstring, zip, intl, gd, xmlrpc |
| Database connection (select one) | pdo_mysql, mysql |
| For specific apps | ldap |

## tested operating systems

* Debian based
- Debian 10 / 11 / 12 / 13
- Ubuntu 20.04 / 22.04 / 24.04

## Contribution

Please read [Contribution](CONTRIBUTING.md)

## Development, Branches (Git Tags)

The `master` Branch is my *Working Horse* includes the "latest, hot shit" and can be complete broken!

If you want to use something stable, please use a [Tagged Version](https://github.com/bodsch/ansible-kimai/tags)!

---

## Configuration

```yaml
kimai_version: 2.29.0

kimai_direct_download: false

kimai_release: {}

kimai_install_base_directory: /var/www

kimai_database:
# username: kimai
# password:
# hostname:
# port: 3306
# schema: kimai
server:
version: ""

kimai_env: prod

kimai_mailer:
from: kimai@test.tld
url: null://null

kimai_admin_user:
username: admin
password: admin0815
email: admin@test.tld

kimai_secret: change_this_to_something_unique
```

----

## Author and License

- Bodo Schulz

## License

[Apache](LICENSE)

**FREE SOFTWARE, HELL YEAH!**