summaryrefslogtreecommitdiffstats
path: root/docs/install.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/install.md')
-rw-r--r--docs/install.md67
1 files changed, 62 insertions, 5 deletions
diff --git a/docs/install.md b/docs/install.md
index 3e72bfab6..6cfde70ca 100644
--- a/docs/install.md
+++ b/docs/install.md
@@ -1,9 +1,9 @@
-# Installation/Update
+# Installation/Update & Uninstall
## Dependencies
* 64bit OS (starting with News 16.0.0)
-* PHP >= 7.2
-* Nextcloud 20
+* PHP >= 8.0
+* Nextcloud (current stable version)
* libxml >= 2.7.8
You also need some PHP extensions:
@@ -21,16 +21,25 @@ You also need some PHP extensions:
* MySQL >= 8.0
* SQLite (discouraged)
-Also see the [Nextcloud documentation](https://docs.nextcloud.com/server/stable/admin_manual/configuration_database/linux_database_configuration.html?highlight=database). Oracle is currently not supported by news.
+Also see the [Nextcloud documentation](https://docs.nextcloud.com/server/stable/admin_manual/configuration_database/linux_database_configuration.html?highlight=database). Oracle is currently not supported by News.
## Performance Notices
* Use MySQL/MariaDB or PostgreSQL for better database performance
* Use the [updater script to thread and speed up the update](https://github.com/nextcloud/news-updater)
+## Cache
+News and it's libraries require a writeable temporary directory used as cache. The base directory depends on your system.
+You can [configure a custom directory](https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/config_sample_php_parameters.html?highlight=temp#tempdirectory) if you want.
+
+In most cases the base directory will be `/tmp`. News will create a folder `news-$instanceID` the [instance ID is defined by Nextcloud](https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/config_sample_php_parameters.html?highlight=temp#instanceid).
+
+Inside that folder a subfolder `cache` is created, inside this cache folder news and libraries will try to create cache directories for caching images, html and more.
+
+You need to ensure that your web-server user can write to that directory.
+
## Before you install/update the News app
Before you install the app do the following:
-* Check that your **nextcloud/data/** directory is owned by your web server user and that it is write/readable
* Check that your installation fulfills the [requirements listed above](#dependencies)
* [Set up Nextcloud Background Jobs](https://docs.nextcloud.org/server/latest/admin_manual/configuration_server/background_jobs_configuration.html#cron) to enable feed updates.
@@ -93,3 +102,51 @@ To update the News app use change into the **nextcloud/apps/news/** directory us
git pull --rebase origin master
make
+
+## Uninstall with cleanup
+
+First uninstall the app via the web-interface or via occ:
+
+```console
+./occ app:remove news
+```
+
+This currently does not remove any of the database tables.
+Data in your `/tmp` directory will be automatically deleted by the OS.
+If you changed the temporary directory for Nextcloud you need to check on your own.
+
+Careful, this next part is only intended for admins, that know what they are doing.
+
+To remove the tables from the DB we drop the tables of News.
+Your installation might have a different prefix than `oc_` but it is the default in most installations.
+Connect to your DB and execute the commands. Don't forget to switch to the right database.
+For example in mysql: `use nextcloud;`
+
+```sql
+DROP TABLE oc_news_items;
+DROP TABLE oc_news_feeds;
+DROP TABLE oc_news_folders;
+```
+
+Then we remove the traces in the migrations table.
+
+```sql
+DELETE FROM oc_migrations WHERE app='news';
+```
+
+Next delete the app configuration.
+
+```sql
+DELETE FROM oc_appconfig WHERE appid = 'news';
+```
+
+And finally remove the jobs from the job table.
+The last two lines are only needed for older installations.
+
+```sql
+DELETE FROM oc_jobs WHERE class='OCA\\News\\Cron\\UpdaterJob';
+DELETE FROM oc_jobs WHERE class='OCA\\News\\Cron\\Updater';
+DELETE FROM oc_jobs WHERE argument='["OCA\\\\News\\\\Cron\\\\Updater","run"]';
+```
+
+Now nothing is left from News in your Nextcloud installation.