capistrano-addon-fm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fc7d4b0461652faa8410d3fc1e523d8859e39658e72efcc280bb7ac85cb8499b
+  data.tar.gz: f174c148881f0c23c6e437cf412edc2e3f94df850304e025eb944f736e91d93a
+SHA512:
+  metadata.gz: adcffbf7e1fad3b5225f3726bd6bc3ee07435553cab44610b30e045f3518343826d6448d66399f3abcee85aad72db9c76b7dd2ff6be1b3b06fad4b3337383791
+  data.tar.gz: 2060cf4a8fa6ec36eab7ebd411228785a4178c591dbb485ba471d7c5c6bc6a48ca1d317fe9e4bb01bc8d36b033bc5308347f2b7e177370ceff377cd84090d02c

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## [0.1.0] - 2025-02-18
+### Added
+- add generic tasks - documented in README.md

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in capistrano-addon-fm.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Florin Motoc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,121 @@
+# capistrano-addon-fm
+
+---
+
+## Installation
+
+- Add this to your `Gemfile`
+```ruby
+gem 'capistrano-addon-fm'
+```
+- Run `bundle install`
+- Add this to your `Capfile`
+```ruby
+require 'capistrano/addon/fm'
+```
+
+## Usage
+
+### this will add new tasks for `cap` command
+new tasks (example run: cap prod TASK - replace 'prod' with your stage (devel/local/etc))
+#### supervisor related commands:
+    cap prod supervisor:start                           Will run supervisorctl `start all`
+    cap prod supervisor:stop                            Will run supervisorctl `stop all`
+    cap prod supervisor:restart                         Will restart all supervisor processes (via stop and start)
+    cap prod supervisor:reread                          Will run supervisorctl `reread`
+    cap prod supervisor:update                          Will run supervisorctl `update`
+    cap prod supervisor:status                          Will display all supervisor processes
+    cap prod supervisor:status | grep RUNNING           Will display all supervisor processes in RUNNING state
+    cap prod supervisor:status | grep -v RUNNING        Will display all supervisor processes without the ones in RUNNING state
+#### nginx related commands:
+    cap prod nginx:start
+    cap prod nginx:stop
+    cap prod nginx:reload
+    cap prod nginx:restart
+    cap prod nginx:status
+#### fpm related commands: TO-BE-ADDED
+#### system related commands:
+    cap prod php                                        Run 'php -v'
+    cap prod composer                                   Run 'composer --version'
+    cap prod hostname                                   Run `hostname`
+    cap prod cpu                                        Run `cat /proc/cpuinfo | egrep 'model name|MHz'`
+    cap prod uptime                                     Run `uptime`
+    cap prod kernel                                     Run `lsb_release -a && uname -a`
+    cap prod hosts                                      Run `cat /etc/hosts`
+    cap prod ufw:status                                 Run 'ufw status verbose'
+    cap prod list:users                                 Run 'ls -lah /home'
+    cap prod list:supervisor                            Run 'ls -lah /etc/supervisor/conf.d/* && ls -lah /etc/supervisor/conf.d/*/'
+    cap prod redis:cfg:show                             Run 'cat /etc/redis/redis.conf | egrep -v "^\s*(#|$)"'
+    cap prod systemctl:daemon-reload                    Run 'systemctl daemon-reload'
+    cap prod haproxy|ssh|xz|redis :version (ex: cap prod haproxy:version)
+    cap prod system:disk_space: all|df|zfs|btrfs
+    cap prod system:connections:count: total|per_address|via_ss
+#### env-with-secrets:
+    cap env:upload                                      Will upload .env file to server and decrypt
+    cap env:upload:diff                                 Will run `diff` command to server's .env versus local .env - decrypted
+    cap env:local:encrypt_file                          Will encrypt `cap-secrets-LOCAL.txt` to `ap-secrets.enc.b64`
+    cap env:local:decrypt_file                          Will decrypt `ap-secrets.enc.b64` into `cap-secrets-LOCAL.txt`
+    cap env:local:secrets                               cat `cap-secrets-LOCAL.txt`
+#### custom related commands:
+    cap prod cat:env                                    Run `cat /var/www/*/*/.env`
+    cap prod empty_file:check                           Run `la -lah on nginx, fpm, laravel and var/www/*/current/logs/*`
+    cap prod empty_file: nginx|fpm|laravel|logs2        Run `truncate -s 0 && rm ` on nginx, fpm, laravel and var/www/*/current/logs/*`
+    cap prod empty_file:all                             Run check + truncate/rm + check on all
+#### Helpful commands
+    cap prod command ROLES=role1,role2                  Run command on specified role(s)
+    cap prod command HOSTS=host1,host2                  Run command on specified host(s)
+
+## Configuration
+
+Following variables are available to be changed (shown with defaults)
+
+```ruby
+# env-with-secrets
+set :local_path, './'
+set :file_to_encrypt, 'cap-secrets-LOCAL.txt'
+set :file_to_decrypt, 'cap-secrets.enc.b64'
+set :encryption_key_file, 'cap-secrets-encryption-key-LOCAL.txt'
+```
+
+## env-with-secrets
+### This will allow you to have .env files committed to git with secrets inside (encrypted)
+- Inside .env file you need to use `="CAP_ENCRYPTED_SECRETS[something]"`. Examples:
+  - `DB_PASSWORD="CAP_ENCRYPTED_SECRETS[DB_PASSWORD]"`
+  - `MAIL_PASSWORD="CAP_ENCRYPTED_SECRETS[MAIL_PASSWORD]"`
+- After deploy, the `CAP_ENCRYPTED_SECRETS[DB_PASSWORD]` will be replaced to whatever secret you wrote in the secrets file for key `DB_PASSWORD`
+  - Also, the `CAP_ENCRYPTED_SECRETS` will be removed; this is used for the regex to know when to replace
+- You also need 3 files - generate them by running `cap {prod} env:local:encrypt_file` - this will generate the files when they don't exist
+  - `cap-secrets-encryption-key-LOCAL.txt`
+    - Don't push this to git.
+    - You need to manually share this with other colleagues to be able to deploy and/or encrypt/decrypt .env files.
+    - This is the encryption key. You can change it to whatever you want. Default is 40 random chars.
+  - `cap-secrets-LOCAL.txt`
+    - Don't push this to git.
+    - Generated by `cap {prod} env:local:decrypt_file`
+      - Decrypts `cap-secrets.enc.b64` into `cap-secrets-LOCAL.txt`
+    - This file stores `SOME_KEY="secret"` on each line
+      - The `SOME_KEY` will be used in .env files like this: `SOME_VAR="CAP_ENCRYPTED_SECRETS[SOME_KEY]"`
+  - `cap-secrets.enc.b64`
+      - Push this to git.
+      - Generated by `cap {prod} env:local:encrypt_file`
+          - Encrypts `cap-secrets-LOCAL.txt` into `cap-secrets.enc.b64`
+- You can also change the location and name of these files by changing the 4 variables from `Configuration`
+  - You can also use subdirectories, but you need to create directories first.
+  - Everything is related to `Capfile`
+  - If you don't set anything, then the default is root of project (or, near the Capfile)
+- Finally, you need to have this in your `deploy.rb` or `stages/{stage}.rb`
+  - `before "deploy:symlink:release", "env:upload:diff"`
+    - I like having `diff` too, before `upload`, to see in `cap {prod} deploy` output the diff - if any
+    - So it will be:
+      - `before "deploy:symlink:release", "env:upload:diff"`
+      - `before "deploy:symlink:release", "env:upload"`
+  - Also, for each `server` line, you need to specify which .env file to use via `env_file_location`. Example:
+    - `server "web1", user: "user1", roles: %w{ app web etc }, env_file_location: '.env.prod.web1'`
+      - File `.env.prod.web1` should exist at root of project
+  - Preferably to update `.gitignore` file with the 2 `LOCAL` files
+    - `cap-secrets-LOCAL.txt`
+    - `cap-secrets-encryption-key-LOCAL.txt`
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/capistrano/addon/fm/tasks/custom.rake

@@ -0,0 +1,51 @@
+
+namespace 'cat' do
+  task 'env' do
+    on release_roles(:fpm) do
+      execute "cat /var/www/*/*/.env", raise_on_non_zero_exit: false
+    end
+  end
+end
+
+namespace "empty_file" do
+  task "all" do
+    invoke! "empty_file:check"
+    invoke! "empty_file:nginx"
+    invoke! "empty_file:fpm"
+    invoke! "empty_file:laravel"
+    invoke! "empty_file:logs2"
+    invoke! "empty_file:check"
+  end
+  task "check" do
+    on release_roles(:app) do
+      execute "ls -lahS /var/log/nginx/*.log", raise_on_non_zero_exit: false
+      execute "ls -lahS /var/log/php*-fpm.log", raise_on_non_zero_exit: false
+      execute "ls -lahS /var/www/*/current/storage/logs/*", raise_on_non_zero_exit: false
+      execute "ls -lahS /var/www/*/current/logs/*", raise_on_non_zero_exit: false
+    end
+  end
+  task "nginx" do
+    on release_roles(:app) do
+      execute "sudo truncate -s 0 /var/log/nginx/*.log", raise_on_non_zero_exit: false
+    end
+  end
+  task "fpm" do
+    on release_roles(:app) do
+      execute "sudo truncate -s 0 /var/log/php*-fpm.log", raise_on_non_zero_exit: false
+    end
+  end
+  task "laravel" do
+    on release_roles(:app) do
+      execute "sudo truncate -s 0 /var/www/*/current/storage/logs/*.log && sudo truncate -s 0 /var/www/*/current/storage/logs/*.err", raise_on_non_zero_exit: false
+      execute "sudo rm /var/www/*/current/storage/logs/*.log.*", raise_on_non_zero_exit: false
+      execute "sudo rm /var/www/*/current/storage/logs/*.err.*", raise_on_non_zero_exit: false
+    end
+  end
+  task "logs2" do
+    on release_roles(:app) do
+      execute "sudo truncate -s 0 /var/www/*/current/logs/*.log && sudo truncate -s 0 /var/www/*/current/logs/*.err", raise_on_non_zero_exit: false
+      execute "sudo rm /var/www/*/current/logs/*.log.*", raise_on_non_zero_exit: false
+      execute "sudo rm /var/www/*/current/logs/*.err.*", raise_on_non_zero_exit: false
+    end
+  end
+end

