diff options
Diffstat (limited to 'admin/index.html')
| -rw-r--r-- | admin/index.html | 773 |
1 files changed, 773 insertions, 0 deletions
diff --git a/admin/index.html b/admin/index.html new file mode 100644 index 000000000..ca54dade7 --- /dev/null +++ b/admin/index.html @@ -0,0 +1,773 @@ + +<!doctype html> +<html lang="en" class="no-js"> + <head> + + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width,initial-scale=1"> + + <meta name="description" content="Documentation for the Nextcloud News App"> + + + <meta name="author" content="Nextcloud News Team"> + + + <link rel="canonical" href="https://nextcloud.github.io/news/admin/"> + + <link rel="icon" href="../assets/favicon.png"> + <meta name="generator" content="mkdocs-1.3.1, mkdocs-material-8.4.1"> + + + + <title>Admin - Nextcloud News App</title> + + + + <link rel="stylesheet" href="../assets/stylesheets/main.69437709.min.css"> + + + <link rel="stylesheet" href="../assets/stylesheets/palette.cbb835fc.min.css"> + + + + + + + + + + <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script> + + + + + + </head> + + + + + + + + <body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none"> + + + + <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> + <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> + <label class="md-overlay" for="__drawer"></label> + <div data-md-component="skip"> + + + <a href="#admin" class="md-skip"> + Skip to content + </a> + + </div> + <div data-md-component="announce"> + + </div> + + + + +<header class="md-header" data-md-component="header"> + <nav class="md-header__inner md-grid" aria-label="Header"> + <a href=".." title="Nextcloud News App" class="md-header__button md-logo" aria-label="Nextcloud News App" data-md-component="logo"> + + <img src="../assets/logo.svg" alt="logo"> + + </a> + <label class="md-header__button md-icon" for="__drawer"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg> + </label> + <div class="md-header__title" data-md-component="header-title"> + <div class="md-header__ellipsis"> + <div class="md-header__topic"> + <span class="md-ellipsis"> + Nextcloud News App + </span> + </div> + <div class="md-header__topic" data-md-component="header-topic"> + <span class="md-ellipsis"> + + Admin + + </span> + </div> + </div> + </div> + + + + <label class="md-header__button md-icon" for="__search"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg> + </label> + <div class="md-search" data-md-component="search" role="dialog"> + <label class="md-search__overlay" for="__search"></label> + <div class="md-search__inner" role="search"> + <form class="md-search__form" name="search"> + <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required> + <label class="md-search__icon md-icon" for="__search"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> + </label> + <nav class="md-search__options" aria-label="Search"> + + <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg> + </button> + </nav> + + </form> + <div class="md-search__output"> + <div class="md-search__scrollwrap" data-md-scrollfix> + <div class="md-search-result" data-md-component="search-result"> + <div class="md-search-result__meta"> + Initializing search + </div> + <ol class="md-search-result__list"></ol> + </div> + </div> + </div> + </div> +</div> + + + <div class="md-header__source"> + <a href="https://github.com/nextcloud/news" title="Go to repository" class="md-source" data-md-component="source"> + <div class="md-source__icon md-icon"> + + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.1.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg> + </div> + <div class="md-source__repository"> + GitHub + </div> +</a> + </div> + + </nav> + +</header> + + <div class="md-container" data-md-component="container"> + + + + + + + <main class="md-main" data-md-component="main"> + <div class="md-main__inner md-grid"> + + + + <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" > + <div class="md-sidebar__scrollwrap"> + <div class="md-sidebar__inner"> + + + +<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0"> + <label class="md-nav__title" for="__drawer"> + <a href=".." title="Nextcloud News App" class="md-nav__button md-logo" aria-label="Nextcloud News App" data-md-component="logo"> + + <img src="../assets/logo.svg" alt="logo"> + + </a> + Nextcloud News App + </label> + + <div class="md-nav__source"> + <a href="https://github.com/nextcloud/news" title="Go to repository" class="md-source" data-md-component="source"> + <div class="md-source__icon md-icon"> + + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.1.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg> + </div> + <div class="md-source__repository"> + GitHub + </div> +</a> + </div> + + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + + <li class="md-nav__item"> + <a href=".." class="md-nav__link"> + Introduction + </a> + </li> + + + + + + + + + + + <li class="md-nav__item"> + <a href="../install/" class="md-nav__link"> + Installation/Update & Uninstall + </a> + </li> + + + + + + + + + + + <li class="md-nav__item"> + <a href="../clients/" class="md-nav__link"> + Clients + </a> + </li> + + + + + + + + + + + + + <li class="md-nav__item md-nav__item--active"> + + <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc"> + + + + + + <label class="md-nav__link md-nav__link--active" for="__toc"> + Admin + <span class="md-nav__icon md-icon"></span> + </label> + + <a href="./" class="md-nav__link md-nav__link--active"> + Admin + </a> + + + +<nav class="md-nav md-nav--secondary" aria-label="Table of contents"> + + + + + + + <label class="md-nav__title" for="__toc"> + <span class="md-nav__icon md-icon"></span> + Table of contents + </label> + <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> + + <li class="md-nav__item"> + <a href="#system-cron" class="md-nav__link"> + System Cron + </a> + +</li> + + <li class="md-nav__item"> + <a href="#auto-purge-count" class="md-nav__link"> + Auto purge count + </a> + +</li> + + <li class="md-nav__item"> + <a href="#purge-unread-items" class="md-nav__link"> + Purge unread items + </a> + +</li> + + <li class="md-nav__item"> + <a href="#explore-service" class="md-nav__link"> + Explore Service + </a> + +</li> + + <li class="md-nav__item"> + <a href="#update-interval" class="md-nav__link"> + Update Interval + </a> + + <nav class="md-nav" aria-label="Update Interval"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#what-is-a-good-update-interval" class="md-nav__link"> + What is a good update interval? + </a> + +</li> + + <li class="md-nav__item"> + <a href="#can-i-set-individual-update-intervals-per-feeduser" class="md-nav__link"> + Can I set individual update intervals per feed/user? + </a> + +</li> + + </ul> + </nav> + +</li> + + </ul> + +</nav> + + </li> + + + + + + + + + + + <li class="md-nav__item"> + <a href="../developer/" class="md-nav__link"> + Developer + </a> + </li> + + + + + + + + + + + <li class="md-nav__item"> + <a href="../faq/" class="md-nav__link"> + FAQ + </a> + </li> + + + + + + + + + + + + + + <li class="md-nav__item md-nav__item--section md-nav__item--nested"> + + + <input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" checked> + + + + + + + + + + + + + <label class="md-nav__link" for="__nav_7"> + Features + <span class="md-nav__icon md-icon"></span> + </label> + + <nav class="md-nav" aria-label="Features" data-md-level="1"> + <label class="md-nav__title" for="__nav_7"> + <span class="md-nav__icon md-icon"></span> + Features + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + <li class="md-nav__item"> + <a href="../features/customCSS/" class="md-nav__link"> + Custom CSS + </a> + </li> + + + + + + + + + + <li class="md-nav__item"> + <a href="../features/plugins/" class="md-nav__link"> + Plugins + </a> + </li> + + + + + + + + + + <li class="md-nav__item"> + <a href="../features/themes/" class="md-nav__link"> + Themes + </a> + </li> + + + + + </ul> + </nav> + </li> + + + + + + + + + + + + + + <li class="md-nav__item md-nav__item--section md-nav__item--nested"> + + + <input class="md-nav__toggle md-toggle md-toggle--indeterminate" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" checked> + + + + + + + + + + + + + <label class="md-nav__link" for="__nav_8"> + REST API + <span class="md-nav__icon md-icon"></span> + </label> + + <nav class="md-nav" aria-label="REST API" data-md-level="1"> + <label class="md-nav__title" for="__nav_8"> + <span class="md-nav__icon md-icon"></span> + REST API + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + <li class="md-nav__item"> + <a href="../api/api-v1-2/" class="md-nav__link"> + API v1.2 + </a> + </li> + + + + + + + + + + <li class="md-nav__item"> + <a href="../api/api-v1-3/" class="md-nav__link"> + API v1.3 + </a> + </li> + + + + + + + + + + <li class="md-nav__item"> + <a href="../api/api-v2/" class="md-nav__link"> + API v2 + </a> + </li> + + + + + </ul> + </nav> + </li> + + + + + + + + + + + <li class="md-nav__item"> + <a href="../maintenance/" class="md-nav__link"> + Maintenance + </a> + </li> + + + + </ul> +</nav> + </div> + </div> + </div> + + + + <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" > + <div class="md-sidebar__scrollwrap"> + <div class="md-sidebar__inner"> + + +<nav class="md-nav md-nav--secondary" aria-label="Table of contents"> + + + + + + + <label class="md-nav__title" for="__toc"> + <span class="md-nav__icon md-icon"></span> + Table of contents + </label> + <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> + + <li class="md-nav__item"> + <a href="#system-cron" class="md-nav__link"> + System Cron + </a> + +</li> + + <li class="md-nav__item"> + <a href="#auto-purge-count" class="md-nav__link"> + Auto purge count + </a> + +</li> + + <li class="md-nav__item"> + <a href="#purge-unread-items" class="md-nav__link"> + Purge unread items + </a> + +</li> + + <li class="md-nav__item"> + <a href="#explore-service" class="md-nav__link"> + Explore Service + </a> + +</li> + + <li class="md-nav__item"> + <a href="#update-interval" class="md-nav__link"> + Update Interval + </a> + + <nav class="md-nav" aria-label="Update Interval"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#what-is-a-good-update-interval" class="md-nav__link"> + What is a good update interval? + </a> + +</li> + + <li class="md-nav__item"> + <a href="#can-i-set-individual-update-intervals-per-feeduser" class="md-nav__link"> + Can I set individual update intervals per feed/user? + </a> + +</li> + + </ul> + </nav> + +</li> + + </ul> + +</nav> + </div> + </div> + </div> + + + <div class="md-content" data-md-component="content"> + <article class="md-content__inner md-typeset"> + + + <a href="https://github.com/nextcloud/news/blob/master/documentation/admin.md" title="Edit this page" class="md-content__button md-icon"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25Z"/></svg> + </a> + + + +<h1 id="admin">Admin</h1> +<p>Welcome to the Admin documentation this page explains some of the configuration options for news.</p> +<h2 id="system-cron">System Cron</h2> +<p>Nextcloud uses cron to run regular jobs, News relies on the Job system to execute the feed updates. +Alternatively you may use an <a href="https://nextcloud.github.io/news/clients/#update-clients">external updater</a>, in this case you need to disable the system cron in the settings.</p> +<h2 id="auto-purge-count">Auto purge count</h2> +<ul> +<li>The default value is 200.</li> +<li>To disable this feature, use -1.</li> +<li>Unread and starred items are not deleted.</li> +</ul> +<p>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. +For example you have the default value of 200 and the feed has 210 items in it's feed. +In this case the limit will be 210 instead of 200.</p> +<h2 id="purge-unread-items">Purge unread items</h2> +<p>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.</p> +<p><strong>Starred items are always kept.</strong></p> +<h2 id="explore-service">Explore Service</h2> +<p>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).</p> +<p>The URL should be a path to a directory which contains a JSON file in the format of <strong>feeds.LANG_CODE.json</strong> where LANG_CODE is a two character language code (e.g. <strong>en</strong> or <strong>de</strong>).</p> +<p>For example, entering the URL <strong>https://domain.com/directory</strong> as explore URL will produce the following request for German users:</p> +<pre><code>GET https://domain.com/directory/feeds.de.json +</code></pre> +<p><strong>Do not forget to implement <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS">CORS</a> in your API, otherwise the request will fail!</strong></p> +<h2 id="update-interval">Update Interval</h2> +<p>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.</p> +<h3 id="what-is-a-good-update-interval">What is a good update interval?</h3> +<p>That depends on your individual needs. +Please keep in mind that the lower you set your update interval, the more traffic is generated.</p> +<h3 id="can-i-set-individual-update-intervals-per-feeduser">Can I set individual update intervals per feed/user?</h3> +<p>No, that is not possible.</p> + + + + + + </article> + + </div> + </div> + + </main> + + <footer class="md-footer"> + + + <nav class="md-footer__inner md-grid" aria-label="Footer" > + + + <a href="../clients/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Clients" rel="prev"> + <div class="md-footer__button md-icon"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> + </div> + <div class="md-footer__title"> + <div class="md-ellipsis"> + <span class="md-footer__direction"> + Previous + </span> + Clients + </div> + </div> + </a> + + + + <a href="../developer/" class="md-footer__link md-footer__link--next" aria-label="Next: Developer" rel="next"> + <div class="md-footer__title"> + <div class="md-ellipsis"> + <span class="md-footer__direction"> + Next + </span> + Developer + </div> + </div> + <div class="md-footer__button md-icon"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg> + </div> + </a> + + </nav> + + <div class="md-footer-meta md-typeset"> + <div class="md-footer-meta__inner md-grid"> + <div class="md-copyright"> + + + Made with + <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> + Material for MkDocs + </a> + +</div> + + </div> + </div> +</footer> + + </div> + <div class="md-dialog" data-md-component="dialog"> + <div class="md-dialog__inner md-typeset"></div> + </div> + + <script id="__config" type="application/json">{"base": "..", "features": ["navigation.indexes", "navigation.tracking", "navigation.instant", "navigation.expand", "navigation.sections"], "search": "../assets/javascripts/workers/search.ecf98df9.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script> + + + <script src="../assets/javascripts/bundle.9c69f0bc.min.js"></script> + + + </body> +</html>
\ No newline at end of file |