You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Coop bd15b07688 Update docker-compose.yml 1 year ago
.dockerignore introduced .env file for compose 2 years ago
.env introduced .env file for compose 2 years ago
.gitignore added .gitignore file 2 years ago
Dockerfile Fixed php dot version issue and tar download issue 2 years ago
LICENSE Create LICENSE 2 years ago
README.md Update README.md 2 years ago
docker-compose.yml Update docker-compose.yml 1 year ago
docker-entrypoint.sh fixed #2: feed updater now started via docker-entrypoint.sh 2 years ago
site.conf added site.conf for PHP application 2 years ago

README.md

docker-ttrss

Docker build status Docker pulls

What is ttrss and docker-ttrss

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.

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.

This Docker image takes care of all of these manual steps for you.

Quickstart

This section assumes you want to get started very quickly. More details will be provided later on. So let's start.

Step 1: Clone the GitHub repository

> git clone https://github.com/aheil/docker-ttrss.git

Step 2: Start the containers using docker-compose:

> docker-compoer up

Step 3: Run application using navigating browser to

http://localhost:8080

You now should see the start page. By default you can login using the default paramters

Login: admin 
Password: password

How to use this Docker image

Initializing a fresh instance

Docker Hub Repository

You can pull the latest image directly from Docker Hub. Please refer the docker-compose.yml for dependencies and further configuration.

Caveats

There are some caveats you should be aware of this project. Most of the issues we are working actively on.

  • 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.
  • Not all paramters used by ttrss are fully supported yet.
  • The image uses a recent stable version of ttrss. It is planned to make this more flexible in the future.
  • Updates to a newer version is not supported for running containers. This is planned to be improved in the future.

License

The code for docker-ttrss at GitHub repository is licensed under a MIT license. Please refer the license page for further information.

Further References