From ba43f8577be35740701d2fb506cbd41a1cb2330e Mon Sep 17 00:00:00 2001 From: Sami Mazouz Date: Wed, 13 Dec 2023 16:33:59 +0100 Subject: [PATCH] docs: readme --- extensions/package-manager/README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/extensions/package-manager/README.md b/extensions/package-manager/README.md index 036b90a83f..9716bc0821 100755 --- a/extensions/package-manager/README.md +++ b/extensions/package-manager/README.md @@ -1,5 +1,18 @@ # Package Manager -*An Experiment.* +The package manager is a tool that allows you to easily install and manage extensions. It runs [composer](https://getcomposer.org/) under the hood. -Read: https://github.com/flarum/package-manager/wiki +## Security + +If admin access is given to untrustworthy users, they can install malicious extensions. Please be careful. + +This extension is optional and can be removed for those who prefer to manually manage installs and updates through the command line interface. + +## Troubleshooting + +If you have many extensions installed, you may run into memory issues when using the package manager. If this happens, you can use an asynchronous queue that will run the package manager in the background. + +* Simple database queue guide: https://discuss.flarum.org/d/28151-database-queue-the-simplest-queue-even-for-shared-hosting +* (Advanced) Redis queue: https://discuss.flarum.org/d/21873-redis-sessions-cache-queues + +You can find detailed logs on the package manager operations in the `storage/logs/composer` directory. Please include the latest log file when reporting issues in the [Flarum support forum](https://discuss.flarum.org/t/support).