From 6364a3974e11591cef1efc3afe2c497041a1973a Mon Sep 17 00:00:00 2001
From: Jacek Kowalski <Jacek@jacekk.info>
Date: Tue, 29 Mar 2016 11:07:12 +0000
Subject: [PATCH] Add README

---
 README.md |   58 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 58 insertions(+), 0 deletions(-)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d105f7d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,58 @@
+# Gitblit
+
+This is a Docker image of Gitblit (http://gitblit.com/)
+based on `java:jre`
+
+## Usage
+
+```bash
+docker run -d --name=gitblit \
+	-p 8080:8080 -p 8443:8443 \
+	-p 9418:9418 -p 29418:29418 \
+	jacekkow/gitblit
+```
+
+Gitblit interface should be available at http://127.0.0.1:8080/
+(user/password: `admin`/`admin`)
+
+By default it uses Docker data volume for persistence.
+
+You can update such installation by passing `--volumes-from` option
+to `docker run`:
+
+```bash
+docker pull jacekkow/gitblit
+docker stop gitblit
+docker rename gitblit gitblit-old
+docker run -d --name=gitblit \
+	-p 8080:8080 -p 8443:8443 \
+	-p 9418:9418 -p 29418:29418 \
+	--volumes-from gitblit-old \
+	jacekkow/gitblit
+docker rm -v gitblit-old
+```
+
+### Local storage
+
+If you prefer to have direct access to container's data
+from the host, you can use local storage instead of data volumes:
+
+```bash
+docker run -d --name=gitblit \
+	-p 8080:8080 -p 8443:8443 \
+	-p 9418:9418 -p 29418:29418 \
+	-v /srv/gitblit:/opt/gitblit-data \
+	jacekkow/gitblit
+```
+
+`gitblit-data` volume will be automatically populated
+with default configuration if necessary.
+
+File ownership is recursively changed to
+`gitblit:gitblit` (`500:500`) on each start.
+
+### Configuration
+
+You can configure the instance by editing files 
+in directory /opt/gitblit-data inside the container
+(or appropriate host dir if local storage is used).

--
Gitblit v1.9.1