diff --git a/README.md b/README.md index 108041d..b4f6482 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,13 @@ This docker container of [gitbucket](https://github.com/gitbucket/gitbucket.git) is under testing!!! -## usage +## Usage -### dependencies +### Dependencies - [docker](https://docs.docker.com/engine/installation/) - [docker-compose](https://docs.docker.com/compose/install/) -### installation +### Installation 1. Get code from repository: ``` @@ -34,7 +34,7 @@ 5. Open `127.0.0.1:8080` and be habby. :-) -### configuration +### 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 @@ -42,11 +42,17 @@ - `GITBUCKET_SSH_PORT`: ssh port to bind to -### plugins +### 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. + + ## TODO - wait for the next update and write an update howto - maybe a nginx container with ssl???