capistrano-nuxt2 0.2.17

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8fc077f38a45719b8343f127005d7eba3d591b5aa9b55c4d4e85b186f7688034
+  data.tar.gz: 33242fcbb894de7223cac35b376dca936f2980fcc0a7cd707c33498789156faf
+SHA512:
+  metadata.gz: e6ed8fc6a8971a54ae645c7dcca0323961d825dc97a0ebdf8ec039a7ea4adacbb783c90906cb89dc57d6cd6baea651713508f3424edf41b87a2a567944998b2c
+  data.tar.gz: 54db3f4d71e1d6b066c65ec7a311be3218cbc948036cc50829659921aae0bfb5f5c6d64d88dbe7bc263a22bd5e2113e40f31779140c66aff22095d80f02a29ff

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Austin Strange
+
+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,222 @@
+# Capistrano::Nuxt2
+
+Capistrano recipes to deploy nuxt 2 apps.
+
+
+## Usage
+
+prepare the server:
+```sh
+bundle exec cap production setup
+```
+
+deploy the app:
+```sh
+bundle exec cap production deploy
+```
+
+create SSL certificates:
+```sh
+bundle exec cap production certbot:generate
+```
+
+## Installation
+
+Inside your **Nuxt.js project root**, run:
+
+```sh
+bundle init
+```
+
+Then, edit the `Gemfile` and add:
+
+```ruby
+source "https://rubygems.org"
+
+gem "capistrano-nuxt2",  require: false,   github: "2strange/capistrano-nuxt2"
+```
+
+Then, install the dependencies:
+
+```sh
+bundle install
+```
+
+#### Initialize Capistrano
+
+```sh
+bundle exec cap install
+```
+
+This will generate the following files:
+```
+.
+├── Capfile
+├── config
+│   ├── deploy.rb
+│   ├── deploy
+│   │   ├── production.rb
+│   │   ├── staging.rb
+│   │   ├── development.rb
+│   │   └── shared.rb
+├── lib
+│   └── capistrano
+│       └── tasks
+└── ...
+```
+
+#### Add the following to your `Capfile`:
+
+```ruby
+require "capistrano/nuxt2"
+## or as you want
+require "capistrano/nuxt2/nuxt"
+## for certbot
+require "capistrano/nuxt2/certbot"
+## for nginx
+require "capistrano/nuxt2/nginx"
+## for nginx with a proxy server
+require "capistrano/nuxt2/proxy_nginx"
+```
+
+#### Add the following to your `config/deploy.rb`:
+
+```ruby 
+set :application , "my-nuxt-app"
+set :repo_url, "git_path_to_your_repo"
+```
+
+#### Add the following to your `config/deploy/-STAGE-.rb`:
+
+```ruby
+server  "SERVER_DOMAIN_OR_IP",  user: "DEPLOY_USER",   roles: %w{web}
+
+set :user,                            "DEPLOY_USER"
+set :deploy_to,                       "/home/#{fetch(:user)}/#{fetch(:application)}-#{fetch(:stage)}"
+
+set :branch,                          'STAGE_BRANCH'
+
+## NginX
+set :nginx_domains,                   ["YOUR_DOMAIN"]
+set :nginx_remove_www,                true
+
+## ssl-handling
+set :nginx_use_ssl,                   true
+set :certbot_email,                   "YOUR_EMAIL"
+
+```
+
+#### For nginx with a proxy server
+
+```ruby
+
+server "100.200.300.23", user: "deploy", roles: %w{app web}
+server "100.200.300.42", user: "deploy", roles: %w{proxy}, no_release: true
+
+set :user,                            "DEPLOY_USER"
+set :deploy_to,                       "/home/#{fetch(:user)}/#{fetch(:application)}-#{fetch(:stage)}"
+
+set :branch,                          'STAGE_BRANCH'
+
+set :nginx_upstream_host,             "100.200.300.23"
+set :nginx_upstream_port,             "3550"
+
+## NginX
+set :nginx_domains,                   ["YOUR_DOMAIN"]
+
+## ssl-handling
+set :nginx_use_ssl,                   true
+set :certbot_email,                   "YOUR_EMAIL"
+
+```
+
+---
+
+## Nuxt 3
+
+The `nuxt3:` tasks deploy Nuxt 3 apps. Nuxt 3 builds into `.output/`
+(`.output/server/index.mjs` for SSR, `.output/public/` for static assets),
+not `dist/`. Two modes are supported:
+
+- **SSR (default):** `nuxt build` → the Nitro server runs as a systemd service
+  (`node .output/server/index.mjs`), with the existing proxy in front of it.
+- **Static:** `nuxt generate` → `.output/public/` is synced to `shared/www`
+  and served directly by nginx (no node service). Good for content sites.
+
+Opt-in, leaves the Nuxt-2 `nuxt:` tasks untouched. Add to your `Capfile`:
+
+```ruby
+require "capistrano/nuxt2/nuxt3"
+## plus proxy + certbot as needed
+require "capistrano/nuxt2/proxy_nginx"
+require "capistrano/nuxt2/certbot"
+```
+
+#### SSR app — `config/deploy/-STAGE-.rb`
+
+```ruby
+server "100.200.300.23", user: "deploy", roles: %w{app web}
+server "100.200.300.42", user: "deploy", roles: %w{proxy}, no_release: true
+
+set :user,                  "DEPLOY_USER"
+set :deploy_to,             "/home/#{fetch(:user)}/#{fetch(:application)}-#{fetch(:stage)}"
+set :branch,                'STAGE_BRANCH'
+
+## Nuxt 3 SSR (Nitro node service)
+set :nuxt3_deploy_mode,     :ssr            # default
+set :nuxt3_use_nvm,         true
+set :nuxt3_nvm_version,     "20.19.0"
+set :nuxt3_ssr_port,        3500            # Nitro listens here (127.0.0.1)
+set :nuxt3_ssr_env,         { "NUXT_PUBLIC_API_BASE" => "https://api.example.com" }
+
+## Proxy points at the Nitro service
+set :nginx_upstream_host,   "100.200.300.23"
+set :nginx_upstream_port,   fetch(:nuxt3_ssr_port)
+
+## NginX / SSL
+set :nginx_domains,         ["YOUR_DOMAIN"]
+set :nginx_use_ssl,         true
+set :certbot_email,         "YOUR_EMAIL"
+```
+
+#### Static site — `config/deploy/-STAGE-.rb`
+
+```ruby
+server "SERVER_DOMAIN_OR_IP", user: "DEPLOY_USER", roles: %w{web}
+
+set :user,                  "DEPLOY_USER"
+set :deploy_to,             "/home/#{fetch(:user)}/#{fetch(:application)}-#{fetch(:stage)}"
+set :branch,                'STAGE_BRANCH'
+
+set :nuxt3_deploy_mode,     :static
+set :nuxt3_use_nvm,         true
+set :nuxt3_nvm_version,     "20.19.0"
+
+## NginX / SSL (serves shared/www directly)
+set :nginx_domains,         ["YOUR_DOMAIN"]
+set :nginx_use_ssl,         true
+set :certbot_email,         "YOUR_EMAIL"
+```
+
+The `deploy:published` hook rebuilds automatically per `:nuxt3_deploy_mode`.
+Manage the SSR service with `cap <stage> nuxt3:ssr:{setup,activate,restart,check_status,logs}`.
+
+**First SSR deploy** (the systemd unit doesn't exist yet, so an auto-restart
+would fail — same as puma/sidekiq):
+
+```ruby
+set :nuxt3_ssr_hooks, false   # in the stage file, for the first deploy only
+```
+
+```sh
+cap <stage> deploy              # builds + syncs .output (no restart)
+cap <stage> nuxt3:ssr:configure # uploads + enables + starts the Nitro unit
+```
+
+Then set `nuxt3_ssr_hooks` back to `true` (the default) so subsequent deploys
+restart the service cleanly.
+
+---
+
+## 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,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/capistrano/nuxt2/base_helpers.rb

