2020-09-02 19:47:25 +00:00
# freshrss
2020-09-22 20:24:37 +00:00
Custom image for FreshRSS feed aggregator
2019-10-02 07:43:32 +00:00
2020-02-22 17:08:14 +00:00
[](https://drone.rknet.org/docker/freshrss)
2020-09-21 20:11:01 +00:00
[](https://hub.docker.com/r/thegeeklab/freshrss)
2020-09-02 19:47:25 +00:00
[](https://quay.io/repository/thegeeklab/freshrss)
[](https://gitea.rknet.org/docker/freshrss)
2020-02-22 17:08:14 +00:00
[](https://gitea.rknet.org/docker/freshrss/src/branch/master/LICENSE)
2019-10-02 07:43:32 +00:00
2020-09-22 20:24:37 +00:00
Custom rootless Docker image for FreshRSS, a self-hosted RSS feed aggregator. It is lightweight, easy to work with, powerful, and customizable.
2019-10-02 07:43:32 +00:00
## Usage
Here are some example snippets to help you get started creating a container. This repository is just a wrapper to build a community docker image from [freshrss ](https://github.com/freshrss/freshrss ) releases.
> **WARNING**: For production usage you should secure your setup and NOT use the default secrets e.g. for database, default user and salt!
### Docker
```Shell
docker create \
--name=freshrss \
-p 80:8080 \
2020-09-21 20:11:01 +00:00
thegeeklab/freshrss
2019-10-02 07:43:32 +00:00
```
### Docker Compose
Compatible with docker-compose v2 schemas.
```Yaml
2020-05-04 18:31:19 +00:00
version: '3'
2019-10-02 07:43:32 +00:00
services:
freshrss:
container_name: freshrss
2020-09-21 20:11:01 +00:00
image: thegeeklab/freshrss:latest
2019-10-02 07:43:32 +00:00
ports:
- "80:8080"
volumes:
- freshrss_data:/var/www/app/data
- freshrss_extensions:/var/www/app/extensions
environment:
FRESHRSS_DEFAULT_USER: admin
FRESHRSS_DEFAULT_PASSWORD: freshrss
FRESHRSS_API_ENABLED: "true"
2019-10-02 07:49:10 +00:00
FRESHRSS_SALT: "38fd29ac5878c270bbfc3599723cd479d48c6c58"
2019-10-02 07:43:32 +00:00
volumes:
freshrss_data:
driver: local
freshrss_extensions:
driver: local
```
## Environment variables
2020-10-28 08:17:37 +00:00
### FreshRSS
2019-10-02 07:43:32 +00:00
> **WARNING**: Don't change any system settings through the web UI! These changes will be overwritten at EVERY container startup. Use the provided environment variables instead.
```Shell
FRESHRSS_ENVIRONMENT="production"
2019-10-02 21:46:40 +00:00
FRESHRSS_DEFAULT_USER="admin"
FRESHRSS_DEFAULT_PASSWORD="freshrss"
2019-10-02 07:43:32 +00:00
# Salt is used to make crypto more unique.
# Can be generated with e.g. cat /proc/sys/kernel/random/uuid | sha1sum | awk '{print $1}'
FRESHRSS_SALT=
# Specify address of the FreshRSS instance,
# used when building absolute URLs, e.g. for WebSub.
FRESHRSS_BASE_URL="http://localhost/"
FRESHRSS_LANGUAGE="en"
FRESHRSS_TITLE="FreshRSS"
2019-10-02 21:46:40 +00:00
FRESHRSS_META_DESCRIPTION=
2019-10-02 07:43:32 +00:00
FRESHRSS_DEFAULT_USER="_"
FRESHRSS_ALLOW_ANONYMOUS="false"
FRESHRSS_ALLOW_ANONYMOUS_REFRESH="false"
FRESHRSS_AUTH_TYPE="form"
FRESHRSS_API_ENABLED="false"
FRESHRSS_UNSAFE_AUTOLOGIN_ENABLED="false"
FRESHRSS_SIMPLEPIE_SYSLOG_ENABLED="true"
FRESHRSS_PUBSUBHUBBUB_ENABLED="false"
FRESHRSS_ALLOW_ROBOTS="false"
FRESHRSS_ALLOW_REFERRER="false"
FRESHRSS_LIMITS_COOKIE_DURATION="2592000"
FRESHRSS_LIMITS_CACHE_DURATION="800"
FRESHRSS_LIMITS_TIMEOUT="15"
FRESHRSS_LIMITS_MAX_FEEDS="16384"
FRESHRSS_LIMITS_MAX_CATEGORIES="16384"
FRESHRSS_LIMITS_MAX_REGISTRATIONS="1"
FRESHRSS_CURLOPT_SSL_VERIFYHOST=
FRESHRSS_CURLOPT_SSL_VERIFYPEER=
FRESHRSS_CURLOPT_PROXYTYPE=
FRESHRSS_CURLOPT_PROXY=
FRESHRSS_CURLOPT_PROXYPORT=
FRESHRSS_CURLOPT_PROXYAUTH=
FRESHRSS_CURLOPT_PROXYUSERPWD=
FRESHRSS_DB_TYPE="sqlite"
FRESHRSS_DB_HOST="localhost"
2019-10-03 11:51:27 +00:00
FRESHRSS_DB_PORT=
2019-10-02 07:43:32 +00:00
FRESHRSS_DB_USER=
FRESHRSS_DB_PASSWORD=
FRESHRSS_DB_BASE=
FRESHRSS_DB_PREFIX="freshrss_"
## comma-seperated string, extensions must be installed!
FRESHRSS_EXTENSIONS_ENABLED="Tumblr-GDPR"
```
### PHP
```Shell
PHP_EXPOSE_PHP=Off
PHP_MAX_EXECUTION_TIME=30
PHP_MAX_INPUT_TIME=60
PHP_MEMORY_LIMIT=50M
PHP_ERROR_REPORTING=E_ALL & ~E_DEPRECATED & ~E_STRICT
PHP_DISPLAY_ERRORS=Off
PHP_DISPLAY_STARTUP_ERRORS=Off
PHP_LOG_ERRORS=On
PHP_LOG_ERRORS_MAX_LEN=1024
PHP_IGNORE_REPEATED_ERRORS=Off
PHP_IGNORE_REPEATED_SOURCE=Off
PHP_REPORT_MEMLEAKS=On
PHP_HTML_ERRORSOn
PHP_ERROR_LOG=/proc/self/fd/2
PHP_POST_MAX_SIZE=8M
2019-10-03 17:30:44 +00:00
PHP_FILE_UPLOADS=On
2019-10-02 07:43:32 +00:00
PHP_UPLOAD_MAX_FILESIZE=2M
PHP_MAX_FILE_UPLOADS=2
PHP_ALLOW_URL_FOPEN=On
PHP_ALLOW_URL_INCLUDE=Off
PHP_DATE_TIMEZONE=Europe/Berlin
PHP_SQL_SAFE_MODE=On
```
2020-02-22 17:08:14 +00:00
## License
2019-10-02 07:43:32 +00:00
This project is licensed under the MIT License - see the [LICENSE ](https://gitea.rknet.org/docker/freshrss/src/branch/master/LICENSE ) file for details.
