GithubHelp home page GithubHelp logo

docker-tt-rss's Introduction

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

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

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 FILE__PASSWORD=/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

Power users

The container can configure itself using environment variables, the gaurd for this logic to run is if the variable DB_TYPE is set. The most common variables to set are a URL for the application and a database endpoint. IE:

  • -e DB_TYPE=mysql
  • -e DB_HOST=host
  • -e DB_USER=user
  • -e DB_NAME=name
  • -e DB_PASS=password
  • -e DB_PORT=3306
  • -e SELF_URL_PATH=http://localhost/

Please note if you use this method you need to have an already initialized database endpoint.

docker-tt-rss's People

Contributors

aptalca avatar chbmb avatar ironicbadger avatar j0nnymoe avatar linuxserver-ci avatar lonix avatar lunik1 avatar sparklyballs avatar thelamer avatar tobbenb avatar vrutkovs avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.