baikal-storage-plugin/README.md

26 lines
735 B
Markdown
Raw Normal View History

# baikal-storage-plugin
2021-02-24 18:52:52 -06:00
## Note
Plugin is still a work in progress
## Install
```
composer require aerex/baikal-storage-plugin
```
## Configuration
You can use the CLI to help you generate a config file or use the example configuration provided in the project. Make sure the file is *writable* by your webserver (e.g Apache, Nginx).
### Use the CLI
2021-07-05 15:50:23 -05:00
Run the command `./vendor/bin/baikalstorage` and follow the instructions
### Manual
Copy the `example-config.yaml` file and rename it to `config.yaml`.
## Usage
- Add the plugin to the end of the `Server.php` file located under `Core/Frameworks/Baikal/Core/Server.php`. For example
```
$this->server->addPlugin(new \Aerex\BaikalStorage\Plugin(<absolute/path/of/config.yaml)
```