Portainer Templates logo

Portainer Templates

Tiny Tiny RSS Tiny Tiny RSS

Container

Other

Tiny Tiny RSS is an open source web-based news feed (RSS/Atom) reader and aggregator, designed to allow you to read news from any location, while feeling as close to a real desktop application as possible.

Image details

Pulls: 1.3M
Architecture: amd64
Image size: 47 MB
User: lunik1
Created: Dec 11, 2019
Updated: 5 years ago
Status: active

Configuration

Type
Container
Platform
linux
Image
lunik1/tt-rss:latest
Ports
80/tcp
Volumes
/config : /portainer/Files/AppData/Config/tt-rss
Env vars
PUID=1000PGID=100
Restart
unless-stopped

Template by mikestraney

Standalone Install

Select an install method, to see config/commands for deploying Tiny Tiny RSS

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Tiny Tiny RSS, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

More install options in our documentation.

DEPRECATION NOTICE

This repository has been deprecated, development continues at https://gitlab.com/lunik1/docker-tt-rss.
The container image is now hosted at registry.gitlab.com/lunik1/docker-tt-rss.

Original README

A fork of the deprecated linuxserver.io tt-rss container. Uses latest master of tt-rss when built and rebuilds are triggered when commits are added to the tt-rss master branch or the base container is updated.
Find the Image on Docker Hub: https://hub.docker.com/r/lunik1/tt-rss
NOT supported or endorsed by the linuxserver.io team.

Usage

docker

docker create \
  --name=tt-rss \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Europe/London \
  -p 80:80 \
  -v <path to data>:/config \
  --restart unless-stopped \
  lunik1/tt-rss

docker-compose

Compatible with docker-compose v2 schemas.

```

version: "2" services: tt-rss:
image: lunik1/tt-rss
container_name: tt-rss
environment:
  - PUID=1000
  - PGID=1000
  - TZ=Europe/London
volumes:
  - <path to data>:/config
ports:
  - 80:80
restart: unless-stopped
## Parameters


<table><thead><tr><th>Parameter</th><th>Function</th></tr></thead><tbody><tr><td><code>-p 80</code></td><td>WebUI</td></tr><tr><td><code>-e PUID=1000</code></td><td>for UserID</td></tr><tr><td><code>-e PGID=1000</code></td><td>for GroupID</td></tr><tr><td><code>-e TZ=Europe/London</code></td><td>Specify a timezone to use EG Europe/London.</td></tr><tr><td><code>-v /config</code></td><td>Where tt-rss should store it's config files and data.</td></tr></tbody></table>

## Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend `FILE__`. 

As an example:
-e FILEPASSWORD=/run/secrets/mysecretpassword ```
Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.
 

Application Setup

You must create a user and database for tt-rss to use in a mysql/mariadb or postgresql server. A basic nginx configuration file can be found in /config/nginx/site-confs , edit the file to enable ssl (port 443 by default), set servername etc.. Self-signed keys are generated the first time you run the container and can be found in /config/keys , if needed, you can replace them with your own.
The default username and password after initial configuration is admin/password

Application Configuration

The container can configure itself using environment variables, this is now preferred over using config.php. The most common variables to set are a URL for the application and a database endpoint. IE:
  • -e TTRSSDBTYPE=mysql
  • -e TTRSSDBHOST=host
  • -e TTRSSDBUSER=user
  • -e TTRSSDBNAME=name
  • -e TTRSSDBPASS=password
  • -e TTRSSDBPORT=3306
  • -e TTRSSSELFURLPATH=http://localhost/

For a full list of supported variables and their defaults see here.
Please note you need to have an already initialized database endpoint.

Serve Tiny Tiny RSS on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying tiny-tiny-rss.example.com to http://tt-rss:80

Add this to your Caddyfile

tiny-tiny-rss.example.com {
	reverse_proxy http://tt-rss:80
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs tt-rss
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Published on a random port

This template exposes 80/tcp without setting a host port, so Docker picks a random free one on every deploy.

  • Find it in the Ports column of Portainer's container list, or with docker port tt-rss

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:100 /portainer/Files/AppData/Config/tt-rss
  • Or set the PUID and PGID variables (defaults 1000:100) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull lunik1/tt-rss:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect tt-rss --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

Tiny Tiny RSS runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Tiny Tiny RSS needs bundled into one download. This template pulls lunik1/tt-rss:latest, which Docker fetches once (about 47 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Tiny Tiny RSS's comes from Docker Hub, published by lunik1.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, so it runs on regular x86 PCs and servers, though not ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. Here the app exposes a port but leaves the host side blank, so Docker picks a free one for you. It opens:

  • 80, published on a random host port

Volumes

A volume is where Tiny Tiny RSS keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /config from /portainer/Files/AppData/Config/tt-rss on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Tiny Tiny RSS takes 2 of them, all with defaults you can leave alone or tweak:

  • PUID, defaults to 1000
  • PGID, defaults to 100

Restart policy

The restart policy here is unless-stopped, so Docker restarts Tiny Tiny RSS after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Nothing custom is set, so Tiny Tiny RSS sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container tt-rss. That's what you'll spot in the containers list and use in commands like docker logs tt-rss.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Tiny Tiny RSS up. Add the template list to Portainer once, then deploying Tiny Tiny RSS is a click rather than a wall of config.