@@ -0,0 +1,120 @@
+require 'erb'
+require 'stringio'
+
+module Capistrano
+  module Nuxt2
+    module BaseHelpers
+
+      def build_deploy_env_var
+        app_name = fetch(:application).gsub(/ /,'_').gsub(/-/,'_').upcase
+        stage_name = fetch(:stage) == 'production' ? 'PROD' : 'STG'
+        "#{ app_name }_#{ stage_name }_DEPLOY_MODE"
+      end
+
+      ## PAth helpers
+      def ensure_shared_path(path)
+        unless test("[ -d #{path} ]")
+          puts "📂 Directory #{path} does not exist. Creating it..."
+          execute :mkdir, "-p", path
+        else
+          puts "✅ Directory #{path} already exists."
+        end
+        ensure_shared_path_ownership
+      end
+
+      def ensure_shared_www_path
+        ensure_shared_path("#{shared_path}/www")
+      end
+
+      def ensure_shared_log_path
+        ensure_shared_path("#{shared_path}/log")
+      end
+
+      # Nuxt 3 SSR (Nitro) output dir – holds `server/index.mjs` + `public/`
+      def ensure_shared_output_path
+        ensure_shared_path("#{shared_path}/#{fetch(:nuxt3_output_folder, 'output')}")
+      end
+
+      # PID dir for the Nitro systemd service (mirrors recipes2go puma/sidekiq)
+      def ensure_shared_pids_path
+        ensure_shared_path("#{shared_path}/pids")
+      end
+
+      # bash -lc prefix that activates the requested node version via nvm.
+      # Mirrors the nvm pattern used by the nuxt:/vue: build tasks.
+      def nuxt3_nvm_prefix
+        "source #{fetch(:nuxt3_nvm_script)} && nvm use #{fetch(:nuxt3_nvm_version)}"
+      end
+
+      # Disable + stop + remove an old systemd service file (no-op if absent).
+      def remove_app_service(name = "SERVICE", service_path = "/lib/systemd/system", service_file = nil)
+        if test("[ -f #{service_path}/#{service_file}.service ]")
+          unless test("systemctl is-enabled #{service_file} || echo disabled") == "disabled"
+            info "🔧 Disabling #{service_file} service..."
+            execute :sudo, "systemctl disable #{service_file}"
+          else
+            info "✅ #{service_file} is already disabled, skipping."
+          end
+          puts "🔄 Stopping old #{name} service: #{service_file}.service"
+          execute :sudo, "systemctl stop #{service_file}"
+          puts "🗑 Removing old #{name} service file: #{service_file}.service"
+          execute :sudo, :rm, "-f", "#{service_path}/#{service_file}.service"
+        else
+          puts "⚠️  Old #{name} service file #{service_file}.service does not exist, skipping removal."
+        end
+      end
+
+      def ensure_shared_path_ownership
+        # Fix ownership only if needed (avoids unnecessary chown operations)
+        unless test("stat -c '%U:%G' #{shared_path} | grep #{fetch(:user)}:#{fetch(:user)}")
+          puts "🔧 Fixing ownership of #{shared_path} and its parent directories..."
+          execute :sudo, :chown, "-R #{fetch(:user)}:#{fetch(:user)} #{shared_path}"
+          execute :sudo, :chown, "#{fetch(:user)}:#{fetch(:user)} #{fetch(:deploy_to)}"
+        else
+          puts "✅ Ownership is already correct."
+        end
+      end
+
+
+
+      def template2go(from, to)
+        erb = get_template_file(from)
+        upload! StringIO.new( ERB.new(erb).result(binding) ), to
+      end
+      
+      
+      def render2go(tmpl)
+        erb = get_template_file(tmpl)
+        ERB.new(erb).result(binding)
+      end
+      
+
+      def template_with_role(from, to, role = nil)
+        erb = get_template_file(from)
+        upload! StringIO.new(ERB.new(erb).result(binding)), to
+      end
+      
+      
+      def get_template_file( from )
+        [
+            File.join('config', 'deploy', 'templates', "#{from}.erb"),
+            File.join('config', 'deploy', 'templates', "#{from}"),
+            File.join('lib', 'capistrano', 'templates', "#{from}.erb"),
+            File.join('lib', 'capistrano', 'templates', "#{from}"),
+            File.expand_path("../../../generators/capistrano/nuxt2/templates/#{from}.erb", __FILE__),
+            File.expand_path("../../../generators/capistrano/nuxt2/templates/#{from}", __FILE__)
+        ].each do |path|
+          return File.read(path) if File.file?(path)
+        end
+        # false
+        raise "File '#{from}' was not found!!!"
+      end
+      
+      
+    end
+  end
+end
+
+
+
+

