92bfd747c5 | 11 years ago | |
---|---|---|
Dockerfile | 11 years ago | |
README.md | 11 years ago | |
configure-db.php | 11 years ago | |
supervisord.conf | 11 years ago | |
ttrss.nginx.conf | 11 years ago |
README.md
docker-ttrss
This docker image allows you to run the Tiny Tiny RSS feed reader. Keep your feed history to yourself and access your RSS and atom feeds from everywhere. You can access it through an easy to use webinterface on your desktop, your mobile browser or using one of available apps.
Instructions
$ git clone https://github.com/clue/docker-ttrss.git
$ cd docker-ttrss
$ sudo docker build -t ttrss .
Running
Following docker's best practices, this container does not contain its own database, but instead expects you to supply a running instance. While slightly more complicated at first, this gives your more freedom as to which database instance and configuration you're relying on. Also, this makes this container quite disposable, as it doesn't store any sensitive information at all.
Starting a database instance
This container requires a PostgreSQL database instance. You're free to pick (or build) any, as long as is exposes its database port (5432) to the outside.
Example:
$ sudo docker pull nornagon/postgres
$ sudo docker run -d --name=tinystore nornagon/postgres
Testing ttrss in foreground
For testing purposes it's recommended to initially start this container in foreground. This is particular useful for your initial database setup, as errors get reported to the console and further execution will halt.
$ sudo docker run -it --link tinystore:db -p 80:80 ttrss
Database configuration
Whenever your run ttrss, it will check your database setup. It assumes the following default configuration, which can be changed by passing the following additional arguments:
-e DB_NAME=ttrss
-e DB_USER=ttrss
-e DB_PASS=ttrss
Database superuser
When you run ttrss, it will check your database setup. If it can not connect using the above configuration, it will automatically try to create a new database and user.
For this to work, it will need a superuser account that is permitted to create a new database and user. It assumes the following default configuration, which can be changed by passing the following additional arguments:
-e DB_ENV_USER=docker
-e DB_ENV_PASS=docker
Running ttrss daemonized
Once you've confirmed everything works in the foreground, you can start your container
in the background by replacing the -it
argument with -d
(daemonize).
Remaining arguments can be passed just like before, the following is the recommended
minimum:
$ sudo docker run -d --link tinystore:db -p 80:80 ttrss
Accessing your webinterface
The above examples expose the Tiny Tiny RSS webinterface on port 80, so that you can browse to:
The default login credentials are:
Username: admin Password: password
Obviously, you're recommended to change those ASAP.