From b74ce02f3158ecc6fd838f5cda891ca3541e6a3d Mon Sep 17 00:00:00 2001 From: David Heinemeier Hansson Date: Sun, 22 Jan 2023 21:54:13 +0100 Subject: [PATCH] Document accessories --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index 7cf63e55..9cd8e17a 100644 --- a/README.md +++ b/README.md @@ -236,6 +236,33 @@ ARG RUBY_VERSION FROM ruby:$RUBY_VERSION-slim as base ``` +### Using accessories for database, cache, search services + +You can manage your accessory services via MRSK as well. The services will build off public images, and will not be automatically updated when you deploy: + +```yaml +accessories: + mysql: + image: mysql:5.7 + host: 1.1.1.3 + port: 3306 + env: + clear: + MYSQL_ROOT_HOST: '%' + secret: + - MYSQL_ROOT_PASSWORD + volumes: + - /var/lib/mysql:/var/lib/mysql + redis: + image: redis:8.0 + host: 1.1.1.4 + port: 6379 + volumes: + - /var/lib/redis:/data +``` + +Now run `mrsk accessory start mysql` to start the MySQL server on 1.1.1.3. See `mrsk accessory` for all the commands possible. + ## Commands ### Running remote execution and runners