Configuration options
selfoss offers the following configuration parameters. You can set the config parameters in the config.ini
file.
db_type
database type (sqlite
, mysql
or pgsql
)
db_file
location of database file for SQLite
db_host
address/hostname of the database server for MySQL/PostgreSQL
db_database
name of the database
db_username
database username
db_password
database password
db_prefix
Table prefix for MySQL/SQLite databases. This is useful to avoid conflicts when you are sharing a database with another application.
db_port
Port for database connections. By default 3306
will be used for MySQL and 5432
for PostgreSQL.
db_socket
A UNIX domain socket used for connecting to the MySQL database server. Usually, you want to use db_host=localhost
, which should use the default socket path (typically /run/mysqld/mysqld.sock
for MySQL or /run/postgresql
for PostgreSQL) but if you need to specify a different location, you can. This is orthogonal to db_host
option.
logger_destination
By default, the logs are saved to data/logs/default.log
but you can choose a different file by specifying a file path prefixed by file:
. Setting file:php://stderr
is especially useful when running selfoss on a PaaS or inside Docker. Alternately, you can set the option to error_log
to redirect the messages to SAPI error log – handy for PHP-FPM, which discards stderr by default.
logger_level
set logging level – following logging levels are available: EMERGENCY
, ALERT
, CRITICAL
, ERROR
, WARNING
, NOTICE
, INFO
, DEBUG
. Additionally, you can use NONE
pseudo-level to turn the logging off completely.
Use this for troubleshooting on updating feeds (but be aware that the log file can become very large.)
items_perpage
number of entries per page on your stream
items_lifetime
Number of days since the item has been last seen after which it can be deleted. Set to 0
to disable item deletion. Starred items will never be deleted.
base_url
base URL of the selfoss page; use this option if you use a ssl proxy which changes the $_SERVER
globals, most notably the URL path in which the app is installed.
username
username for optional login. Just set username and password for enabling login.
password
password hash for optional login. You can generate a password hash by using following page of your selfoss installation. https://your_selfoss_url.com/password
salt
(deprecated)
salt
salt for hashing the password (see Wikipedia). Not used for passwords generated using selfoss 2.19 or newer.
public
if you use login (username
and password
are set), you can allow guests to see your stream. Enter 1
for enabling this write-protected mode.
rss_title
title of the generated rss feed
rss_max_items
maximum amount of items in the generated rss feed
rss_mark_as_read
set this to 1
to automatically mark items as read after they appeared in selfoss’s RSS.
homepage
set here your preferred homepage. Choose between newest
, unread
and starred
. It is also possible to configure a tag (e.g. unread/tag-yourtag
) or a source (e.g. newest/source-123
). Default = newest
.
auto_mark_as_read
set this to 1
to automatically mark an item as read on opening it.
auto_collapse
set this to 1
to automatically collapse an item when another one is opened.
auto_stream_more
set this to 0
to disable automatic loading of more items when you scroll down. Click a button at the bottom of the page will be required instead.
open_in_background_tab
set this to 1
to try to make v shortcut open articles in new background tab. This does not work in Chromium based browsers.
language
set 0
or leave empty for auto detection (browser language) or use one of the following language codes:
- Catalan:
ca
- Chinese (Simplified):
zh-CN
- Chinese (Traditional):
zh-TW
- Czech:
cs
- Dutch:
nl
- English:
en
- English (United Kingdom):
en-GB
- Estonian:
et
- Finnish:
fi
- French:
fr
- French (Canada):
fr-CA
- Galician:
gl
- German:
de
- Hebrew:
he
- Hungarian:
hu
- Italian:
it
- Indonesian:
id
- Japanese:
ja
- Latvian:
lv
- Norwegian Bokmål:
nb
- Polish:
pl
- Portuguese:
pt
- Portuguese (Brazil):
pt-BR
- Romansh:
rm
- Russian:
ru
- Slovak:
sk
- Spanish:
es
- Swedish:
sv
- Turkish:
tr
- Ukrainian:
uk
allow_public_update_access
Set to 1
to allow public access for /update
(anybody can access and start the update job).
share
share
defines which sharing buttons beneath the entry are visible. The following methods are supported:
a
- Web Share API, when available
f
t
p
d
- Diaspora
m
- Mastodon (requires
mastodon
option to be set) w
- Wallabag (requires
wallabag
option to be set) s
- Wordpress (requires
wordpress
option to be set) e
c
- Copy to clipboard
Include the letters for methods you want to use. For example, if you would like to only show Facebook and Twitter share buttons, use share=ft
.
Defaults to share=atfpde
.
mastodon
URL of your Mastodon instance, for example https://example.com
.
wallabag
URL of your Wallabag instance.
wallabag_version
Set to 2
or 1
depending on your wallabag version (2
for version 2.x or 1
for version 1.x).
wordpress
URL of your WordPress blog for sharing links.
unread_order
Set to asc
to read your unread items from the oldest to the newest, leave it empty or to desc
to read from the newest to the oldest.
load_images_on_mobile
Set to 1
to allow image lazy loading on mobile devices.
auto_hide_read_on_mobile
Hide read articles on mobile devices.
scroll_to_article_header
Set to 0
to stop the interface from scrolling to the article header when an article is opened.
env_prefix
selfoss can use environment variables that start with this prefix as additional configuration options. This is useful for tools like Docker, where creating a config file is impractical. Defaults to SELFOSS_
.
camo_domain
Camo domain used to proxy images (optional). See atmos/camo for more details.
camo_key
Camo domain used to proxy images (optional). See atmos/camo for more details.
show_thumbnails
If set to 0
, thumbnails are not shown in the collapsed view. Defaults to 1
.
datadir
Location of the data directory; especially useful when selfoss is installed to write-protected file system. .htaccess
file (or equivalent configuration file for non-Apache web servers) will need to be adjusted accordingly.
reading_speed_wpm
Reading speed in words per minute used to calculate the estimated reading time of each article. On average, adults can read between 200 and 300 wpm and you can find many tools that can help you determine your reading speed on-line. If set to 0
(the default value), the estimated reading time is not shown.