From 4659392ad383b9533c957d6f1840a164cbefb915 Mon Sep 17 00:00:00 2001 From: immber Date: Fri, 30 Nov 2018 15:10:00 -0800 Subject: [PATCH] updated cusotm plugin docker onbuild instructions --- docs/source/plugins/overview.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/source/plugins/overview.md b/docs/source/plugins/overview.md index 2e8a9c2a5..1f734edeb 100644 --- a/docs/source/plugins/overview.md +++ b/docs/source/plugins/overview.md @@ -105,6 +105,8 @@ Then the application can be started as is. ### Docker +To deploy customized plugins to a production instance of Talk, we recommend using the Docker onbuild strategy outlined below. + If you deploy using Docker, you can extend from the `*-onbuild` image, an example `Dockerfile` for your project could be: @@ -112,14 +114,22 @@ example `Dockerfile` for your project could be: FROM coralproject/talk:4.5-onbuild ``` -Where the directory for your instance would contain a `plugins.json` file -describing the plugin requirements and a `plugins` directory containing any +Establish a private repository for your instance that includes the following: + +* a `plugins.json` file +listing the plugin requirements +* a `plugins` directory containing any other local plugins that should be included. +* a Dockerfile as outlined above + +Git submodules can also be used to point to plugin directories that might be outside your primary repository. Onbuild triggers will execute when the image is building with your custom configuration and will ensure that the image is ready to use by building all assets inside the image as well. +Once built, you can deploy the docker image to your architecture by tagging the image and including it in your docker-compose.yml. + For more information on the onbuild image, refer to the [Installation from Docker](/talk/installation-from-docker/) documentation.