diff --git a/README.md b/README.md index d3b39b6..2c3d82c 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,40 @@ +#Summary + +- [docker container for gitbucket](#section-id-1) + - [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) + + + +
+ # docker container for gitbucket This docker container of [gitbucket](https://github.com/gitbucket/gitbucket.git) is under testing!!! + + ## Usage + + ### Dependencies - [docker](https://docs.docker.com/engine/installation/) - [docker-compose](https://docs.docker.com/compose/install/) + + ### Installation 1. Get code from repository: @@ -35,6 +62,8 @@ 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: @@ -43,6 +72,8 @@ - `GITBUCKET_SSH_PORT`: ssh port to bind to + + ### Update Update your gitbucket image in three steps. But first of all: **MAKE A BACKUP!!!** @@ -68,19 +99,27 @@ + + ### 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 ``` @@ -92,21 +131,29 @@ 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)