From 2213f3cd0df760329fa5d776ca3d0462c1657ad7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20L=C3=BCck?= Date: Tue, 13 May 2014 01:18:10 +0200 Subject: [PATCH] Update README.md --- README.md | 53 +++++++++++++++++++++++++++++++++-------------------- 1 file changed, 33 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index c48ba24..7c18b08 100644 --- a/README.md +++ b/README.md @@ -5,14 +5,41 @@ Keep your feed history to yourself and access your RSS and atom feeds from every You can access it through an easy to use webinterface on your desktop, your mobile browser or using one of available apps. -## Instructions +## Quickstart + +This section assumes you want to get started quickly, the following sections explain the +steps in more detail. So let's start. + +Just start up a new database container: + +```bash +$ DB=$(docker run -d nornagon/postgres) +``` + +And because this docker image is available as a [trusted build on the docker index](https://index.docker.io/u/clue/ttrss/), +using it is as simple as launching this Tiny Tiny RSS installation linked to your fresh database: ```bash -$ git clone https://github.com/clue/docker-ttrss.git -$ cd docker-ttrss -$ sudo docker build -t ttrss . +$ docker run -d --link $DB:db -p 80:80 clue/ttrss ``` +Running this command for the first time will download the image automatically. + +## Accessing your webinterface + +The above example exposes the Tiny Tiny RSS webinterface on port 80, so that you can browse to: + +http://localhost/ + +The default login credentials are: + +Username: admin +Password: password + +Obviously, you're recommended to change those ASAP. + +## Installation Walkthrough + ### Running Following docker's best practices, this container does not contain its own database, @@ -30,7 +57,6 @@ any, as long as is exposes its database port (5432) to the outside. Example: ```bash -$ sudo docker pull nornagon/postgres $ sudo docker run -d --name=tinystore nornagon/postgres ``` @@ -41,7 +67,7 @@ This is particular useful for your initial database setup, as errors get reporte the console and further execution will halt. ```bash -$ sudo docker run -it --link tinystore:db -p 80:80 ttrss +$ sudo docker run -it --link tinystore:db -p 80:80 clue/ttrss ``` ##### Database configuration @@ -77,18 +103,5 @@ Remaining arguments can be passed just like before, the following is the recomme minimum: ```bash -$ sudo docker run -d --link tinystore:db -p 80:80 ttrss +$ sudo docker run -d --link tinystore:db -p 80:80 clue/ttrss ``` - -### Accessing your webinterface - -The above examples expose the Tiny Tiny RSS webinterface on port 80, so that you can browse to: - -http://localhost/ - -The default login credentials are: - -Username: admin -Password: password - -Obviously, you're recommended to change those ASAP.