Overmind

Overmind allows you to manage individual processes within a Procfile without affecting the others.

• Restart a process: bin/overmind restart <process_name>
• Stop a process: bin/overmind stop <process_name>

bin/overmind restart sidekiq
bin/overmind stop sidekiq

You can build gems for a specific target platform using the rake task with platform arguments. Supported examples include Linux (amd64) and macOS (arm64).

rake "overmind:build:linux[amd64]" # linux x86_64
rake "overmind:build:macos[arm64]" # macos arm64

To build multi-architecture tmux binaries for Linux platforms (amd64, arm64, arm/v7, and 386), use docker buildx. The resulting binaries will be placed in the ./dist directory.

docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7,linux/386 -t tmux-multiarch:latest --output type=local,dest=./dist data

To build Overmind from source, you must have Go 1.21 or later installed. The binary will be installed to $(go env GOPATH)/bin. Ensure this directory is in your PATH.

$ go install github.com/DarthSim/overmind/v2@latest

To build Overmind gems for all supported platforms (Linux, macOS, and FreeBSD), ensure you have run bundle install first, then use the rake "overmind:build:all" command.

Requirements:

• overmind and tmux binaries must exist in the GitHub release.
• Ruby version must be at least 3.0 to support the --platform argument in RubyGems.

On macOS, you can install Overmind using Homebrew.

brew install overmind

You can install Overmind as a Ruby gem.

gem install overmind

Overmind manages processes defined in a Procfile. By default, it looks for a file named Procfile in your current working directory.

To start processes:

• In a Rails project with binstubs: bin/overmind start
• In a standard Ruby project: overmind start

To specify a custom Procfile path, use the -f flag or the OVERMIND_PROCFILE environment variable.

To interact with a specific process (e.g., for debugging or providing input), use the connect command. This connects you to the process's tmux window.

• To connect to a specific process: bin/overmind connect <process_name>
• To connect to the first process defined in the Procfile: bin/overmind connect

To safely disconnect from the window without stopping the process, press your tmux prefix (usually Ctrl b) followed by d.

bin/overmind connect web

To integrate Overmind into a Rails application, add it to your Gemfile within the development group, generate a binstub, and create a bin/dev script to manage your development processes.

Steps:

1. Add to Gemfile:

   group :development do
     gem "overmind"
   end

2. Generate binstubs:

   bundle binstubs overmind

3. Create or update bin/dev:

   #!/usr/bin/env sh
   
   bin/overmind start -f Procfile.dev