Skip to content

Commit

Permalink
docs: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
SychO9 committed Dec 13, 2023
1 parent d6632ca commit ba43f85
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions extensions/package-manager/README.md
Original file line number Diff line number Diff line change
@@ -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).

0 comments on commit ba43f85

Please sign in to comment.