diff --git a/README.md b/README.md index 6fa4930..29145b0 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ [![Build Status](https://jenkins.pgollor.de/job/gitbucket-docker-master/badge/icon)](https://jenkins.pgollor.de/job/gitbucket-docker-master/) [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/pgollor) +[![Docker Pulls](https://img.shields.io/docker/pulls/pgollor/gitbucket.svg?maxAge=2592000)](https://hub.docker.com/r/pgollor/gitbucket/) [![Version 4.30.0](https://img.shields.io/badge/gitbucket_version-4.30.0-blue.svg)](https://github.com/gitbucket/gitbucket/releases/tag/4.30.0) This docker container of [gitbucket](https://github.com/gitbucket/gitbucket.git) is in beta state! @@ -9,33 +10,27 @@ ## Table of contents - - [Usage](#section-id-5) - - [Dependencies](#section-id-7) - - [Installation](#section-id-11) - - [Configuration](#section-id-38) - - [Update](#section-id-46) - - [Plugins](#section-id-71) - - [Backup](#section-id-76) - - [Troubleshooting](#section-id-82) - - [Error 503 on first start](#section-id-84) - - [Contact and Contribution](#section-id-95) - - [TODO](#section-id-100) - - [Inspirations](#section-id-105) - - [License](#section-id-110) + - [Usage](#usage) + - [Dependencies](#dependencies) + - [Installation](#installation) + - [Configuration](#configuration) + - [Update](#update) + - [Plugins](#plugins) + - [Backup](#backup) + - [Troubleshooting](#troubleshooting) + - [Error 503 on first start](#error-503-on-first-start) + - [Contact and Contribution](#contact-and-contribution) + - [TODO](#todo) + - [Inspirations](#inspirations) + - [License](#license) -
- ## Usage - - ### Dependencies - [docker](https://docs.docker.com/engine/installation/) - [docker-compose](https://docs.docker.com/compose/install/) - - ### Installation @@ -59,8 +54,6 @@ Default user and passwort are both root. - - ### Configuration Please use the configuration file `gitbucket.conf` for your personal changes. There are three configs for gitbucket: @@ -69,8 +62,6 @@ - `GITBUCKET_SSH_PORT`: ssh port to bind to - - ### Update Update your gitbucket image in three steps. But first of all: **MAKE A BACKUP!!!** @@ -112,28 +103,19 @@ ``` - - - ### Plugins To use plugins download the plugin and move it into `data/plugins`. After that restart the gitbucket container with `docker-compose restart main-gitbucket`. - - ### Backup For backuping the mysql database and the repositories you could use the `backup.sh` script and combine it with a daily cronjob. This script will create a compressed backup and keep the files 10 days in the backup directory. All files which are older then 10 days will be deleted. - - ## Troubleshooting - - ### Error 503 on first start Please check the gitbucket log files with ``` @@ -145,29 +127,21 @@ If doesn't please contact me via `issue@pgollor.de` because gitbucket does not allow issues for guests. - - ## Contact and Contribution You can write me an email ( `kalle@pgollor.de` ) or you could register here as an user to contribute to this project. After register please fork this repository and create pull reqeusts with your changes or add an issue. - - ## TODO - check gitbucket.war hash after download - maybe a nginx container with ssl??? - - ## Inspirations I got some inspirations for this project from: - https://github.com/mailcow/mailcow-dockerized - - ## License [![cc-bc-sa](https://i.creativecommons.org/l/by-sa/4.0/88x31.png)](http://creativecommons.org/licenses/by-sa/4.0/): Please see [license](LICENSE.md)