Installation

General Steps

These are the steps required to install Leantime. They work for most configurations.

Download latest release package
Create an empty MySQL database
Upload entire directory to your server
Point your domain to the public/ directory
Rename config/configuration.sample.php to config/configuration.php
Fill in your database credentials (username, password, host, dbname) in config/configuration.php
Navigate to <yourdomain.com>/install
Follow instructions to install database and set up first user account

Installation - Development

For development environments and to make changes to Leantime follow the steps below:

Install composer and npm
Clone repository to your local server
Create MySQL database
Run composer to load php dependencies

composer install

then

npm install

to load Javascript dependencies and finally run the grunt task to create the compiled js files

grunt Build-All

Point your local domain to the public/ directory
Rename config/configuration.sample.php to config/configuration.php
Fill in your database credentials (username, password, host, dbname) in config/configuration.php
Navigate to /install
Follow instructions to install database and user account

Installation using Docker

Docker Run

To run the docker image from DockerHub you will need an existing MySQL database.

docker run -d -p 80:80 --network leantime-net \
-e DB_HOST=mysql_leantime \
-e MYSQL_USER=admin \
-e MYSQL_PASSWORD=321.qwerty \
-e MYSQL_DATABASE=leantime \
--name leantime leantime/leantime:latest

Once started you can go to <yourdomain.com>/install and run the installation script.

Full set up with MySQL and network

If you don't have a MySQL database set up and would like to create a container follow these instruction.

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

docker network create leantime-net

Create the MySQL container.

docker run -d -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:5.7 --character-set-server=utf8 --collation-server=utf8_unicode_ci

Create the Leantime container.

docker run -d -p 80:80 --network leantime-net \
-e DB_HOST=mysql_leantime \
-e MYSQL_USER=admin \
-e MYSQL_PASSWORD=321.qwerty \
-e MYSQL_DATABASE=leantime \
--name leantime leantime/leantime:latest

Run the installation script at <yourdomain.com>/install

Docker Compose

One command install with docker-compose.

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

Subfolder installation

We recommend running Leantime as the main application under a domain or subdomain (eg leantime.yourcompany.com), however it is possible to run Leantime within a subfolder (eg. yourcompany.com/leantime). To enable subfolder installations follow the steps below:

Uncomment line 4 in public/.htaccess and change the path to your subfolder
Set public $appURL in config\configuration.php to the URL you are planning to use including the subfolder (eg yourcompany.com/leantime)

Keep in mind that this exposes your \userdata\ folder to the public. You should restrict access to that folder using .htaccess rules and make sure directory listings are off.

Common Problems

I see a 404 error when going to domain/install

There are two possible options why this would happen

The mod_rewrite module is not installed or not configued properly.
Your vhost configuration does not point to the public/ folder

I can't upload files

This usually happens when PHP can't write to the local folder. Make sure userdata/ and public/userdata/ are writeable by the server user

3.8 KiB Raw Permalink Blame History