README.md update.
This commit is contained in:
parent
cbde54034d
commit
28db691e26
56
README.md
56
README.md
@ -1,11 +1,12 @@
|
||||
# docker-ttrss
|
||||
|
||||
This Dockerfile installs Tiny Tiny RSS with the following features:
|
||||
This Dockerfile installs Tiny Tiny RSS (TT-RSS) with the following features:
|
||||
|
||||
- '''New:''' Rolling release support: Updates TT-RSS automatically every day
|
||||
- Integrated [Feedly theme](https://github.com/levito/tt-rss-feedly-theme)
|
||||
- Integrated [mobilize plugin](https://github.com/sepich/tt-rss-mobilize) for using Readability, Instapaper + Google Mobilizer
|
||||
- New: Integrated [tt-rss-newsplus-plugin](https://github.com/hrk/tt-rss-newsplus-plugin) for News+ for Android
|
||||
- Self-signed 2048-bit RSA TLS certificate for accessing Tiny Tiny RSS via https
|
||||
- Integrated [Mobilize plugin](https://github.com/sepich/tt-rss-mobilize) for using Readability, Instapaper + Google Mobilizer
|
||||
- Integrated [News+ plugin](https://github.com/hrk/tt-rss-newsplus-plugin) for [News+](https://play.google.com/store/apps/details?id=com.noinnion.android.newsplus) on Android
|
||||
- Optional: Self-signed 2048-bit RSA TLS certificate for accessing TT-RSS via https
|
||||
- Originally was based on [clue/docker-ttrss](https://github.com/clue/docker-ttrss)
|
||||
|
||||
Feel free to tweak this further to your likings.
|
||||
@ -27,28 +28,37 @@ $ DB=$(docker run -d nornagon/postgres)
|
||||
```
|
||||
|
||||
And because this docker image is available as a [trusted build on the docker index](https://index.docker.io/u/x86dev/docker-ttrss/),
|
||||
using it is as simple as launching this Tiny Tiny RSS installation linked to your fresh database:
|
||||
using it is as simple as launching this TT-RSS installation linked to your fresh database:
|
||||
|
||||
```bash
|
||||
$ docker run -d --link $DB:db -p 443:443 --name ttrss x86dev/docker-ttrss
|
||||
$ docker run -d --link $DB:db -p 80:80 --name ttrss x86dev/docker-ttrss
|
||||
```
|
||||
|
||||
Running this command for the first time will download the image automatically.
|
||||
|
||||
## Accessing your webinterface
|
||||
## Accessing your Tiny Tiny RSS (TT-RSS)
|
||||
|
||||
The above example exposes the Tiny Tiny RSS webinterface on port 443 (https), so that you can browse to:
|
||||
The above example exposes the TT-RSS web interface on port 80 (http), so that you can browse to:
|
||||
|
||||
https://<yourhost>/ttrss
|
||||
```bash
|
||||
http://<yourhost>
|
||||
```
|
||||
|
||||
The default login credentials are:
|
||||
|
||||
```bash
|
||||
Username: admin
|
||||
Password: password
|
||||
```
|
||||
|
||||
Obviously, you're recommended to change those ASAP.
|
||||
|
||||
## Installation Walkthrough
|
||||
## Enabling SSL/TLS support
|
||||
|
||||
For enabling SSL/TLS support with a self-signed certificate you have to add `-e TTRSS_SSL_ENABLED=1`
|
||||
when running your TT-RSS container. Then you can access TT-RSS via: `https://<yourhost>`.
|
||||
|
||||
## Installation walkthrough
|
||||
|
||||
### Running
|
||||
|
||||
@ -70,22 +80,22 @@ Example:
|
||||
$ sudo docker run -d --name=ttrss-data nornagon/postgres
|
||||
```
|
||||
|
||||
#### Testing ttrss in foreground
|
||||
#### Testing TT-RSS 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.
|
||||
|
||||
```bash
|
||||
$ sudo docker run -it --link ttrss-data:db -p 443:443 --name ttrss x86dev/docker-ttrss
|
||||
$ sudo docker run -it --link ttrss-data:db --name ttrss x86dev/docker-ttrss
|
||||
```
|
||||
|
||||
##### Database configuration
|
||||
|
||||
Whenever your run ttrss, it will check your database setup. It assumes the following
|
||||
Whenever your run TT-RSS, it will check your database setup. It assumes the following
|
||||
default configuration, which can be changed by passing the following additional arguments:
|
||||
|
||||
```
|
||||
```bash
|
||||
-e DB_NAME=ttrss
|
||||
-e DB_USER=ttrss
|
||||
-e DB_PASS=ttrss
|
||||
@ -93,19 +103,19 @@ default configuration, which can be changed by passing the following additional
|
||||
|
||||
##### Database superuser
|
||||
|
||||
When you run ttrss, it will check your database setup. If it can not connect using the above
|
||||
When you run TT-RSS, 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
|
||||
For this to work, it will need a superuser (root) 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:
|
||||
|
||||
```
|
||||
```bash
|
||||
-e DB_ENV_USER=docker
|
||||
-e DB_ENV_PASS=docker
|
||||
```
|
||||
|
||||
#### Running ttrss daemonized
|
||||
#### Running TT-RSS 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).
|
||||
@ -113,7 +123,7 @@ Remaining arguments can be passed just like before, the following is the recomme
|
||||
minimum:
|
||||
|
||||
```bash
|
||||
$ sudo docker run -d --link ttrss-data:db -p 443:443 --name ttrss x86dev/docker-ttrss
|
||||
$ sudo docker run -d --link ttrss-data:db --name ttrss x86dev/docker-ttrss
|
||||
```
|
||||
|
||||
##### Backing up / moving to another server
|
||||
@ -121,9 +131,9 @@ $ sudo docker run -d --link ttrss-data:db -p 443:443 --name ttrss x86dev/docker-
|
||||
Decided to back up your data container and/or move to another server? Here's how
|
||||
you do it:
|
||||
|
||||
On the old server, stop your ttrss container and then do:
|
||||
On the old server, stop your TT-RSS container and then do:
|
||||
|
||||
```
|
||||
```bash
|
||||
docker commit -m "Backup of XXX" <CONTAINER NAME>
|
||||
docker save <IMAGE CREATED BY COMMIT> > /tmp/<filename>.tar
|
||||
```
|
||||
@ -131,13 +141,13 @@ docker save <IMAGE CREATED BY COMMIT> > /tmp/<filename>.tar
|
||||
On the new server, copy the created .tar file from the old server and
|
||||
import the file with:
|
||||
|
||||
```
|
||||
```bash
|
||||
docker load < <filename.tar>
|
||||
```
|
||||
|
||||
This will load the container from the .tar file into Docker's local registry.
|
||||
After that you can run that imported container again the usual way with:
|
||||
|
||||
```
|
||||
```bash
|
||||
docker run -d <IMAGE ID>
|
||||
```
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user