Skip to content
lampii edited this page May 29, 2022 · 2 revisions

Installation

The requirements to Laravel GitScrum application is:

  • PHP - Supported Versions: >= 7.1
  • Webserver: Nginx or Apache
  • Database: MySQL, or Maria DB

Use Docker - Containers: php7, nginx and mysql57

Composer Package

$ composer create-project gitscrum-community/laravel-gitscrum --stability=stable --keep-vcs
$ cd laravel-gitscrum

Important: If you have not yet installed composer: Installation - Linux / Unix / OSX

Git Clone

$ git clone git@github.com:GitScrum-Community/laravel-gitscrum.git
$ cd laravel-gitscrum
$ composer update
$ composer run-script post-root-package-install

Setup

Important: If you have not the .env file in root folder, you must copy or rename the .env.example to .env

Application URL

.env file

APP_URL=http://yourdomain.tld (you must use protocol http or https)

Language

Options: en | zh | zh_cn | ru | de | es | pt | it | id | fr | hu

.env file

APP_LANG=en

Can you help us translate a few phrases into different languages? See: https://github.com/GitScrum-Community/laravel-gitscrum/tree/feature/language-pack/resources/lang

Database

.env file


DB_CONNECTION=mysql
DB_HOST=XXXXXX
DB_PORT=3306
DB_DATABASE=XXXXX
DB_USERNAME=XXXX
DB_PASSWORD=XXXXX

Remember: Create the database for GitScrum before run artisan command.

php artisan migrate
php artisan db:seed --class=SettingSeeder

Github

You must create a new Github App, visit GitHub's New OAuth Application page, fill out the form, and grab your Client ID and Secret.

Application name: gitscrum
Homepage URL: URL (Same as APP_URL at .env)
Application description: gitscrum
Authorization callback URL: http://{URL is the SAME APP_URL}/auth/provider/github/callback

.env file

GITHUB_CLIENT_ID=XXXXX
GITHUB_CLIENT_SECRET=XXXXXXXXXXXXXXXXXX

Gitlab

You must create a new Gitlab App, visit Gitlab new application, fill out the form, and grab your Application ID and Secret.

name: gitscrum
Redirect URI: http://{URL is the SAME APP_URL}/auth/provider/gitlab/callback
Scopes: api and read_user

.env file

GITLAB_KEY=XXXXX -> Application Id
GITLAB_SECRET=XXXXXXXXXXXXXXXXXX
GITLAB_INSTANCE_URI=https://gitlab.com/

Bitbucket

You must create a new Bitbucket OAuth Consumer, visit Bitbucket new consumer guide, and make sure you give write permissions when creating the consumer specially on (repositories , issues)

name: gitscrum
Callback URL: http://{URL is the SAME APP_URL}/auth/provider/bitbucket/callback
URL: http://{URL is the SAME APP_URL}
Uncheck (This is a private consumer)

.env file

BITBUCKET_CLIENT_ID=XXXXX -> Bitbucket Key
BITBUCKET_CLIENT_SECRET=XXXXXXXXXXXXXXXXXX Bitbucket Secret
BITBUCKET_INSTANCE_URI=https://api.bitbucket.org

Proxy

.env file

PROXY_PORT=
PROXY_METHOD=
PROXY_SERVER=
PROXY_USER=
PROXY_PASS=