From 67c5fa647b4dce0dde553c09af64972977f7a11e Mon Sep 17 00:00:00 2001 From: Circle CI Automated Builder Date: Mon, 21 Mar 2016 20:09:52 +0100 Subject: [PATCH] Re-added README.md file --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d0502ce --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +[![Travis CI Build Status](https://img.shields.io/travis/cptactionhank/docker-atlassian-confluence/master.svg?label=Travis%20CI)](https://travis-ci.org/cptactionhank/docker-atlassian-confluence/branches) [![CircleCI Build Status](https://img.shields.io/circleci/project/cptactionhank/docker-atlassian-confluence/master.svg?label=CircleCI)](https://circleci.com/gh/cptactionhank/docker-atlassian-confluence) [![Open Issues](https://img.shields.io/github/issues/cptactionhank/docker-atlassian-confluence.svg)](https://github.com/cptactionhank/docker-atlassian-confluence/issues) [![Stars on GitHub](https://img.shields.io/github/stars/cptactionhank/docker-atlassian-confluence.svg)](https://github.com/cptactionhank/docker-atlassian-confluence/stargazers) [![Forks on GitHub](https://img.shields.io/github/forks/cptactionhank/docker-atlassian-confluence.svg)](https://github.com/cptactionhank/docker-atlassian-confluence/network) [![Stars on Docker Hub](https://img.shields.io/docker/stars/cptactionhank/atlassian-confluence.svg)](https://hub.docker.com/r/cptactionhank/atlassian-confluence/) [![Pulls on Docker Hub](https://img.shields.io/docker/pulls/cptactionhank/atlassian-confluence.svg)](https://hub.docker.com/r/cptactionhank/atlassian-confluence/) [![Friends of cptactionhank](https://img.shields.io/badge/donation-PayPal-blue.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=maage@dotmaage.dk&item_name=Friends+of+cptactionhank&item_number=oss-docker-atlassian-confluence) + +# Atlassian Confluence in a Docker container + +This is a containerized installation of Atlassian Confluence with Docker, and it's a match made in heaven for us all to enjoy. The aim of this image is to keep the installation as straight forward as possible, but with a few Docker related twists. You can get started by clicking the appropriate link below and reading the documentation. + +* [Atlassian JIRA Core](https://cptactionhank.github.io/docker-atlassian-jira) +* [Atlassian JIRA Software](https://cptactionhank.github.io/docker-atlassian-jira-software) +* [Atlassian JIRA Service Desk](https://cptactionhank.github.io/docker-atlassian-service-desk) +* [Atlassian Confluence](https://cptactionhank.github.io/docker-atlassian-confluence) + +If you want to help out, you can check out the contribution section further down. + +## I'm in the fast lane! Get me started + +To quickly get started running a Confluence instance, use the following command: +```bash +docker run --detach --publish 8090:8090 cptactionhank/atlassian-confluence:latest +``` + +Then simply navigate your preferred browser to `http://[dockerhost]:8090` and finish the configuration. + +## Contributions + +This image has been created with the best intentions and an expert understanding of docker, but it should not be expected to be flawless. Should you be in the position to do so, I request that you help support this repository with best-practices and other additions. + +Travis CI and CircleCI has been configured to build the `Dockerfile` and run acceptance tests on the Atlassian Confluence image to ensure it is working. + +Travis CI has additionally been configured to automatically deploy new version branches when successfully building a new version of Atlassian Confluence in the `master` branch and serves as the base. Furthermore an `eap` branch has been setup to automatically build and commit updates to ensure this branch contains the latest version of Atlassian Confluence Early Access Program. + +If you see out of date documentation, lack of tests, etc., you can help out by either +- creating an issue and opening a discussion, or +- sending a pull request with modifications (remember to read [contributing guide](https://github.com/cptactionhank/docker-atlassian-confluence/blob/master/CONTRIBUTING.md) before.) + +Continuous Integration and Continuous Delivery is made possible with the great services from [GitHub](https://github.com), [Travis CI](https://travis-ci.org/), and [CircleCI](https://circleci.com/) written in [Ruby](https://www.ruby-lang.org/), using [RSpec](http://rspec.info/), [Capybara](https://jnicklas.github.io/capybara/), and [PhantomJS](http://phantomjs.org/) frameworks.