Skip to content
This repository has been archived by the owner on Sep 30, 2019. It is now read-only.

Latest commit

 

History

History
119 lines (90 loc) · 3.18 KB

development.md

File metadata and controls

119 lines (90 loc) · 3.18 KB
Raw

Development

The documentation is written for OS X, but it should be easy to adapt the instructions for Linux.

Requirements

brew install awscli

Running

Since it's all Docker, just run the following in the project root:

docker-compose up

Alternatively, you can run the following script which will take care of stopping any previous running containers:

./compose-all

The bootup process can take a while. During the process there may be some error messages that are caused by some services trying to access other services that have not started yet.

After the bootup process completes, the following services are available:

  • GitLab: http://localhost:10080, password 12345678 for user root.
  • Charles: http://localhost:8000
  • Git server: http://localhost:10022
  • Postgres: port 15432, password password for user gitlab. Main databases are called charles and gitlabhq_production.
  • Redis: port 16379

First run

When first run, Docker will build an image for charles and pull the rest of the images from Docker Hub. Beware that this operation requires some bandwidth and patience, since building the image runs npm install, and the Gitlab Docker image is quite large.

After the first run, you should manually create at least two teams using the GitLab UI. The first team you create will get id 2, and should be reserved for integration tests.

Mounted directories

By default (as specified in docker-compose.override.yml) the containers mount data directories under gitlab-data. For example, the (bare) repository data ends up residing in gitlab-data/gitlab/repositories.

After running for the first time, gitlab-data will end up looking like this:

gitlab-data
├── README.md
├── gitlab
│   ├── README.md
│   ├── backups
│   ├── builds
│   ├── config
│   ├── repositories
│   ├── shared
│   ├── ssh
│   ├── tmp
│   └── uploads
├── postgresql
│   ├── README.md
│   └── pgdata
├── redis
│   ├── README.md
│   └── dump.rdb
└── runner
    ├── README.md
    ├── config.toml
    └── config.toml.example

To start from scratch, you can do

rm -rf gitlab-data
git checkout master -- gitlab-data

Running with UI

To use Minard with a UI, check out the minard-ui project.

Rebuilding the image

If you update charles by e.g. installing new NPM packages, you will need to rebuild its Docker image. This is done with:

docker-compose build charles

Hot reloading

During development it is useful to continously transpile code and automatically restart charles to reflect code changes.

Get this by running:

npm run watch

Debugging

In development the Node process running charles is started with the remote Node debugger listening on port 5858. A launch configuration for debugging in Visual Studio Code is included under .vscode.