From 90e5831d8ff127696a053f8c0ec435fa9c258ba1 Mon Sep 17 00:00:00 2001 From: Grotax Date: Mon, 1 Apr 2024 08:53:16 +0000 Subject: Deployed 8c36f1d with MkDocs version: 1.4.2 --- .nojekyll | 0 404.html | 583 ++ admin/index.html | 795 +++ api/api-v1-2/index.html | 2318 +++++++ api/api-v1-3/index.html | 2308 +++++++ api/api-v2/index.html | 1876 ++++++ assets/favicon.png | Bin 0 -> 678 bytes assets/images/favicon.png | Bin 0 -> 1870 bytes assets/javascripts/bundle.51d95adb.min.js | 29 + assets/javascripts/bundle.51d95adb.min.js.map | 8 + assets/javascripts/lunr/min/lunr.ar.min.js | 1 + assets/javascripts/lunr/min/lunr.da.min.js | 18 + assets/javascripts/lunr/min/lunr.de.min.js | 18 + assets/javascripts/lunr/min/lunr.du.min.js | 18 + assets/javascripts/lunr/min/lunr.es.min.js | 18 + assets/javascripts/lunr/min/lunr.fi.min.js | 18 + assets/javascripts/lunr/min/lunr.fr.min.js | 18 + assets/javascripts/lunr/min/lunr.hi.min.js | 1 + assets/javascripts/lunr/min/lunr.hu.min.js | 18 + assets/javascripts/lunr/min/lunr.it.min.js | 18 + assets/javascripts/lunr/min/lunr.ja.min.js | 1 + assets/javascripts/lunr/min/lunr.jp.min.js | 1 + assets/javascripts/lunr/min/lunr.ko.min.js | 1 + assets/javascripts/lunr/min/lunr.multi.min.js | 1 + assets/javascripts/lunr/min/lunr.nl.min.js | 18 + assets/javascripts/lunr/min/lunr.no.min.js | 18 + assets/javascripts/lunr/min/lunr.pt.min.js | 18 + assets/javascripts/lunr/min/lunr.ro.min.js | 18 + assets/javascripts/lunr/min/lunr.ru.min.js | 18 + .../lunr/min/lunr.stemmer.support.min.js | 1 + assets/javascripts/lunr/min/lunr.sv.min.js | 18 + assets/javascripts/lunr/min/lunr.ta.min.js | 1 + assets/javascripts/lunr/min/lunr.th.min.js | 1 + assets/javascripts/lunr/min/lunr.tr.min.js | 18 + assets/javascripts/lunr/min/lunr.vi.min.js | 1 + assets/javascripts/lunr/min/lunr.zh.min.js | 1 + assets/javascripts/lunr/tinyseg.js | 206 + assets/javascripts/lunr/wordcut.js | 6708 ++++++++++++++++++++ assets/javascripts/workers/search.e5c33ebb.min.js | 42 + .../javascripts/workers/search.e5c33ebb.min.js.map | 8 + assets/logo.svg | 31 + assets/stylesheets/main.558e4712.min.css | 1 + assets/stylesheets/main.558e4712.min.css.map | 1 + assets/stylesheets/palette.2505c338.min.css | 1 + assets/stylesheets/palette.2505c338.min.css.map | 1 + clients/index.html | 813 +++ developer/index.html | 819 +++ features/customCSS/index.html | 631 ++ features/integration/index.html | 759 +++ features/plugins/index.html | 836 +++ features/themes/index.html | 622 ++ index.html | 618 ++ install/index.html | 938 +++ maintenance/index.html | 740 +++ search/search_index.json | 1 + sitemap.xml | 73 + sitemap.xml.gz | Bin 0 -> 324 bytes troubleshooting/index.html | 957 +++ 58 files changed, 23004 insertions(+) create mode 100644 .nojekyll create mode 100644 404.html create mode 100644 admin/index.html create mode 100644 api/api-v1-2/index.html create mode 100644 api/api-v1-3/index.html create mode 100644 api/api-v2/index.html create mode 100644 assets/favicon.png create mode 100644 assets/images/favicon.png create mode 100644 assets/javascripts/bundle.51d95adb.min.js create mode 100644 assets/javascripts/bundle.51d95adb.min.js.map create mode 100644 assets/javascripts/lunr/min/lunr.ar.min.js create mode 100644 assets/javascripts/lunr/min/lunr.da.min.js create mode 100644 assets/javascripts/lunr/min/lunr.de.min.js create mode 100644 assets/javascripts/lunr/min/lunr.du.min.js create mode 100644 assets/javascripts/lunr/min/lunr.es.min.js create mode 100644 assets/javascripts/lunr/min/lunr.fi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.fr.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hu.min.js create mode 100644 assets/javascripts/lunr/min/lunr.it.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ja.min.js create mode 100644 assets/javascripts/lunr/min/lunr.jp.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ko.min.js create mode 100644 assets/javascripts/lunr/min/lunr.multi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.nl.min.js create mode 100644 assets/javascripts/lunr/min/lunr.no.min.js create mode 100644 assets/javascripts/lunr/min/lunr.pt.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ro.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ru.min.js create mode 100644 assets/javascripts/lunr/min/lunr.stemmer.support.min.js create mode 100644 assets/javascripts/lunr/min/lunr.sv.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ta.min.js create mode 100644 assets/javascripts/lunr/min/lunr.th.min.js create mode 100644 assets/javascripts/lunr/min/lunr.tr.min.js create mode 100644 assets/javascripts/lunr/min/lunr.vi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.zh.min.js create mode 100644 assets/javascripts/lunr/tinyseg.js create mode 100644 assets/javascripts/lunr/wordcut.js create mode 100644 assets/javascripts/workers/search.e5c33ebb.min.js create mode 100644 assets/javascripts/workers/search.e5c33ebb.min.js.map create mode 100644 assets/logo.svg create mode 100644 assets/stylesheets/main.558e4712.min.css create mode 100644 assets/stylesheets/main.558e4712.min.css.map create mode 100644 assets/stylesheets/palette.2505c338.min.css create mode 100644 assets/stylesheets/palette.2505c338.min.css.map create mode 100644 clients/index.html create mode 100644 developer/index.html create mode 100644 features/customCSS/index.html create mode 100644 features/integration/index.html create mode 100644 features/plugins/index.html create mode 100644 features/themes/index.html create mode 100644 index.html create mode 100644 install/index.html create mode 100644 maintenance/index.html create mode 100644 search/search_index.json create mode 100644 sitemap.xml create mode 100644 sitemap.xml.gz create mode 100644 troubleshooting/index.html diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 000000000..e69de29bb diff --git a/404.html b/404.html new file mode 100644 index 000000000..f0d8d9620 --- /dev/null +++ b/404.html @@ -0,0 +1,583 @@ + + + + + + + + + + + + + + + + + + + + + + Nextcloud News App + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ +

