{"id":18289873,"url":"https://github.com/tiredofit/docker-leantime","last_synced_at":"2025-04-05T09:31:49.662Z","repository":{"id":38332144,"uuid":"297133073","full_name":"tiredofit/docker-leantime","owner":"tiredofit","description":"Dockerized Project Managment tool with many configurable options","archived":false,"fork":false,"pushed_at":"2023-12-01T21:58:22.000Z","size":96,"stargazers_count":18,"open_issues_count":6,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-21T02:22:06.347Z","etag":null,"topics":["docker"],"latest_commit_sha":null,"homepage":"","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tiredofit.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null},"funding":{"github":["tiredofit"]}},"created_at":"2020-09-20T17:58:18.000Z","updated_at":"2025-01-11T06:00:27.000Z","dependencies_parsed_at":"2023-11-04T15:25:55.806Z","dependency_job_id":null,"html_url":"https://github.com/tiredofit/docker-leantime","commit_stats":null,"previous_names":[],"tags_count":65,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiredofit%2Fdocker-leantime","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiredofit%2Fdocker-leantime/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiredofit%2Fdocker-leantime/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiredofit%2Fdocker-leantime/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tiredofit","download_url":"https://codeload.github.com/tiredofit/docker-leantime/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247318315,"owners_count":20919457,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker"],"created_at":"2024-11-05T14:08:39.141Z","updated_at":"2025-04-05T09:31:48.738Z","avatar_url":"https://github.com/tiredofit.png","language":"Dockerfile","funding_links":["https://github.com/sponsors/tiredofit"],"categories":[],"sub_categories":[],"readme":"# github.com/tiredofit/docker-leantime\n\n[![Docker Pulls](https://img.shields.io/docker/pulls/tiredofit/leantime.svg)](https://hub.docker.com/r/tiredofit/leantime)\n[![Docker Stars](https://img.shields.io/docker/stars/tiredofit/leantime.svg)](https://hub.docker.com/r/tiredofit/leantime)\n\n## About\n\nThis will build a Docker image for [Leantime](https://leantime.io/) - An open source project management tool.\n\n* Automatically installs and sets up installation upon first start\n\n[Changelog](CHANGELOG.md)\n\n## Maintainer\n\n- [Dave Conroy](https://github.com/tiredofit)\n\n## Table of Contents\n\n\n- [About](#about)\n- [Maintainer](#maintainer)\n- [Table of Contents](#table-of-contents)\n- [Prerequisites and Assumptions](#prerequisites-and-assumptions)\n- [Installation](#installation)\n  - [Build from Source](#build-from-source)\n  - [Prebuilt Images](#prebuilt-images)\n    - [Multi Architecture](#multi-architecture)\n- [Configuration](#configuration)\n  - [Quick Start](#quick-start)\n  - [Persistent Storage](#persistent-storage)\n  - [Environment Variables](#environment-variables)\n    - [Base Images used](#base-images-used)\n    - [Application Settings](#application-settings)\n    - [Database Settings](#database-settings)\n    - [LDAP Settings](#ldap-settings)\n    - [Storage Settings](#storage-settings)\n      - [S3 Settings](#s3-settings)\n    - [SMTP Settings](#smtp-settings)\n  - [Networking](#networking)\n- [Maintenance](#maintenance)\n  - [Shell Access](#shell-access)\n- [Support](#support)\n  - [Usage](#usage)\n  - [Bugfixes](#bugfixes)\n  - [Feature Requests](#feature-requests)\n  - [Updates](#updates)\n- [License](#license)\n- [References](#references)\n\n## Prerequisites and Assumptions\n*  Assumes you are using some sort of SSL terminating reverse proxy such as:\n   *  [Traefik](https://github.com/tiredofit/docker-traefik)\n   *  [Nginx](https://github.com/jc21/nginx-proxy-manager)\n   *  [Caddy](https://github.com/caddyserver/caddy)\n\n## Installation\n\n### Build from Source\nClone this repository and build the image with `docker build \u003carguments\u003e (imagename) .`\n\n### Prebuilt Images\nBuilds of the image are available on [Docker Hub](https://hub.docker.com/r/tiredofit/leantime)\n\n```bash\ndocker pull docker.io/tiredofit/leantime:(imagetag)\n```\n\nBuilds of the image are also available on the [Github Container Registry](https://github.com/tiredofit/docker-leantime/pkgs/container/docker-leantime) \n \n```\ndocker pull ghcr.io/tiredofit/docker-leantime:(imagetag)\n``` \n\nThe following image tags are available along with their tagged release based on what's written in the [Changelog](CHANGELOG.md):\n\n| Leantime version | Tag       |\n| ---------------- | --------- |\n| `latest`         | `:latest` |\n\n#### Multi Architecture\nImages are built primarily for `amd64` architecture, and may also include builds for `arm/v7`, `arm64` and others. These variants are all unsupported. Consider [sponsoring](https://github.com/sponsors/tiredofit) my work so that I can work with various hardware. To see if this image supports multiple architecures, type `docker manifest (image):(tag)`\n\n\n## Configuration\n### Quick Start\n\n* The quickest way to get started is using [docker-compose](https://docs.docker.com/compose/). See the examples folder for a working [compose.yml](examples/compose.yml) that can be modified for development or production use.\n\n* Set various [environment variables](#environment-variables) to understand the capabilities of this image.\n* Map [persistent storage](#data-volumes) for access to configuration and data files for backup.\n\n**The first boot can take from 2 minutes - 5 minutes depending on your CPU to setup the proper schemas.**\n\nLogin to the web server and enter in your admin email address, admin password and start configuring the system!\n\n### Persistent Storage\n\nThe following directories are used for configuration and can be mapped for persistent storage.\n\n\n| Directory                | Description                                                                                                              |\n| ------------------------ | ------------------------------------------------------------------------------------------------------------------------ |\n| `/www/logs`              | Nginx and PHP Log files                                                                                                  |\n| `/assets/custom`         | (Optional) Copy source code over existing source code in /www/html upon container start. Use exact file/folder structure |\n| `/assets/custom-scripts` | (Optional) If you want to execute custom scripting, place scripts here with extension `.sh`                              |\n| `/assets/modules`        | (Optional) If you want to add additional modules outside of the source tree, add them here                               |\n| `/www/html`              | (Optional) If you want to expose the leantime sourcecode and enable Self Updating, expose this volume                    |\n| *OR                      |                                                                                                                          |\n| `/data`                  | Hold onto your persistent sessions and cache between container restarts                                                  |\n\n### Environment Variables\n\n#### Base Images used\n\nThis image relies on an [Alpine Linux](https://hub.docker.com/r/tiredofit/alpine) base image that relies on an [init system](https://github.com/just-containers/s6-overlay) for added capabilities. Outgoing SMTP capabilities are handlded via `msmtp`. Individual container performance monitoring is performed by [zabbix-agent](https://zabbix.org). Additional tools include: `bash`,`curl`,`less`,`logrotate`,`nano`.\n\nBe sure to view the following repositories to understand all the customizable options:\n\n| Image                                                         | Description                            |\n| ------------------------------------------------------------- | -------------------------------------- |\n| [OS Base](https://github.com/tiredofit/docker-alpine/)        | Customized Image based on Alpine Linux |\n| [Nginx](https://github.com/tiredofit/docker-nginx/)           | Nginx webserver                        |\n| [PHP-FPM](https://github.com/tiredofit/docker-nginx-php-fpm/) | PHP Interpreter                        |\n\n\n#### Application Settings\n\n| Parameter                  | Description                                                                                    | Default             |\n| -------------------------- | ---------------------------------------------------------------------------------------------- | ------------------- |\n| `ADMIN_EMAIL`              | Administrator Email Address - Needed for logging in                                            | `admin@example.com` |\n| `ADMIN_FIRST_NAME`         | Admin user First Name                                                                          | `Admin`             |\n| `ADMIN_LAST_NAME`          | Admin user First Name                                                                          | `User`              |\n| `ADMIN_PASS`               | Adminsitrator Password                                                                         | `admin`             |\n| `APP_DEBUG`                | Application Debug Mode                                                                         | `FALSE`             |\n| `COMPANY_NAME`             | Company Name                                                                                   | `Example Company`   |\n| `DEFAULT_COLOR`            | Default Color for header                                                                       | `1b75bb`            |\n| `ENABLE_AUTO_UPDATE`       | If coming from an earlier version of image, automatically update it to latest leantime release | `TRUE`              |\n| `LANGUAGE`                 | Application Language                                                                           | `en-US`             |\n| `PERSIST_THEME`            | Persist Theme and Fonts after setting                                                          | `TRUE`              |\n| `SESSION_EXPIRE`           | Session expiry in seconds                                                                      | `28800`             |\n| `SETUP_TYPE`               | Automatically generate configuration via environment variables `AUTO` `MANUAL`                 | `AUTO`              |\n| `SITE_NAME`                | Name of your Site                                                                              | `Leantime`          |\n| `SITE_URL`                 | The url your site listens on example `https://leantime.example.com`                            |                     |\n| `SPECIFY_MENU_PER_PROJECT` | Allow to specify menu upon new project creation                                                | `TRUE`              |\n| `THEME_COLOR_PRIMARY`      | Primary Theme Colour                                                                           | `#1b75bb`           |\n| `THEME_COLOR_SECONDARY`    | Secondary Theme Colour                                                                         | `#81b1a8`           |\n\nMake sure you also set your `TIMEZONE` variable as referenced in the base image.\n\n#### Database Settings\n| Parameter | Description                                                 | default |\n| --------- | ----------------------------------------------------------- | ------- |\n| `DB_HOST` | Host or container name of MariaDB Server e.g. `leantime-db` |         |\n| `DB_PORT` | MariaDB Port - Default `3306`                               | `3306`  |\n| `DB_NAME` | MariaDB Database name e.g. `leantime`                       |         |\n| `DB_USER` | MariaDB Username for above Database e.g. `leantime`         |         |\n| `DB_PASS` | MariaDB Password for above Database e.g. `password`         |         |\n\n#### LDAP Settings\n\nCan also be set within the application\n\n| Parameter                        | Description                                                                                                 | default                  |\n| -------------------------------- | ----------------------------------------------------------------------------------------------------------- | ------------------------ |\n| `ENABLE_LDAP`                    | Enable LDAP Functionality                                                                                   | `FALSE`                  |\n| `LDAP_ATTRIBUTE_FIRST_NAME`      | LDAP Attribute First Name                                                                                   | `givenName`              |\n| `LDAP_ATTRIBUTE_GROUPS`          | LDAP Attribute Groups                                                                                       | `memberOf`               |\n| `LDAP_ATTRIBUTE_LAST_NAME`       | LDAP Attribute Last Name                                                                                    | `sn`                     |\n| `LDAP_ATTRIBUTE_MAIL`            | LDAP Attribute Mail                                                                                         | `mail`                   |\n| `LDAP_ATTRIBUTE_PHONE`           | LDAP Attribute Phone                                                                                        | `phone`                  |\n| `LDAP_ATTRIBUTE_USER`            | LDAP Attribute User                                                                                         | `uid`                    |\n| `LDAP_BASE_DN`                   | BaseDN eg `dc=example,dc=com`                                                                               |                          |\n| `LDAP_BIND_DN`                   | Bind User                                                                                                   |                          |\n| `LDAP_BIND_PASS`                 | Bind Pass                                                                                                   |                          |\n| `LDAP_DEFAULT_ROLE`              |                                                                                                             |                          |\n| `LDAP_DEFAULT_USER_KEY`          | Default role to add new users `10` client `20` developer `30` Client Manager `40` Manager`50` Administrator | `20`                     |\n| `LDAP_DN`                        | Users Location eg `cn=users,dc=example,dc=com`                                                              |                          |\n| `LDAP_GROUP_ROLE_ADMIN`          | LDAP Group name to assign Admin (40) Role                                                                   | `leantime-admin`         |\n| `LDAP_GROUP_ROLE_CLIENT_MANAGER` | LDAP Group name to assign Client Manager (30) Role                                                          | `leantime-clientmanager` |\n| `LDAP_GROUP_ROLE_CLIENT`         | LDAP Group name to assign Client (10) Role                                                                  | `leantime-client`        |\n| `LDAP_GROUP_ROLE_DEVELOPER`      | LDAP Group name to assign Developer (20) Role                                                               | `leantime-developer`     |\n| `LDAP_GROUP_ROLE_MANAGER`        | LDAP Group name to assign Manager (40) Role                                                                 | `leantime-manager`       |\n| `LDAP_HOST`                      | LDAP Hostname                                                                                               |                          |\n| `LDAP_PORT`                      | LDAP Port                                                                                                   | `389`                    |\n| `LDAP_TYPE`                      | `OL` OpenLDAP or `AD` Active Directory                                                                      | `OL`                     |\n| `LDAP_USER_DOMAIN`               | Users domain eg '@example.com`                                                                              |                          |\n\n| Parameter           | Description                                                          | default         |\n| ------------------- | -------------------------------------------------------------------- | --------------- |\n| `STORAGE_TYPE`      | Use `FILESYSTEM` or `S3` for storing uploaded files                  | `FILESYSTEM`    |\n| `STORAGE_FILE_PATH` | Folder to store files (do not set if you are volume mapping `/data`) | `userfiles`     |\n| `BACKUP_FILE_PATH`  | Application backup storage location                                  | `/data/backup/` |\n\n#### Storage Settings\n\n| Parameter           | Description                                                          | default         |\n| ------------------- | -------------------------------------------------------------------- | --------------- |\n| `STORAGE_TYPE`      | Use `FILESYSTEM` or `S3` for storing uploaded files                  | `FILESYSTEM`    |\n| `STORAGE_FILE_PATH` | Folder to store files (do not set if you are volume mapping `/data`) | `userfiles`     |\n| `BACKUP_FILE_PATH`  | Application backup storage location                                  | `/data/backup/` |\n\n\n##### S3 Settings\n\nUsed only if `STORAGE_TYPE` = `S3`\n\n| Parameter               | Description                                                                                  | default |\n| ----------------------- | -------------------------------------------------------------------------------------------- | ------- |\n| `S3_BUCKET`             | S3 Bucket Name                                                                               |         |\n| `S3_FOLDER_NAME`        | S3 Folder Name (Can be blank)                                                                |         |\n| `S3_ENDPOINT`           | S3 Endpoint                                                                                  |         |\n| `S3_ENDPOINT_PATHSTYLE` | `FALSE` https://[`S3_BUCKET`].[`S3_ENDPOINT`] / `TRUE` https://[`S3_ENDPOINT`]/[`S3_BUCKET`] | `FALSE` |\n| `S3_KEY`                | S3 Key                                                                                       |         |\n| `S3_REGION`             | S3 Region                                                                                    |         |\n| `S3_SECRET`             | S3 Secret                                                                                    |         |\n\n#### SMTP Settings\n\nUsed only if `SMTP_ENABLE` = `TRUE`\n\n| Parameter            | Description                                                         | default |\n| -------------------- | ------------------------------------------------------------------- | ------- |\n| `SMTP_ENABLE`        | Use configured SMTP servers or rely on internal PHP mail() function | `FALSE` |\n| `SMTP_AUTH`          | Use SMTP Authentication `TRUE` or `FALSE`                           | `FALSE` |\n| `SMTP_FROM`          | SMTP From Name / Return Email Address                               |         |\n| `SMTP_HOST`          | SMTP Host                                                           |         |\n| `SMTP_PASS`          | SMTP Password                                                       |         |\n| `SMTP_PORT`          | SMTP Port                                                           |         |\n| `SMTP_PROTOCOL`      | SMTP Security Protocol `TLS`, `SSL`, `STARTTLS`                     |         |\n| `SMTP_TLS_AUTO`      | Automatically detect if we can use TLS                              | `TRUE`  |\n| `SMTP_TLS_NO_VERIFY` | Skip checking TLS certificate when connecting                       | `FALSE` |\n| `SMTP_USER`          | SMTP User                                                           |         |\n\n### Networking\n\nThe following ports are exposed.\n\n| Port | Description |\n| ---- | ----------- |\n| `80` | HTTP        |\n\n## Maintenance\n\n### Shell Access\n\nFor debugging and maintenance purposes you may want access the containers shell.\n\n```bash\ndocker exec -it (whatever your container name is) bash\n```\n## Support\n\nThese images were built to serve a specific need in a production environment and gradually have had more functionality added based on requests from the community.\n### Usage\n- The [Discussions board](../../discussions) is a great place for working with the community on tips and tricks of using this image.\n- [Sponsor me](https://tiredofit.ca/sponsor) for personalized support\n### Bugfixes\n- Please, submit a [Bug Report](issues/new) if something isn't working as expected. I'll do my best to issue a fix in short order.\n\n### Feature Requests\n- Feel free to submit a feature request, however there is no guarantee that it will be added, or at what timeline.\n- [Sponsor me](https://tiredofit.ca/sponsor) regarding development of features.\n\n### Updates\n- Best effort to track upstream changes, More priority if I am actively using the image in a production environment.\n- [Sponsor me](https://tiredofit.ca/sponsor) for up to date releases.\n\n## License\nMIT. See [LICENSE](LICENSE) for more details.\n\n## References\n\n* \u003chttps://leantime.io/\u003e\n* \u003chttps://github.com/Leantime/leantime\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftiredofit%2Fdocker-leantime","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftiredofit%2Fdocker-leantime","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftiredofit%2Fdocker-leantime/lists"}