Skip to content
This repository has been archived by the owner on Oct 10, 2019. It is now read-only.

Commit

Permalink
Document feedhq-url setting
Browse files Browse the repository at this point in the history
It's been around since 5ca3bbe, but
wasn't documented back then. Since FeedHQ is open source and its
instances can be self-hosted, there's no reason to hide this setting
from the users.

Kudos to flips on IRC, whose question led to this commit.
  • Loading branch information
Minoru committed May 12, 2017
1 parent 910cc09 commit 98f65dd
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 0 deletions.
1 change: 1 addition & 0 deletions doc/configcommands.dsv
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ feedhq-password|<password>|""|This variable sets your FeedHQ password for FeedHQ
feedhq-passwordfile|<path-to-file>|""|A more secure alternative to the above, by storing your password elsewhere in your system.|feedhq-passwordfile "path-to-file"
feedhq-passwordeval|<command>|""|Another secure alternative, is providing your password from an external command that is evaluated during login. This can be used to read your password from a gpg encrypted file or your system keyring.|feedhq-passwordeval "command some-parameter"
feedhq-show-special-feeds|[yes/no]|yes|If this is set, then "special feeds" like "People you follow" (articles shared by people you follow), "Starred items" (your starred articles) and "Shared items" (your shared articles) appear in your subscription list.|feedhq-show-special-feeds "no"
feedhq-url|<url>|"https://feedhq.org/"|Configures the URL where your FeedHQ instance resides.|feedhq-url "https://feedhq.example.com/"
feedlist-format|<format>|"%4i %n %11u %t"|This variable defines the format of entries in the feed list. See the respective section in the documentation for more information on format strings.|feedlist-format " %n %4i - %11u -%> %t"
feedlist-title-format|<format>|"N %V - Your feeds (%u unread, %t total)%?T? - tag `%T'&?"|Format of the title in feed list. See "Format Strings" section of Newsbeuter manual for details on available formats.|feedlist-title-format "Feeds (%u unread, %t total)"
filebrowser-title-format|<format>|"%N %V - %?O?Open File&Save File? - %f"|Format of the title in file browser. See "Format Strings" section of Newsbeuter manual for details on available formats.|N %V - %?O?Open File&Save File? - %f|filebrowser-title-format "%?O?Open File&Save File? - %f"
Expand Down
10 changes: 10 additions & 0 deletions doc/example-config
Original file line number Diff line number Diff line change
Expand Up @@ -412,6 +412,16 @@
#
# feedhq-show-special-feeds "no"

#### feedhq-url
#
# Configures the URL where your FeedHQ instance resides.
#
# Syntax: <url>
#
# Default value: "https://feedhq.org/"
#
# feedhq-url "https://feedhq.example.com/"

#### feedlist-format
#
# This variable defines the format of entries in the feed list. See the
Expand Down
4 changes: 4 additions & 0 deletions doc/newsbeuter.txt
Original file line number Diff line number Diff line change
Expand Up @@ -615,6 +615,10 @@ instead of +"+.)

See also <<_passwords_for_external_apis,feedhq-passwordfile and feedhq-passwordeval>>.

if you're using a standalone instance, you should add one more setting:

feedhq-url "https://the.url.of/your/feedhq/instance"

When you start newsbeuter, it will download the feeds that you configured
in FeedHQ. Please take a closer look at the configuration commands for what
you can configure in newsbeuter regarding FeedHQ.
Expand Down

0 comments on commit 98f65dd

Please sign in to comment.