404 - Not found

+ +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/admin/index.html b/admin/index.html new file mode 100644 index 000000000..9d038fb56 --- /dev/null +++ b/admin/index.html @@ -0,0 +1,795 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + Admin - Nextcloud News App + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

Admin

+

Welcome to the Admin documentation this page explains some of the configuration options for news.

+

System Cron

+

Nextcloud uses cron to run regular jobs, News relies on the Job system to execute the feed updates. +Alternatively you may use an external updater, in this case you need to disable the system cron in the settings.

+

Auto purge count

+
    +
  • The default value is 200.
    • +
  • To disable this feature, use -1.
    • +
  • Unread and starred items are not deleted.
    • +
+

Auto purging automatically removes the oldest read items of every feed after every update. +The value you enter here is used as the limit of read items per feed, unless the feed comes with more items in it's feed. +The individual limit per feed is only adjusted when it's bigger. Let's say last feed update came with 210 items, +then that will be the limit for that feed as long as no bigger update with more items is fetched. +In this case the limit will be 210 instead of 200, for that feed.

+

This is needed to prevent items from reappearing in the feed.

+

Purge unread items

+

This changes the behavior of the auto purging to also purge unread items. This is useful if you have users with a lot of unread items.

+

Starred items are always kept.

+

Explore Service

+

If you are using the News app in your company/community, it might be interesting to offer your users a bunch of easily to discover default feeds. You could also create a website where people can add and up-vote news feeds like bigger cloud feed readers like Feedly do it or even convert their APIs into a service for the News app (if someone wants to provide one for the News app, feel free to contact us by creating an issue in the bug tracker).

+

The URL should be a path to a directory which contains a JSON file in the format of feeds.LANG_CODE.json where LANG_CODE is a two character language code (e.g. en or de).

+

For example, entering the URL https://domain.com/directory as explore URL will produce the following request for German users:

+
GET https://domain.com/directory/feeds.de.json
+
+

Do not forget to implement CORS in your API, otherwise the request will fail!

+

Update Interval

+

The update interval is used to determine when the next update of all feeds should be done. +By default, the value is set to 3600 seconds (1 hour) You can configure this interval as an administrator. +The new value is only applied after the next run of the updater.

+

What is a good update interval?

+

That depends on your individual needs. +Please keep in mind that the lower you set your update interval, the more traffic is generated.

+

Can I set individual update intervals per feed/user?

+

No, that is not possible.

+ + + + + + +
+
+ + +
+ +
+ + + +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/api/api-v1-2/index.html b/api/api-v1-2/index.html new file mode 100644 index 000000000..210bcb6ae --- /dev/null +++ b/api/api-v1-2/index.html @@ -0,0 +1,2318 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + API v1.2 - Nextcloud News App + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + +