Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/yoshinorin/docker-gitbucket-orchestration

:whale: Docker compose for GitBucket. (Nginx + MySQL)
https://github.com/yoshinorin/docker-gitbucket-orchestration

docker docker-compose gitbucket mysql nginx

Last synced: about 1 month ago
JSON representation

:whale: Docker compose for GitBucket. (Nginx + MySQL)

Host: GitHub
URL: https://github.com/yoshinorin/docker-gitbucket-orchestration
Owner: yoshinorin
Created: 2017-02-03T08:22:48.000Z (almost 8 years ago)
Default Branch: master
Last Pushed: 2022-03-06T14:49:32.000Z (over 2 years ago)
Last Synced: 2023-02-28T13:31:03.957Z (over 1 year ago)
Topics: docker, docker-compose, gitbucket, mysql, nginx
Language: Shell
Homepage:
Size: 160 KB
Stars: 13
Watchers: 4
Forks: 2
Open Issues: 1
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# docker-gitbucket-orchestration

![](https://img.shields.io/badge/GitBucket-v4.37.2-blue.svg)

Docker compose for [GitBucket](//github.com/gitbucket/gitbucket).

[日本語の記事はこちら](//yoshinorin.net/2017/02/26/gitbucket-based-on-nginx-mysql-using-by-docker-compose/)

# Architecture

* MySQL
* nginx (Also you can ignore it)

# Requirements

* Higher than Docker compose 3

# Overview

![](./doc/img/overview.png)

# Install and execute

## Install

* At first. Download `gitbucket.war` using by `gitbucket/gitbucket/war_download.sh`.

## Docker compose up

Please execute below command on `gitbucket` directory.

```sh
docker-compose up -d
```

# Settings

## MySQL

### Character set

Default character set is utf8mb4.

### User and password

**User and paswword are decided when build docker image.** You can specify user and password using by `docker-compose.yml`.

```yml
gb-mysql:
build: ./mysql
container_name: gb-mysql
environment:
MYSQL_ROOT_PASSWORD: mypass
MYSQL_DATABASE: gitbucket
MYSQL_USER: gitbucket
MYSQL_PASSWORD: gitbucket
```

You can remove `MYSQL_ROOT_PASSWORD` key in `docker-compose.yml`, after first docker image build.

If you change `MYSQL_USER` and `MYSQL_DATABASE`. Please change below settings in `docker-compose.yml`.

```yml
gitbucket:
build: ./gitbucket
container_name: gitbucket
environment:
MYSQL_USER: gitbucket
MYSQL_PASSWORD: gitbucket
MYSQL_URL: jdbc:mysql://gb-mysql:3306/gitbucket?useUnicode=true&characterEncoding=utf8
```

### Directory connecting

The default setting you can't connect MySQL directly.
If you want to connect directly, please add below key in `docker-compose.yml`.

```yml
gb-mysql:
ports:
- "3306:3306"
```

You can connect MySQL directory using by `3306` port. Also you can change port number.

### Other config

Please change `/gitbucket/mysql/config/etc/conf.d/mysql_custom.cnf`

## nginx

Please change `gitbucket/nginx/config/nginx.conf`.
Also you can change it after build image.

### Ignore nginx

If you want ingnore nginx (for example you have already use other webserver.) please commented out nginx key in docker-compose.yml. And add below key in gitbucket key.

```
ports:
- "8080:8080"
- "29418:29418"
```

### HTTPS

You have to change `gitbucket/nginx/config/nginx.conf` and `docker-compose.yml`.

At first please configure `gitbucket/nginx/config/nginx.conf`.
And change server settings. Below is example.

```yml
server {
#NOTE : for TLS connection.
ssl on;
ssl_prefer_server_ciphers on;
ssl_protocols TLSv1.2;
ssl_certificate
ssl_certificate_key
```

Next please change `docker-compose.yml`. You have to put key on **host** machine. And mount these keys on nginx container. So you have to specify host key's path and mount volume path in `docker-compose.yml`.

```yml
#NOTE : TLS key's path for HTTPS
- :
- :
```

### Upload size

Please change　`client_max_body_size` according to your repository size in `gitbucket/nginx/config/nginx.conf`.

```yml
http {
server_tokens off;
include mime.types;
default_type application/octet-stream;
#Please change below settings according to your repository size.
#client_max_body_size xxM;
```

# Container's time zone

If you want to change container's time zone. Please add `TZ` key to each container using by `docker-compose.yml`.

# Others

You can customize other settings using by `docker-compose.yml`

# Back up

Please execute backup.sh. Back up files are create in buckups directory by tar format.

Below is example.

# Version Up

## GitBucket

Please take buckup befor version up.
After buckup please deploy new version of `gitbucket.war` to `gitbucket/gitbucket/war`.

Execute `docker-compose build` after deploy new version of `gitbucket.war` to `gitbucket/gitbucket/war`.

## Database

#### NOTICEI : I confirm work it only `MySQL 5.7.17 to 8.0.1` on GitBucket version is `4.13.0`

1. **Please take backup.**
2. Please export gitbucket's data using by `System administration -> Data export/import`.

![](./doc/img/export.png)

3. Remove `gitbucket/storage/mysql/data/*` and bump to MySQL version and execute `docker-compose build`.
4. Execute `docker-compose up` command.
5. Copy `gitbucket-export-xxxxxxxx.sql` host os to mysql conrainer. Command is `docker cp gitbucket-export-xxxxxxxx.sql :
`
6. Import `gitbucket-export-xxxxxxxx.sql` in mysql container. Command is `$ mysql -u root -p gitbucket < gitbucket-export-xxxxxxxx.sql`

Please see [Data migration](//github.com/gitbucket/gitbucket/wiki/External-database-configuration).

# Directory Hierarchy