From ff1c6c9e12cf00ddaae5dfb20d579b8116cd6d79 Mon Sep 17 00:00:00 2001 From: Benjamin Brahmer Date: Fri, 28 Jun 2024 17:38:21 +0200 Subject: [PATCH] Add section about OCC Signed-off-by: Benjamin Brahmer --- docs/admin.md | 34 ++++++++++++++++++++++++++-------- 1 file changed, 26 insertions(+), 8 deletions(-) diff --git a/docs/admin.md b/docs/admin.md index 8a180fbb0b..827d4ac84d 100644 --- a/docs/admin.md +++ b/docs/admin.md @@ -1,13 +1,31 @@ # Admin -Welcome to the Admin documentation this page explains some of the configuration options for news. +Welcome to the Admin documentation. -## System Cron +## Administration via OCC + +News integrates with Nextclouds command line tool occ. + +To get an overview over the available commands simply execute `./occ list news` + +In most environments you will have to call occ like this: + +```bash +sudo -u www-data php ./occ list news +``` + +More information about occ here: [Nextcloud Admin Manual](https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/occ_command.html) + +## Settings + +The following sections explain some of the more complicated settings on the admin page. + +### 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](https://nextcloud.github.io/news/clients/#update-clients), in this case you need to disable the system cron in the settings. -## Auto purge count +### Auto purge count - The default value is 200. - To disable this feature, use -1. @@ -21,13 +39,13 @@ 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 +### 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 +### 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). @@ -39,17 +57,17 @@ For example, entering the URL **** as explore URL **Do not forget to implement [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS) in your API, otherwise the request will fail!** -## Update Interval +### 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? +#### 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? +#### Can I set individual update intervals per feed/user? No, that is not possible.