Improved setup docs #116
Improved setup docs #116
Conversation
| - /path/to/rules:/app/Rules | ||
|
|
||
| # Where external Hive plugins will be loaded from | ||
| #- /path/to/hive/plugins:/app/plugins |
There was a problem hiding this comment.
Correct. HiveCorePlugins is already included in the Hive docker image, so mounting the plugins folder is only necessary if the administrator wants to load third party plugins.
|
|
||
| If you do not want to use Docker, you can download the latest release of Hive through [the Releases page](https://github.com/Atlas-Rhythm/Hive/releases). | ||
|
|
||
| Simply unzip the Hive release wherever you wish to host Hive. |
There was a problem hiding this comment.
Do you also need plugins for this? Or do the releases have plugins bundled with them?
There was a problem hiding this comment.
If not, might be nice to clarify
There was a problem hiding this comment.
I think ideally, when we do go to make releases, we'd want to bundle HiveCorePlugins into the release zip. A major pain point in deployment right now is having to manually download and install the HiveCorePlugins to even use Hive, so I believe bundling core plugins wherever possible is a good idea.
Starting this PR a little early. Documentation may not be as fleshed out as whats needed for proper deployment, hopefully some good reviews would point that out.
This PR introduces new setup documentation for Hive, as well as the following:
Dockerfileto pull in the new HiveCorePlugins docker image.docker-compose.ymlwith more comments and examples for volume mounting and plugin configuration.