Skip to content

Commit 79f0b75

Browse files
authored
Update README.md
1 parent 4fe9534 commit 79f0b75

File tree

1 file changed

+51
-1
lines changed

1 file changed

+51
-1
lines changed

README.md

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,60 @@
33
[![Docker build status](https://img.shields.io/docker/cloud/build/aheilde/ttrss.svg)](https://cloud.docker.com/repository/docker/aheilde/ttrss/builds)
44
[![Docker pulls](https://img.shields.io/docker/pulls/_/ubuntu.svg)](https://hub.docker.com/r/aheilde/ttrss)
55

6+
## What is ttrss and docker-ttrss
67

7-
## This image is currently WIP - please refer to the issues before using this images.
8+
Tiny Tiny RSS (trss) is a free and open source web-based news feed (RSS/Atom) reader and aggregator which can be hosted by you on your own server.
89

10+
When you want to run and host ttrss by yourself, there are a few manual steps involved, such as setting up and initialzing the database as well as running the feed updater to frequently fetch your feeds.
11+
12+
This Docker image takes care of all of these manual steps for you.
13+
14+
## Quickstart
15+
16+
This section assumes you want to get started very quickly. More details will be provided later on. So let's start.
17+
18+
Step 1: Clone the GitHub repository
19+
20+
```
21+
> git clone https://github.com/aheil/docker-ttrss.git
22+
```
23+
24+
Step 2: Start the containers using docker-compose:
25+
26+
```
27+
> docker-compoer up
28+
```
29+
30+
Step 3: Run application using navigating browser to
31+
32+
```
33+
http://localhost:8080
34+
```
35+
36+
You now should see the start page. By default you can login using the default paramters
37+
```
38+
Login: admin
39+
Password: password
40+
```
41+
42+
## How to use this Docker image
43+
44+
## Initializing a fresh instance
945

1046
## Docker Hub Repository
1147

1248
You can pull the latest image directly from [Docker Hub](https://cloud.docker.com/repository/docker/aheilde/ttrss).
49+
Please refer the docker-compose.yml for dependencies and further configuration.
50+
51+
## Caveats
52+
There are some [caveats](https://www.urbandictionary.com/define.php?term=caveat) you should be aware of this project. Most of the issues we are working actively on.
53+
* The current setup is hard coded to a Postgres Database. Although, ttrss supports mysql this option is not configurable yet. This should be less a problem, as the provided setup starts its own Postgres container.
54+
* Not all paramters used by ttrss are fully supported yet.
55+
* The image uses a recent stable version of ttrss. It is planned to make this more flexible in the future.
56+
* Updates to a newer version is not supported for running containers. This is planned to be improved in the future.
57+
58+
## License
59+
The code for docker-ttrss at GitHub repository is licensed under a MIT license. Please refer the license page for further information.
60+
61+
## Further References
62+
* [Tiny Tiny RSS Homepage](https://tt-rss.org/)

0 commit comments

Comments
 (0)