Aerex
/
baikal-storage-plugin
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

docs: Cleaned up docs and added information on using cli

This commit is contained in:
Aerex 2021-07-05 15:41:03 -05:00
parent 5165567e63
commit 7c972550ff
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -9,10 +9,17 @@ composer require aerex/baikal-storage-plugin
```
## Configuration
Create the `config.yaml` to your webserver. Make sure the file is *writable* by your webserver (e.g Apache, Nginx). For more details on the configuration details see the wiki page.
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
Run the command `./vendor/baikalstorage` and follow the instructions
### Manual
Copy the `example-config.yaml` file and rename it to `config.yaml`.
## Usage
- Add the plugin to `Core/Frameworks/Baikal/Core/Server.php`
- 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/file>))
$this->server->addPlugin(new \Aerex\BaikalStorage\Plugin(<absolute/path/of/config.yaml)
```