README.md 2.65 KB
Newer Older
V committed
1 2 3 4
# GitLab issues made awesome

[![Join the chat at https://gitter.im/leanlabsio/kanban](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/leanlabsio/kanban?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Analytics](https://ga-beacon.appspot.com/UA-66361671-1/leanlabs/kanban)](https://github.com/igrigorik/ga-beacon)
V committed
5
[![](https://badge.imagelayers.io/leanlabs/kanban:1.4.0.svg)](https://imagelayers.io/?images=leanlabs/kanban:1.4.0 'Get your own badge on imagelayers.io')
V committed
6 7 8 9
#### Instant project management for your GitLab repositories

## Installation

Walter committed
10 11
Minimum Install Requrements:  
OS: kernel minimum 3.10 (centOS 7, Ubuntu 14.04)  
12
Packages: git, curl  
Walter committed
13 14

>`sudo yum -y install git, curl`  
15 16 17

The easiest way to deploy Leanlabs Kanban board is to use docker-compose. Install instructions here.
Assuming you have installed [Docker](http://docs.docker.com/engine/installation/) and [docker-compose](http://docs.docker.com/compose/install/).
V committed
18

19
### 1. Installation with Docker
V committed
20

Walter committed
21
>` git clone https://gitlab.com/leanlabsio/kanban.git`
V committed
22
>
Walter committed
23 24
>` cd kanban`

V committed
25

26
#### 1.1 Register GitLab Application for OAuth to work
V committed
27

V committed
28
Go to https://gitlab.com/profile/applications or your GitLab installation and register your application to get the application client ID and client secret key required for OAuth.
V committed
29 30 31

**Where**

Walter committed
32
> `Redirect url http[s]://{KANBAN_SERVER_HOSTNAME}/assets/html/user/views/oauth.html`
V committed
33

34
#### 1.2 Change default environment variables defined in docker-compose.yml 
V committed
35

36
**Where**
V committed
37

Walter committed
38
> `KANBAN_SERVER_HOSTNAME` | http[s]://{KANBAN_SERVER_HOSTNAME} - URL on which LeanLabs Kanban will be reachable [same as redirect url with out /assets/html...], required
39
>
Walter committed
40
> `KANBAN_SECURITY_SECRET` | Change this string to antyhing you like. This string is used to generate user auth tokens
41
>
Walter committed
42
> `KANBAN_GITLAB_URL` | http[s]://{gitlab.example.com:port} - Your GitLab host URL, required
43
>
Walter committed
44
> `KANBAN_GITLAB_CLIENT` | Your GitLab OAuth client application ID, required for OAuth to work. Git this from your gitlab server.
45
>
Walter committed
46
> `KANBAN_GITLAB_SECRET` | Your GitLab OAuth client secret key, required for OAuth to work. Git this from your gitlab server.
47 48
>
> `KANBAN_ENABLE_SIGNUP` | Wheter to enable sign up with user API token.
V committed
49

50
**Then**
V committed
51

Walter committed
52
> `docker-compose up -d`
V committed
53 54


V committed
55 56 57 58
## Upgrading

If you followed instructions from "Installation with Docker", then the easiest way to upgrade would be:

Walter committed
59
> `git pull`
V committed
60
>
Walter committed
61
> `docker-compose up -d`
V committed
62

Xavi committed
63 64 65
## Changelog

You can view the changelog [here](https://gitlab.com/leanlabsio/kanban/blob/master/CHANGELOG.md)
V committed
66 67 68

# FAQ

69
1. [How to install Kanban.Leanlabs](http://kanban.leanlabs.io/docs/installation/)
Xavi committed
70
2. [How to customize column](http://kanban.leanlabs.io/docs/usage/customize-columns)