Provide a script to migrate configuration data to the new layout.

With the image for version 1.9.0 the directory layout changed, as well
as how some properties are set for defaults and the docker image setup.

If a previous container was run with a volume attached, then the old
layout and data should be migrated to the new layout and container
configuration.

This can be done with the provided `migrate-data` script.

Author: flaix

Dockerfile

@@ -1,16 +1,11 @@
 FROM openjdk:8-jre-slim
 
-ENV GITBLIT_VERSION 1.9.0
-ENV GITBLIT_DOWNLOAD_SHA 349302ded75edfed98f498576861210c0fe205a8721a254be65cdc3d8cdd76f1
-
 # add our user and group first to make sure their IDs get assigned consistently, regardless of whatever packages get added
 RUN groupadd -r -g 8117 gitblit && useradd -r -M -g gitblit -u 8117 -d /opt/gitblit gitblit
 
 
-LABEL maintainer="James Moger <james.moger@gitblit.com>, Florian Zschocke <f.zschocke+gitblit@gmail.com>" \
-      org.label-schema.schema-version="1.0" \
-      org.label-schema.version="${GITBLIT_VERSION}"
-
+ENV GITBLIT_VERSION 1.9.0
+ENV GITBLIT_DOWNLOAD_SHA 349302ded75edfed98f498576861210c0fe205a8721a254be65cdc3d8cdd76f1
 
 ENV GITBLIT_DOWNLOAD_URL https://github.com/gitblit/gitblit/releases/download/v${GITBLIT_VERSION}/gitblit-${GITBLIT_VERSION}.tar.gz
 
@@ -38,6 +33,14 @@ RUN set -eux ; \
 
 
 
+LABEL maintainer="James Moger <james.moger@gitblit.com>, Florian Zschocke <f.zschocke+gitblit@gmail.com>" \
+      org.label-schema.schema-version="1.0" \
+      org.label-schema.name="gitblit" \
+      org.label-schema.description="Gitblit is an open-source, pure Java stack for managing, viewing, and serving Git repositories." \
+      org.label-schema.url="http://gitblit.com" \
+      org.label-schema.version="${GITBLIT_VERSION}"
+
+
 ENV GITBLIT_VAR /var/opt/gitblit
 
 # Move the data files to a separate directory and set some defaults
@@ -108,6 +111,8 @@ s/^server.redirectToHttpsPort.*/#server.redirectToHttpsPort = true/\n\
 ''# Do not define your custom settings in this file. Your overrides or\n\
 ''# custom settings should be defined in the "gitblit.properties" file.\n\
 ''#\n\
+''# Do NOT change this include line. It makes sure that settings for this docker image are set.\n\
+''#\n\
 include = /opt/gitblit/etc/defaults.properties,/opt/gitblit/etc/system.properties\n\
 \n' > $gbetc/gitblit-docker.properties ; \
     \
@@ -160,6 +165,10 @@ include = gitblit-docker.properties\n\
 
 
 
+# Provide script and data to migrate from earlier images to the new layout.
+COPY migrate/migrate-data /usr/local/bin/
+COPY migrate/non-etc-files migrate/defaults.* /usr/local/share/gitblit/
+
 
 # Setup the Docker container environment
 ARG GITBLIT_RPC

Dockerfile.alpine

@@ -1,16 +1,11 @@
 FROM openjdk:8-jre-alpine
 
-ENV GITBLIT_VERSION 1.9.0
-ENV GITBLIT_DOWNLOAD_SHA 349302ded75edfed98f498576861210c0fe205a8721a254be65cdc3d8cdd76f1
-
 # add our user and group first to make sure their IDs get assigned consistently, regardless of whatever packages get added
 RUN addgroup -S -g 8117 gitblit && adduser -S -H -G gitblit -u 8117 -h /opt/gitblit gitblit
 
 
-LABEL maintainer="James Moger <james.moger@gitblit.com>, Florian Zschocke <f.zschocke+gitblit@gmail.com>" \
-      org.label-schema.schema-version="1.0" \
-      org.label-schema.version="${GITBLIT_VERSION}"
-
+ENV GITBLIT_VERSION 1.9.0
+ENV GITBLIT_DOWNLOAD_SHA 349302ded75edfed98f498576861210c0fe205a8721a254be65cdc3d8cdd76f1
 
 ENV GITBLIT_DOWNLOAD_URL https://github.com/gitblit/gitblit/releases/download/v${GITBLIT_VERSION}/gitblit-${GITBLIT_VERSION}.tar.gz
 
@@ -38,6 +33,14 @@ RUN set -eux; \
 
 
 
+LABEL maintainer="James Moger <james.moger@gitblit.com>, Florian Zschocke <f.zschocke+gitblit@gmail.com>" \
+      org.label-schema.schema-version="1.0" \
+      org.label-schema.name="gitblit" \
+      org.label-schema.description="Gitblit is an open-source, pure Java stack for managing, viewing, and serving Git repositories." \
+      org.label-schema.url="http://gitblit.com" \
+      org.label-schema.version="${GITBLIT_VERSION}"
+
+
 ENV GITBLIT_VAR /var/opt/gitblit
 
 # Move the data files to a separate directory and set some defaults
@@ -108,6 +111,8 @@ s/^server.redirectToHttpsPort.*/#server.redirectToHttpsPort = true/\n\
 ''# Do not define your custom settings in this file. Your overrides or\n\
 ''# custom settings should be defined in the "gitblit.properties" file.\n\
 ''#\n\
+''# Do NOT change this include line. It makes sure that settings for this docker image are set.\n\
+''#\n\
 include = /opt/gitblit/etc/defaults.properties,/opt/gitblit/etc/system.properties\n\
 \n' > $gbetc/gitblit-docker.properties ; \
     \
@@ -160,6 +165,10 @@ include = gitblit-docker.properties\n\
 
 
 
