FreshRSS#

FreshRSS is a free, self-hostable aggregator.

amd64
arm64
armv7

Information#

Docker Image: !!! LINK TO DOCKER IMAGE/ DOCKER HUB !!!
Current Image Version: alpine

SETUP#

Enabling freshrss#

Command:#

vlab set freshrss.enable True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

freshrss
enable: True

Finalising changes:#

run: vlab update_one service=freshrss

FIRST RUN#

!!! DEVELOPERS: make sure that you include any information that the user requires to get started, below. !!!
!!! Below are some examples with headings, and with some example instructions !!!

ADMINISTRATOR SETUP#

Navigate to https://False/admin

Create an account with your desired username; as this is the first user, freshrss makes this account the administrator.

SMTP/ MAIL#

  1. run vlab decrypt to decrypt the vault.yml file
  2. make some changes

SMTP Settings#

smtp:
host:
port:
user:
pass:
from_email:
from_name:
  1. run vlab update_one service=freshrss to complete the changes

ACCESS#

freshrss (HTTPS) link: https://freshrss.vivumlab.xyz/ freshrss (HTTP) link: http://freshrss.vivumlab.xyz/

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set freshrss.https_only True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

freshrss
https_only: True
Finalising changes:#

run: vlab update_one service=freshrss

AUTH#

Default: False
Options: True/False

Command:#

vlab set freshrss.auth True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

freshrss
auth: True
Finalising changes:#

run: vlab update_one service=freshrss

DOMAIN#

Default: False
NOTE: include the sitename and top level domain suffix. eg. name.com, site.net

Command:#

vlab set freshrss.domain freshrss.com

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

freshrss
domain: freshrss.com
Finalising changes:#

run: vlab update_one service=freshrss

SUBDOMAIN#

Default: freshrss
NOTE: Periods/ delimiters are not required. eg. 'media' will set the full URL as 'media.vivumlab.xyz'

Command:#

vlab set freshrss.subdomain media

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

freshrss
subdomain: media
Finalising changes:#

run: vlab update_one service=freshrss

VERSION#

Default: alpine
NOTE: Ensure that the version exists

Command:#

vlab set freshrss.version 2.7

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

freshrss
version: 2.7
Finalising changes:#

run: vlab update_one service=freshrss

Need more help?#

Further information regarding services can be found.
General Information can be found in the documentation.
Additional assistance can be found on our Contact Us page.