data/lib/capistrano/addon/fm/tasks/env-with-secrets.rake

@@ -0,0 +1,159 @@
+namespace "env" do
+  # Set default values
+  set :default_local_path, './'
+  set :default_file_to_encrypt, 'cap-secrets-LOCAL.txt'
+  set :default_file_to_decrypt, 'cap-secrets.enc.b64'
+  set :default_encryption_key_file, 'cap-secrets-encryption-key-LOCAL.txt'
+
+  # uploads .env to server (.env.tmp copied to .env)
+  task "upload" do
+    invoke! "env:local:check:files:exist"
+    invoke "env:upload_local_env_file"
+    invoke! "env:decrypt_remote_env_tmp_file"
+    on roles(:app) do
+      execute "cd #{shared_path} && cp .env.tmp .env", raise_on_non_zero_exit: false
+    end
+  end
+  # compares server .env with local .env (via .env.tmp)
+  task "upload:diff" do
+    invoke! "env:local:check:files:exist"
+    invoke "env:upload_local_env_file"
+    invoke! "env:decrypt_remote_env_tmp_file"
+    on roles(:app) do
+      execute "cd #{shared_path} && diff .env .env.tmp", raise_on_non_zero_exit: false
+    end
+  end
+  # upload local env to server (.env.tmp) - does not decrypt
+  task "upload_local_env_file" do
+    on roles(:app) do |host|
+      if !File.exists?("#{host.properties.env_file_location}")
+        puts "local env file `#{host.properties.env_file_location}` does not exist. skipping .env file upload!"
+      else
+        upload! "#{host.properties.env_file_location}", "#{shared_path}/.env.tmp"
+      end
+    end
+  end
+  # decrypt .env file on server (encrypted .env.tmp to decrypted .env.tmp)
+  task "decrypt_remote_env_tmp_file" do
+    on roles(:app) do
+      encryption_key_file = fetch(:encryption_key_file, fetch(:default_encryption_key_file))
+      base64_file = fetch(:file_to_decrypt, fetch(:default_file_to_decrypt))
+      encrypted_file = base64_file.gsub('.b64', '')
+      decrypted_file_tmp = "cap-secrets-tmp.txt"
+
+      # Read the .env file
+      env_file = capture(:cat, "#{shared_path}/.env.tmp")
+
+      # Read the encryption key from the local file
+      encryption_key = File.read(encryption_key_file).strip
+
+      # Decode and decrypt cap-secrets.enc.b64 into a temporary file cap-secrets-tmp.txt
+      execute "base64 -d #{release_path}/#{base64_file} > #{shared_path}/#{encrypted_file} && openssl enc -aes-256-cbc -d -pbkdf2 -in #{shared_path}/#{encrypted_file} -out #{shared_path}/#{decrypted_file_tmp} -pass pass:#{encryption_key}"
+
+      # Read the secrets from the temporary cap-secrets-tmp.txt file
+      secrets = {}
+      capture(:cat, "#{shared_path}/#{decrypted_file_tmp}").each_line do |line|
+        key, value = line.strip.split('=', 2)
+        secrets[key] = value.delete('"')
+      end
+
+      # Clean up the temporary files
+      execute "rm #{shared_path}/#{encrypted_file} && rm #{shared_path}/#{decrypted_file_tmp}"
+
+      # Replace the placeholders in the .env file with the actual secrets
+      decrypted_lines = env_file.each_line.map do |line|
+        line.gsub(/CAP_ENCRYPTED_SECRETS\[(.*?)\]/) do
+          secrets[$1]
+        end
+      end
+
+      # Write the modified .env file back to the server
+      execute :echo, "'#{decrypted_lines.join}' > #{shared_path}/.env.tmp", verbosity: :DEBUG
+    end
+  end
+  namespace :local do
+    desc 'Encrypt a local file'
+    task :encrypt_file do
+      invoke! "env:local:check:files:exist"
+      use_local_path = fetch(:local_path, fetch(:default_local_path))
+      Dir.chdir(use_local_path) do
+        encryption_key_file = fetch(:encryption_key_file, fetch(:default_encryption_key_file))
+        file = fetch(:file_to_encrypt, fetch(:default_file_to_encrypt))
+        base64_file = fetch(:file_to_decrypt, fetch(:default_file_to_decrypt))
+        encrypted_file = base64_file.gsub('.b64', '')
+
+        key = File.read(encryption_key_file).strip
+
+        # Encrypt the file
+        system("openssl enc -aes-256-cbc -pbkdf2 -in #{file} -out #{encrypted_file} -k #{key}")
+        # Encode the encrypted file with base64
+        system("base64 -i #{encrypted_file} -o #{base64_file}")
+        # Remove tmp file
+        system("rm #{encrypted_file}")
+
+        puts "File #{use_local_path}/#{file} has been encrypted to #{use_local_path}/#{encrypted_file} and base64-encoded to #{use_local_path}/#{base64_file}"
+      end
+    end
+
+    desc 'Decrypt a local file'
+    task :decrypt_file do
+      invoke! "env:local:check:files:exist"
+      use_local_path = fetch(:local_path, fetch(:default_local_path))
+      Dir.chdir(use_local_path) do
+        encryption_key_file = fetch(:encryption_key_file, fetch(:default_encryption_key_file))
+        base64_file = fetch(:file_to_decrypt, fetch(:default_file_to_decrypt))
+        encrypted_file = base64_file.gsub('.b64', '')
+        decrypted_file = fetch(:file_to_encrypt, fetch(:default_file_to_encrypt))
+
+        unless File.exist?(base64_file)
+          puts "Nothing to decrypt. Run `env:local:encrypt_file` first - to generate initial files with a random encryption key"
+        else
+          key = File.read(encryption_key_file).strip
+
+          # Decode the base64 file
+          system("base64 -d -i #{base64_file} -o #{encrypted_file}")
+          # Decrypt the file
+          system("openssl enc -d -aes-256-cbc -pbkdf2 -in #{encrypted_file} -out #{decrypted_file} -k #{key}")
+          # Remove tmp file
+          system("rm #{encrypted_file}")
+
+          puts "File #{use_local_path}/#{base64_file} has been base64-decoded to tmp file #{use_local_path}/#{encrypted_file} and decrypted to #{use_local_path}/#{decrypted_file}"
+        end
+      end
+    end
+    task "secrets" do
+      invoke! "env:local:check:files:exist"
+      use_local_path = fetch(:local_path, fetch(:default_local_path))
+      Dir.chdir(use_local_path) do
+        file = fetch(:file_to_encrypt, fetch(:default_file_to_encrypt))
+        puts "Contents of file #{use_local_path}/#{file}:\n\n"
+        system("cat #{file}")
+      end
+    end
+    task "check:files:exist" do
+      use_local_path = fetch(:local_path, fetch(:default_local_path))
+      unless Dir.exist?(use_local_path)
+        raise "Directory `#{use_local_path}` does not exist. create it first"
+      end
+      Dir.chdir(use_local_path) do
+        encryption_key_file = fetch(:encryption_key_file, fetch(:default_encryption_key_file))
+        file = fetch(:file_to_encrypt, fetch(:default_file_to_encrypt))
+
+        # Create encryption key file if it doesn't exist
+        unless File.exist?(encryption_key_file)
+          key = Array.new(40) { rand(65..90).chr }.join
+          File.write(encryption_key_file, key)
+          puts "Encryption key file #{encryption_key_file} created with a 40-character random key."
+        else
+          key = File.read(encryption_key_file).strip
+        end
+
+        # Create file to encrypt if it doesn't exist
+        unless File.exist?(file)
+          File.write(file, "ABC=\"def\"\n")
+          puts "File to encrypt #{file} created with default content."
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/addon/fm/tasks/mysql.rake