+# Provide script and data to migrate from earlier images to the new layout.
+COPY migrate/migrate-data /usr/local/bin/
+COPY migrate/non-etc-files migrate/defaults.* /usr/local/share/gitblit/
+
 
 # Setup the Docker container environment
 ARG GITBLIT_RPC

README.md

@@ -67,3 +67,41 @@ sudo docker build -t my-gitblit .
 sudo docker run -d --name gitblit -p 8443:8443 -p 8080:8080 -p 9418:9418 -p 29418:29418 my-gitblit
 ```
 
+
+## Migrating from an older image
+
+The directory layout for the Gitblit data was changed with the image for version 1.9.0. If you had previously used a Docker image of Gitblit with a volume mounted on `/opt/gitblit-data`, migration of the configuration data is advised. A script `migrate-data` is available in the new image for this. Run the script from a container with your volume mounted under `/var/opt/gitblit`.
+
+```console
+$ ls -l
+total 0
+drwxr-xr-x  6 beowulf  staff       192 Mar 10 21:02 gitblit-data/
+
+$ sudo docker run -it --rm -v $PWD/gitblit-data:/var/opt/gitblit my-gitblit migrate-data
+
+Creating new directories 'etc' and 'srv' ...
+Moving existing files to new directories ...
+   Moving to folder 'etc': certs
+   Moving to folder 'etc': defaults.properties
+   Moving to folder 'srv': git
+   Moving to folder 'etc': gitblit.properties
+   Moving to folder 'etc': gitignore
+   Moving to folder 'etc': groovy
+   Moving to folder 'srv': lfs
+   Moving to folder 'etc': plugins
+   Moving to folder 'etc': projects.conf
+   Moving to folder 'etc': serverKeyStore.jks
+   Moving to folder 'etc': serverTrustStore.jks
+   Moving to folder 'etc': ssh-dsa-hostkey.pem
+   Moving to folder 'etc': ssh-rsa-hostkey.pem
+   Moving to folder 'etc': users.conf
+Adjusting 'include' setting in etc/gitblit.properties
+Checking the defaults.properties file for changes.
+   There were changes detected in the defaults.properties file.
+   These have been copied over into the gitblit.properties file.
+   Please review these and adjust as required.
+   The defaults.properties file should not be changed as it gets overwritten upon upgrade.
+Done.
+
+$ sudo docker run -d --name gitblit -v $PWD/gitblit-data:/var/opt/gitblit -p 8080:8080 my-gitblit
+```

hub-readme.md

@@ -233,6 +233,61 @@ uid=8117(gitblit) gid=8117(gitblit) groups=8117(gitblit)
 ```
 
 
+# Caveats
+
+## Migrating from an older image version
+
+The directory layout for the Gitblit data was changed in the official `gitblit/gitblit` image for version 1.9.0. If you had previously used a Docker image of Gitblit with a volume mounted on `/opt/gitblit-data`, migration of the configuration data is advised. This will make updates easier in the future. A script `migrate-data` is available in the current image for this. Run the script from a container with your volume mounted under `/var/opt/gitblit`.
+
+Below is an example for a container that had the local directory `gitblit-data` as a bind mount.
+
+
+```console
+$ sudo docker pull gitblit/gitblit
+
+$ sudo docker stop gitblit
+
+$ ls -l
+total 0
+drwxr-xr-x  6 beowulf  staff       192 Mar 10 21:02 gitblit-data/
+
+$ sudo docker run -it --rm -v $PWD/gitblit-data:/var/opt/gitblit gitblit/gitblit migrate-data
+
+Creating new directories 'etc' and 'srv' ...
+Moving existing files to new directories ...
+   Moving to folder 'etc': certs
+   Moving to folder 'etc': defaults.properties
+   Moving to folder 'srv': git
+   Moving to folder 'etc': gitblit.properties
+   Moving to folder 'etc': gitignore
+   Moving to folder 'etc': groovy
+   Moving to folder 'srv': lfs
+   Moving to folder 'etc': plugins
+   Moving to folder 'etc': projects.conf
+   Moving to folder 'etc': serverKeyStore.jks
+   Moving to folder 'etc': serverTrustStore.jks
+   Moving to folder 'etc': ssh-dsa-hostkey.pem
+   Moving to folder 'etc': ssh-rsa-hostkey.pem
+   Moving to folder 'etc': users.conf
+Adjusting 'include' setting in etc/gitblit.properties
+Checking the defaults.properties file for changes.
+   There were changes detected in the defaults.properties file.
+   These have been copied over into the gitblit.properties file.
+   Please review these and adjust as required.
+   The defaults.properties file should not be changed as it gets overwritten upon upgrade.
+Done.
+
+$ sudo docker run -d --name gitblit -v $PWD/gitblit-data:/var/opt/gitblit -p 8080:8080 giblit/gitblit
+```
+
+Cou could, alternatively, also run a container with the existing data directory without migration. Be advised, that in this case you will need to make sure that you have paths for temp and git folders in your `gitblit.properties` file. Also, **do not** have any custom settings in the `defaults.properties` file as this file will get **overwritten**.  
+Mount your not migrated volume under `/var/opt/gitblit/etc` which is the default for the `baseFolder`, or provide the path to where you mount the volume to the container in the `--baseFolder` parameter when running the container.
+
+```console
+$ sudo docker run -v /some/path/data:/opt/gitblit-data gitblit/gitblit --baseFolder /opt/gitblit-data
+```
+
+
 
 # Image Variants
 The `gitblit/gitblit` images come in multiple flavors.