Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/leantime/docker-leantime

Official Docker Image for Leantime https://leantime.io
https://github.com/leantime/docker-leantime

docker docker-leantime leantime mysql project-

Last synced: 1 day ago
JSON representation

Official Docker Image for Leantime https://leantime.io

Host: GitHub
URL: https://github.com/leantime/docker-leantime
Owner: Leantime
License: agpl-3.0
Created: 2019-11-19T02:52:18.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2024-12-05T13:13:03.000Z (21 days ago)
Last Synced: 2024-12-18T07:04:16.923Z (8 days ago)
Topics: docker, docker-leantime, leantime, mysql, project-
Language: Dockerfile
Homepage:
Size: 213 KB
Stars: 202
Watchers: 7
Forks: 88
Open Issues: 10
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

# Leantime™ Docker

[![License Badge](https://img.shields.io/github/license/leantime/leantime?style=flat-square)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
[![Version](https://img.shields.io/github/package-json/v/leantime/leantime/master?style=flat-square)](https://github.com/Leantime/leantime/releases)
[![Docker Hub Badge](https://img.shields.io/docker/pulls/leantime/leantime?style=flat-square)](https://hub.docker.com/r/leantime/leantime)
[![Discord Badge](https://img.shields.io/discord/990001288026677318?label=Discord&style=flat-square)](https://discord.gg/4zMzJtAq9z)

Leantime is an open source project management system for small teams and startups written in PHP, Javascript using MySQL. [https://leantime.io](https://leantime.io)

This is the official Docker image for Leantime. It was built using the latest Leantime release.

## How to use this image
Below you will find examples on how to get started with Leantime trough `docker run` or `docker compose`.

### Full Set up with docker-compose

One command install with docker compose.

```
git clone https://github.com/Leantime/docker-leantime.git
cd docker-leantime
cp sample.env .env
docker compose up -d
```

Dont forget to update the `.env` file for production.

### Full set up with docker run

#### 1. Create the network so Leantime can communicate with the MySql container.

```
docker network create leantime-net
```

#### 2. Create the MySQL container.
If you don't have a MySQL database set up and would like to create a container follow these instruction, otherwise jump to step 3.

```
docker run -d --restart unless-stopped -p 3306:3306 --network leantime-net \
-e MYSQL_ROOT_PASSWORD=321.qwerty \
-e MYSQL_DATABASE=leantime \
-e MYSQL_USER=admin \
-e MYSQL_PASSWORD=321.qwerty \
--name mysql_leantime mysql:8.4 --character-set-server=UTF8MB4 --collation-server=UTF8MB4_unicode_ci
```

#### 3. Create the Leantime container.

```
docker run -d --restart unless-stopped -p 80:80 --network leantime-net \
-e LEAN_DB_HOST=mysql_leantime \
-e LEAN_DB_USER=admin \
-e LEAN_DB_PASSWORD=321.qwerty \
-e LEAN_DB_DATABASE=leantime \
--name leantime leantime/leantime:latest
```

4. Run the installation script at `/install`

## Full Set up with docker-compose

One command install with docker-compose.

```sh
git clone https://github.com/Leantime/docker-leantime.git
cd docker-leantime
cp sample.env .env
nano .env # Change the secrets for security
docker-compose up -d
```

## Docker secrets

As an alternative to passing sensitive information via environment variables, `_FILE` may be appended to the environment variables listed below, causing the initialization script to load the values for those variables from files present in the container. In particular, this can be used to load passwords from Docker secrets stored in `/run/secrets/` files. For example:

```
docker run -d --restart unless-stopped -p 80:80 --network leantime-net \
-e LEAN_DB_HOST=mysql_leantime \
-e LEAN_DB_USER=admin \
-e LEAN_DB_PASSWORD_FILE=/run/secrets/lean-db-password \
-e LEAN_DB_DATABASE=leantime \
--name leantime leantime/leantime:latest
```

Currently, this is only supported for `LEAN_DB_PASSWORD`, `LEAN_EMAIL_SMTP_PASSWORD`, `LEAN_S3_SECRET`, and `LEAN_SESSION_PASSWORD`.

## Plugins

If you are planning on using and installing plugins from the marketplace please ensure to mount the Plugin folder as suggested in the docker-compose file. Otherwise plugin installation may fail or plugins will disapper after a restart of the container.

### Support ###
* Documentation [https://docs.leantime.io](https://docs.leantime.io)
* Community Forum [https://community.leantime.io](https://community.leantime.io)
* Discussions on [Discord](https://discord.gg/4zMzJtAq9z)
* File a bug report [https://github.com/Leantime/leantime/issues/new](https://github.com/Leantime/leantime/issues/new)