BETA: a solr plugin for dokku

Github 星跟踪图

dokku solr Build Status IRC Network

Official solr plugin for dokku. Currently defaults to installing solr 7.7.2.


  • dokku 0.12.x+
  • docker 1.8.x


# on 0.12.x+
sudo dokku plugin:install solr


solr:app-links <app>          List all solr service links for a given app
solr:backup <name> <bucket> (--use-iam) NOT IMPLEMENTED
solr:backup-auth <name> <aws_access_key_id> <aws_secret_access_key> (<aws_default_region>) (<aws_signature_version>) (<endpoint_url>) NOT IMPLEMENTED
solr:backup-deauth <name>     NOT IMPLEMENTED
solr:backup-schedule <name> <schedule> <bucket> NOT IMPLEMENTED
solr:backup-schedule-cat <name> NOT IMPLEMENTED
solr:backup-set-encryption <name> <passphrase> NOT IMPLEMENTED
solr:backup-unschedule <name> NOT IMPLEMENTED
solr:backup-unset-encryption <name> NOT IMPLEMENTED
solr:clone <name> <new-name>  NOT IMPLEMENTED
solr:connect <name>           NOT IMPLEMENTED
solr:create <name>            Create a solr service with environment variables
solr:destroy <name>           Delete the service, delete the data and stop its container if there are no links left
solr:enter <name> [command]   Enter or run a command in a running solr service container
solr:exists <service>         Check if the solr service exists
solr:export <name> > <file>   NOT IMPLEMENTED
solr:expose <name> [port]     Expose a solr service on custom port if provided (random port otherwise)
solr:import <name> <file>     NOT IMPLEMENTED
solr:info <name>              Print the connection information
solr:link <name> <app>        Link the solr service to the app
solr:linked <name> <app>      Check if the solr service is linked to an app
solr:list                     List all solr services
solr:logs <name> [-t]         Print the most recent log(s) for this service
solr:promote <name> <app>     Promote service <name> as SOLR_URL in <app>
solr:restart <name>           Graceful shutdown and restart of the solr service container
solr:start <name>             Start a previously stopped solr service
solr:stop <name>              Stop a running solr service
solr:unexpose <name>          Unexpose a previously exposed solr service
solr:unlink <name> <app>      Unlink the solr service from the app


# create a solr service named lolipop
dokku solr:create lolipop

# you can also specify the image and image
# version to use for the service
# it *must* be compatible with the
# official solr image
export SOLR_IMAGE="solr"
export SOLR_IMAGE_VERSION="5.5.3"
dokku solr:create lolipop

# you can also specify custom environment
# variables to start the solr service
# in semi-colon separated form
export SOLR_CUSTOM_ENV="USER=alpha;HOST=beta"
dokku solr:create lolipop

# get connection information as follows
dokku solr:info lolipop

# you can also retrieve a specific piece of service info via flags
dokku solr:info lolipop --config-dir
dokku solr:info lolipop --data-dir
dokku solr:info lolipop --dsn
dokku solr:info lolipop --exposed-ports
dokku solr:info lolipop --id
dokku solr:info lolipop --internal-ip
dokku solr:info lolipop --links
dokku solr:info lolipop --service-root
dokku solr:info lolipop --status
dokku solr:info lolipop --version

# a bash prompt can be opened against a running service
# filesystem changes will not be saved to disk
dokku solr:enter lolipop

# you may also run a command directly against the service
# filesystem changes will not be saved to disk
dokku solr:enter lolipop ls -lah /

# a solr service can be linked to a
# container this will use native docker
# links via the docker-options plugin
# here we link it to our 'playground' app
# NOTE: this will restart your app
dokku solr:link lolipop playground

# the following environment variables will be set automatically by docker (not
# on the app itself, so they won’t be listed when calling dokku config)
# and the following will be set on the linked application by default
#   SOLR_URL=http://dokku-solr-lolipop:8983/solr/lolipop
# NOTE: the host exposed here only works internally in docker containers. If
# you want your container to be reachable from outside, you should use `expose`.

# another service can be linked to your app
dokku solr:link other_service playground

# since SOLR_URL is already in use, another environment variable will be
# generated automatically
#   DOKKU_SOLR_BLUE_URL=http://dokku-solr-other-service:8983/solr/other_service

# you can then promote the new service to be the primary one
# NOTE: this will restart your app
dokku solr:promote other_service playground

# this will replace SOLR_URL with the url from other_service and generate
# another environment variable to hold the previous value if necessary.
# you could end up with the following for example:
#   SOLR_URL=http://dokku-solr-other-service:89830/solr/other_service
#   DOKKU_SOLR_BLUE_URL=http://dokku-solr-other-service:8983/solr/other_service
#   DOKKU_SOLR_SILVER_URL=http://dokku-solr-lolipop:8983/solr/lolipop

# you can also unlink a solr service
# NOTE: this will restart your app and unset related environment variables
dokku solr:unlink lolipop playground

# you can tail logs for a particular service
dokku solr:logs lolipop
dokku solr:logs lolipop -t # to tail

# you can dump the database
dokku solr:export lolipop > lolipop.rdb

# you can import a dump
dokku solr:import lolipop < database.rdb

# you can clone an existing database to a new one
dokku solr:clone lolipop new_database

# finally, you can destroy the container
dokku solr:destroy lolipop

Changing database adapter

It's possible to change the protocol for SOLR_URL by setting the environment variable SOLR_DATABASE_SCHEME on the app:

dokku config:set playground SOLR_DATABASE_SCHEME=solr2
dokku solr:link lolipop playground

Will cause SOLR_URL to be set as solr2://dokku-solr-lolipop:8983/solr/lolipop

CAUTION: Changing SOLR_DATABASE_SCHEME after linking will cause dokku to believe the solr is not linked when attempting to use dokku solr:unlink or dokku solr:promote. You should be able to fix this by

  • Changing SOLR_URL manually to the new value.


  • Set SOLR_DATABASE_SCHEME back to its original setting
  • Unlink the service
  • Change SOLR_DATABASE_SCHEME to the desired setting
  • Relink the service

Disabling docker pull calls

If you wish to disable the docker pull calls that the plugin triggers, you may set the SOLR_DISABLE_PULL environment variable to true. Once disabled, you will need to pull the service image you wish to deploy as shown in the stderr output.

Please ensure the proper images are in place when docker pull is disabled.


许可证MIT License
最后发布时间2022-07-25 01:31:24
首次发布2018-04-11 19:03:44
最后一次提交2022-07-25 01:31:24
To the top