@@ -0,0 +1,60 @@
+
+namespace "mysql" do
+  task "start" do
+    on release_roles(:mysql) do
+      sudo "systemctl start mysql", raise_on_non_zero_exit: false
+    end
+  end
+  task "stop" do
+    on release_roles(:mysql) do
+      sudo "systemctl stop mysql", raise_on_non_zero_exit: false
+    end
+  end
+  task "restart" do
+    on release_roles(:mysql), in: :sequence, wait: 5 do
+      sudo "systemctl restart mysql", raise_on_non_zero_exit: false
+    end
+  end
+  task "status" do
+    on release_roles(:mysql) do
+      sudo "systemctl status mysql", raise_on_non_zero_exit: false
+    end
+  end
+  task "cfg:show" do
+    on release_roles(:mysql) do
+      execute 'cat /etc/mysql/mysql.conf.d/mysqld.cnf | egrep -v "^\s*(#|$)"', raise_on_non_zero_exit: false # filter ` space + # ` too
+    end
+  end
+  task "cfg:show:auto" do
+    on release_roles(:mysql) do
+      sudo 'cat /var/lib/mysql/auto.cnf', raise_on_non_zero_exit: false
+    end
+  end
+  task "tail" do
+    on release_roles(:mysql) do
+      sudo "tail /var/log/mysql/error.log -f -n 1", raise_on_non_zero_exit: false
+    end
+  end
+  task "tail:multi" do
+    on release_roles(:mysql) do
+      sudo "tail /var/log/syslog /var/log/mysql/error.log -f -n 1", raise_on_non_zero_exit: false
+    end
+  end
+  task "ls:logs" do
+    on release_roles(:mysql) do
+      sudo "ls -lah /var/log/mysql/", raise_on_non_zero_exit: false
+    end
+  end
+  task "ps" do
+    on release_roles(:mysql) do
+      execute 'ps aux | grep /usr/sbin/mysqld', raise_on_non_zero_exit: false
+    end
+  end
+  task "size" do
+    on release_roles(:mysql) do
+      sudo "du -msh /var/lib/mysql", raise_on_non_zero_exit: false
+    end
+  end
+end
+
+