data/lib/capistrano/nuxt2/certbot.rb

@@ -0,0 +1 @@
+load File.expand_path("../../tasks/certbot.rake", __FILE__)

data/lib/capistrano/nuxt2/nginx.rb

@@ -0,0 +1 @@
+load File.expand_path("../../tasks/nginx.rake", __FILE__)

data/lib/capistrano/nuxt2/nginx_helpers.rb

@@ -0,0 +1,56 @@
+module Capistrano
+  module Nuxt2
+    module NginxHelpers
+      def joiner
+        "\n                        "
+      end
+
+      def clear_domain(domain)
+        "#{domain}".gsub(/^www\./, "").gsub(/^\*?\./, "")
+      end
+
+      def subdomain_regex(domain)
+        "~^(www\.)?(?<sub>[\w-]+)#{Regexp.escape(".#{domain}")}"
+      end
+
+      def nginx_domains
+        Array(fetch(:nginx_domains)).map { |d| clear_domain(d) }.uniq
+      end
+
+      def nginx_domains_with_www
+        domains = []
+        nginx_domains.each do |domain|
+          domains << domain
+          domains << "www.#{domain}" unless domain.match(/\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}/)
+          domains << ".#{domain}" if fetch(:nginx_domain_wildcard, false)
+        end
+        domains
+      end
+
+      def nginx_major_domain
+        fetch(:nginx_major_domain, false) ? clear_domain(fetch(:nginx_major_domain)) : false
+      end
+
+      def cert_domain
+        fetch(:nginx_major_domain, false) ? fetch(:nginx_major_domain) : Array(fetch(:nginx_domains)).first
+      end
+
+      def nginx_all_domains_with_www
+        domains = []
+        nginx_domains.each do |domain|
+          domains << domain
+          domains << "www.#{domain}" unless domain.match(/\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}/)
+          domains << ".#{domain}" if fetch(:nginx_domain_wildcard, false)
+        end
+        if nginx_major_domain
+          domains << nginx_major_domain
+          domains << "www.#{nginx_major_domain}" unless nginx_major_domain.match(/\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}/)
+          domains << ".#{nginx_major_domain}" if fetch(:nginx_domain_wildcard, false)
+        end
+        domains
+      end
+    end
+  end
+end
+
+

data/lib/capistrano/nuxt2/nuxt.rb

@@ -0,0 +1 @@
+load File.expand_path("../../tasks/nuxt.rake", __FILE__)

data/lib/capistrano/nuxt2/nuxt3.rb

@@ -0,0 +1 @@
+load File.expand_path("../../tasks/nuxt3.rake", __FILE__)

data/lib/capistrano/nuxt2/proxy_nginx.rb

@@ -0,0 +1 @@
+load File.expand_path("../../tasks/proxy_nginx.rake", __FILE__)

data/lib/capistrano/nuxt2/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Nuxt2
+    VERSION = "0.2.17"
+  end
+end

data/lib/capistrano/nuxt2/vue.rb

@@ -0,0 +1 @@
+load File.expand_path("../../tasks/vue.rake", __FILE__)

data/lib/capistrano/nuxt2.rb

@@ -0,0 +1,9 @@
+load File.expand_path("../tasks/nuxt.rake", __FILE__)
+load File.expand_path("../tasks/nginx.rake", __FILE__)
+load File.expand_path("../tasks/certbot.rake", __FILE__)
+
+# module Capistrano
+#   module Nuxt2
+#     # Your code goes here...
+#   end
+# end