add toc
1 parent b60325e commit 418aaf9fe85ef3e1004603b8602f5e02d435f962
@Pascal Gollor Pascal Gollor authored on 28 Sep 2017
Showing 1 changed file
View
47
README.md
#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)
 
 
<div id='section-id-1'/>
 
# docker container for gitbucket
 
This docker container of [gitbucket](https://github.com/gitbucket/gitbucket.git) is under testing!!!
 
<div id='section-id-5'/>
 
## Usage
 
<div id='section-id-7'/>
 
### Dependencies
- [docker](https://docs.docker.com/engine/installation/)
- [docker-compose](https://docs.docker.com/compose/install/)
 
<div id='section-id-11'/>
 
### Installation
 
1. Get code from repository:
5. Open `127.0.0.1:8080` and be habby. :-)
Default user and passwort are both root.
 
 
<div id='section-id-38'/>
 
### Configuration
Please use the configuration file `gitbucket.conf` for your personal changes.
There are three configs for gitbucket:
- `GITBUCKET_BIND`: ip address to bind to
- `GITBUCKET_WEB_PORT`: web port to bind to
- `GITBUCKET_SSH_PORT`: ssh port to bind to
 
 
<div id='section-id-46'/>
 
### Update
Update your gitbucket image in three steps.
But first of all: **MAKE A BACKUP!!!**
```
 
 
 
<div id='section-id-71'/>
 
### 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`.
 
 
<div id='section-id-76'/>
 
### 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.
 
 
<div id='section-id-82'/>
 
## Troubleshooting
 
<div id='section-id-84'/>
 
### Error 503 on first start
Please check the gitbucket log files with
```
After that it should be work.
If doesn't please contact me via `issue@pgollor.de` because gitbucket does not allow issues for guests.
 
 
<div id='section-id-95'/>
 
## 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.
 
 
<div id='section-id-100'/>
 
## TODO
- check gitbucket.war hash after download
- maybe a nginx container with ssl???
 
 
<div id='section-id-105'/>
 
## Inspirations
I got some inspirations for this project from:
- https://github.com/mailcow/mailcow-dockerized
 
 
<div id='section-id-110'/>
 
## 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)