data/lib/capistrano/addon/fm/tasks/nginx.rake

@@ -0,0 +1,27 @@
+namespace "nginx" do
+  task "start" do
+    on release_roles(:nginx) do
+      sudo "systemctl start nginx.service"
+    end
+  end
+  task "stop" do
+    on release_roles(:nginx) do
+      sudo "systemctl stop nginx.service"
+    end
+  end
+  task "reload" do
+    on release_roles(:nginx) do
+      sudo "systemctl reload nginx.service"
+    end
+  end
+  task "restart" do
+    on release_roles(:nginx) do
+      sudo "systemctl restart nginx.service"
+    end
+  end
+  task "status" do
+    on release_roles(:nginx) do
+      sudo "systemctl status nginx.service"
+    end
+  end
+end

data/lib/capistrano/addon/fm/tasks/supervisor.rake

@@ -0,0 +1,33 @@
+namespace "supervisor" do
+  task "start" do
+    on release_roles(:supervisor) do
+      sudo "supervisorctl start all", raise_on_non_zero_exit: false
+    end
+  end
+  task "stop" do
+    on release_roles(:supervisor) do
+      sudo "supervisorctl stop all", raise_on_non_zero_exit: false
+    end
+  end
+  task "restart" do
+    on release_roles(:supervisor) do
+      invoke! "supervisor:stop"
+      invoke! "supervisor:start"
+    end
+  end
+  task "reread" do
+    on release_roles(:supervisor) do
+      sudo "supervisorctl reread", raise_on_non_zero_exit: false
+    end
+  end
+  task "update" do
+    on release_roles(:supervisor) do
+      sudo "supervisorctl update", raise_on_non_zero_exit: false
+    end
+  end
+  task "status" do
+    on release_roles(:supervisor) do
+      sudo "supervisorctl status", raise_on_non_zero_exit: false
+    end
+  end
+end

data/lib/capistrano/addon/fm/tasks/system.rake

@@ -0,0 +1,145 @@
+
+task "php" do
+  on release_roles(:fpm) do
+    execute "hostname && php -v"
+  end
+end
+task "composer" do
+  on release_roles(:fpm) do
+    execute "hostname && sudo runuser -u www-data -- composer --version"
+  end
+end
+
+task "hostname" do
+  on release_roles(:app) do execute "hostname" end
+end
+task "cpu" do
+  on release_roles(:app) do
+    execute "hostname && cat /proc/cpuinfo | egrep 'model name|MHz'"
+  end
+end
+task "uptime" do
+  on release_roles(:app) do
+    execute "hostname && uptime"
+  end
+end
+task "kernel" do
+  on release_roles(:app) do
+    execute "hostname && lsb_release -a && uname -a"
+  end
+end
+
+task "hosts" do
+  on release_roles(:app) do
+    execute "hostname && cat /etc/hosts"
+  end
+end
+
+task "ufw:status" do
+  on release_roles(:all) do
+    sudo "ufw status verbose"
+  end
+end
+
+task "haproxy:version" do
+  on release_roles(:haproxy) do
+    execute "haproxy -v"
+  end
+end
+task "ssh:version" do
+  on release_roles(:all) do
+    execute "ssh -V"
+  end
+end
+task "xz:version" do
+  on release_roles(:all) do
+    execute "xz -V"
+  end
+end
+
+namespace "list" do
+  task "users" do
+    on release_roles(:app) do
+      execute "ls -lah /home", raise_on_non_zero_exit: false
+    end
+  end
+  task "supervisor" do
+    on release_roles(:supervisor) do
+      execute "ls -lah /etc/supervisor/conf.d/* && ls -lah /etc/supervisor/conf.d/*/", raise_on_non_zero_exit: false
+    end
+  end
+end
+
+# redis
+namespace "redis" do
+  task "cfg:show" do
+    on release_roles(:redis) do
+      sudo 'cat /etc/redis/redis.conf | egrep -v "^\s*(#|$)"', raise_on_non_zero_exit: false # filter ` space + # ` too
+    end
+  end
+  task "version" do
+    on release_roles(:redis) do
+      execute 'redis-server --version', raise_on_non_zero_exit: false
+    end
+  end
+end
+
+# systemctl
+namespace "systemctl" do
+  task "daemon-reload" do
+    on release_roles(:all) do
+      sudo "systemctl daemon-reload", raise_on_non_zero_exit: false
+    end
+  end
+  task "reboot" do
+    on release_roles(:all) do
+      sudo "systemctl reboot", raise_on_non_zero_exit: false
+    end
+  end
+end
+
+# system
+namespace "system" do
+  # disk_space
+  namespace "disk_space" do
+    task "all" do
+      invoke! "system:disk_space:df"
+      invoke! "system:disk_space:zfs"
+      invoke! "system:disk_space:btrfs"
+    end
+    task "df" do
+      on release_roles(:all) do
+        execute "df -HT"
+      end
+    end
+    task "zfs" do
+      on release_roles(:all) do
+        execute "sudo zpool list"
+      end
+    end
+    task "btrfs" do
+      on release_roles(:all) do
+        execute "sudo btrfs filesystem show"
+      end
+    end
+  end # end disk_space
+  # connections
+  namespace "connections:count" do
+    task "total" do
+      on release_roles(:app) do
+        execute "hostname && netstat -ant | grep ESTABLISHED | wc -l", raise_on_non_zero_exit: false
+      end
+    end
+    task "per_address" do
+      on release_roles(:app) do
+        execute "hostname && netstat -natu | awk '{print $5}' | cut -d: -f1 | sort | uniq -c | sort -n", raise_on_non_zero_exit: false
+      end
+    end
+    task "via_ss" do
+      on release_roles(:app) do
+        execute "hostname && ss -s", raise_on_non_zero_exit: false
+      end
+    end
+  end # end connections
+end # end system
+

data/lib/capistrano/addon/fm/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Capistrano
+  module Addon
+    module Fm
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/capistrano/addon/fm.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "fm/version"
+
+# Load all .rake files from the tasks directory
+Dir.glob(File.expand_path("./fm/tasks/**/*.rake", __dir__)).each { |r| load r }
+
+module Capistrano
+  module Addon
+    module Fm
+      class Error < StandardError; end
+      # Your code goes here...
+    end
+  end
+end

data/lib/capistrano/addon.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "addon/fm"
+
+module Capistrano
+  module Addon
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/sig/capistrano/addon/fm.rbs

@@ -0,0 +1,8 @@
+module Capistrano
+  module Addon
+    module Fm
+      VERSION: String
+      # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    end
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-addon-fm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Florin Motoc
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: capistrano addon - generic tasks - by FlorinMotoc
+email:
+- gems@mflorin.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/capistrano/addon.rb
+- lib/capistrano/addon/fm.rb
+- lib/capistrano/addon/fm/tasks/custom.rake
+- lib/capistrano/addon/fm/tasks/env-with-secrets.rake
+- lib/capistrano/addon/fm/tasks/mysql.rake
+- lib/capistrano/addon/fm/tasks/nginx.rake
+- lib/capistrano/addon/fm/tasks/supervisor.rake
+- lib/capistrano/addon/fm/tasks/system.rake
+- lib/capistrano/addon/fm/version.rb
+- sig/capistrano/addon/fm.rbs
+homepage: https://github.com/FlorinMotoc/capistrano-addon-fm
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/FlorinMotoc/capistrano-addon-fm
+  source_code_uri: https://github.com/FlorinMotoc/capistrano-addon-fm
+  changelog_uri: https://github.com/FlorinMotoc/capistrano-addon-fm/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.11
+signing_key:
+specification_version: 4
+summary: capistrano addon - generic tasks
+test_files: []