procsd 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8e46fcf465ed019b9ec9e9c77466ac959c0cc478e57f29d0b0dfcedf936ddfd
-  data.tar.gz: c7ba7690a99bde57f8c16512ba052a52d6da64f83619a33970a3fcddf48a65e9
+  metadata.gz: 417ecd3b90ef7fe2c1c1b9194db6cf90a3ca9af0be6ea2807b875d2323a36122
+  data.tar.gz: 4684afccd53e642bbc21ab45a7432e6a39b5ecab9839f9bd79c2cb0c226cf1fd
 SHA512:
-  metadata.gz: 16d5b9e1ff29bfcedbfe29e0f455b289e527f5cbb1ef4e14a0de2e7c677d30ed00c1584264293ea35ca123ce7d74045403bcf2f09926268d234c7e5f6590fe2e
-  data.tar.gz: 1c554a1804e6bfdab700808dd31b9dbc5ac88ff041ad6eda1f3be17edcd16542bc3502596509c5704b9225d8aba3cd5c6f718c7dcc577143ed032dcc189d4c6d
+  metadata.gz: 138c52b892a4e5afd53610a00082842b5db62c221c57820ffbb766d1fd91a5d5b9015b1248dd529ffbc27f75d68bf7c534158c32a38c23e82b45eac3f3ca14b3
+  data.tar.gz: 8caaae341c22e986466cc28173f0fb0a35f40f1d74d25af7a78ebb6af3cdfa20ab0110dece121602ddb3bf4989b6f64d197000509afb2b5b731bcd49c28f1da3

data/README.md

@@ -8,7 +8,7 @@ Can we have something similar on the cheap Ubuntu VPS from DigitalOcean? Yes we
 
 ## Getting started
 
-> **Note:** latest version of Procsd is `0.5.0`. Since version `0.4.0` there are some breaking changes. Check the [CHANGELOG.md](CHANGELOG.md). To update to the latest version, run `$ gem update procsd` or `$ bundle update procsd` (if you have already installed procsd).
+> **Note:** latest version of Procsd is `0.5.2`. Since version `0.4.0` there are some breaking changes. Check the [CHANGELOG.md](CHANGELOG.md). To update to the latest version, run `$ gem update procsd` or `$ bundle update procsd` (if you have already installed procsd).
 
 > **Note:** Procsd works best with Capistrano integration: [vifreefly/capistrano-procsd](https://github.com/vifreefly/capistrano-procsd)
 
@@ -64,7 +64,7 @@ You can provide additional options for `create` command:
 * `--dir` - application's working directory, default is current _$PWD_ env variable
 * `--path` - $PATH to include to the each service. Default is current _$PATH_ env variable
 * `--add-to-sudoers` - if option present, procsd will create sudoers rule file `/etc/sudoers.d/app_name` which allow to start/stop/restart app services without a password prompt (passwordless sudo).
-* `--or-restart` - if option provided and services already created, procsd will skip creation and call instead `restart` command. Otherwise (if services are not present), they will be created and (in additional) started.
+* `--or-restart` - if option provided and services already created, procsd will skip creation and call instead `restart` command. Otherwise (if services are not present), they will be created and (in additional) started. It's useful option for deployment tools like Capistrano, Mina, etc.
 
 
 ### Start application
@@ -192,7 +192,7 @@ Systemd provides [a lot of possibilities](https://www.digitalocean.com/community
 Currently, procsd can not run all processes in development like `foreman start` does. But you can run one single process using `procsd exec` command:
 
 ```
-deploy@server:~/sample_app$ PORT=3000 procsd exec web
+deploy@server:~/sample_app$ procsd exec web
 
 => Booting Puma
 => Rails 5.2.1 application starting in development
@@ -205,12 +205,30 @@ Puma starting in single mode...
 Use Ctrl-C to stop
 ```
 
-By default `procsd exec` skip environment variables defined in `procsd.yml`. To run process with production environment, provide `--env` option as well: `procsd exec web --env`.
+`procsd exec` requres all the environment variables defined in `environment` section of `procsd.yml` config file. Sometimes in development mode you need different environment configuration. For that you can add additional environment section `dev_environment` and require it as well using `--dev` flag, example:
+
+```yaml
+app: sample_app
+environment:
+  PORT: 2501
+  RAILS_ENV: production
+  RAILS_LOG_TO_STDOUT: true
+dev_environment:
+  RAILS_ENV: development
+  SOME_OTHER_DEV_ENV_VARIABLE=value
+```
+
+```
+deploy@server:~/sample_app$ PORT=3000 procsd exec web --dev
+```
+
+> The web process runs with all environment & dev_environment variables required.
+
 
 ### Nginx integration (with automatic HTTPS)
 > Before make sure that you have Nginx installed `sudo apt install nginx` and running `sudo systemctl status nginx`.
 
-If one of your application processes is a web process, you can automatically setup Nginx (reverse proxy) config for it. Why? For example to serve static files (assets, images, etc) directly using fast Nginx, rather than application server. Or to enable SSL support (see below).
+If one of your application processes is a web process, you can automatically setup Nginx (reverse proxy) config for it. Why? For example to serve static files (assets, images, and all other files located in `public` folder or another customly defined folder) directly using fast Nginx, rather than application server. Or to enable SSL support (see below).
 
 Add to your procsd.yml `nginx` section with `server_name` option defined:
 
@@ -218,7 +236,7 @@ Add to your procsd.yml `nginx` section with `server_name` option defined:
 
 > If your application use multiple domains/subdomains, add all of them separated with space: `server_name: my-domain.com us.my-domain.com uk.my-domain.com`
 
-```yml
+```yaml
 app: sample_app
 processes:
   web: bundle exec rails server -p $PORT
@@ -231,6 +249,7 @@ environment:
   RAILS_LOG_TO_STDOUT: true
 nginx:
   server_name: my-domain.com
+  public_folder_path: public # path is relative to the main project directory, not required, default value is `public`.
 ```
 
 Configuration is done! Run [procsd create](#create-an-application-export-to-systemd) to create app services with Nginx reverse proxy config:
@@ -257,7 +276,7 @@ Nginx config created and daemon reloaded
   <summary>/etc/nginx/sites-available/sample_app</summary>
 
 ```
-upstream app {
+upstream sample_app {
   server 127.0.0.1:2501;
 }
 
@@ -274,14 +293,14 @@ server {
     add_header Cache-Control public;
   }
 
-  try_files $uri/index.html $uri @app;
-  location @app {
+  try_files $uri/index.html $uri @sample_app;
+  location @sample_app {
     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
     proxy_set_header Host $http_host;
     proxy_set_header X-Forwarded-Proto $scheme;
     proxy_set_header X-Real-IP $remote_addr;
     proxy_redirect off;
-    proxy_pass http://app;
+    proxy_pass http://sample_app;
   }
 
   client_max_body_size 256M;
@@ -460,7 +479,6 @@ https://github.com/vifreefly/capistrano-procsd
 
 ## ToDo
 * Add `procsd update` command to quickly update changed configuration (application units, nginx config, etc), instead of calling two separate commands (`procsd destroy` and `procsd create`)
-* Add integration with [Inspeqtor](https://github.com/mperham/inspeqtor) to monitor application services and get alert notifications if something happened
 
 
 ## License

data/lib/procsd/cli.rb

@@ -18,12 +18,16 @@ module Procsd
       preload!
       if @config[:nginx]
         raise ConfigurationError, "Can't find nginx executable available" unless in_path?("nginx")
-        unless Dir.exist?(File.join options["dir"], "public")
+
+        public_folder_path = @config[:nginx]["public_folder_path"] || "public"
+        unless Dir.exist?(File.join options["dir"], public_folder_path)
           raise ConfigurationError, "Missing public/ folder to use with Nginx"
         end
+
         unless @config.dig(:environment, "PORT")
           raise ConfigurationError, "Please provide PORT environment variable in procsd.yml to use with Nginx"
         end
+
         if @config[:nginx]["ssl"]
           raise ConfigurationError, "Can't find certbot executable available" unless in_path?("certbot")
         end
@@ -202,19 +206,20 @@ module Procsd
 
     map exec: :__exec
     desc "exec", "Run app process"
-    option :env, type: :boolean, banner: "Require environment defined in procsd.yml"
+    option :dev, type: :boolean, banner: "Require dev_environment (in additional to base env) defined in procsd.yml"
     def __exec(process_name)
       preload!
 
       start_cmd = @config[:processes].dig(process_name, "commands", "ExecStart")
       raise ArgumentError, "Process is not defined: #{process_name}" unless start_cmd
 
-      if options["env"]
-        @config[:environment].each { |k, v| @config[:environment][k] = v.to_s }
-        exec @config[:environment], start_cmd
-      else
-        exec start_cmd
+      process_env = @config[:environment].each { |k, v| @config[:environment][k] = v.to_s }
+      if options["dev"]
+        dev_env = @config[:dev_environment].each { |k, v| @config[:dev_environment][k] = v.to_s }
+        process_env.merge!(dev_env)
       end
+
+      exec process_env, start_cmd
     end
 
     map %w[--version -v] => :__print_version
@@ -397,6 +402,8 @@ module Procsd
       end
 
       @config[:environment] = procsd["environment"] || {}
+      @config[:dev_environment] = procsd["dev_environment"] || {}
+
       @config[:systemd_dir] = procsd["systemd_dir"] || DEFAULT_SYSTEMD_DIR
       @config[:nginx] = procsd["nginx"]
     end

data/lib/procsd/generator.rb

@@ -68,8 +68,11 @@ module Procsd
     end
 
     def generate_nginx_conf(save: false)
-      root_path = File.join(@options["dir"], "public")
+      public_folder_path = @config[:nginx]["public_folder_path"] || "public"
+      root_path = File.join(@options["dir"], public_folder_path)
+
       content = generate_template("nginx", {
+        app_name: @config[:app],
         port: @config[:environment]["PORT"],
         server_name: @config[:nginx]["server_name"],
         root: root_path,

data/lib/procsd/templates/nginx.erb

@@ -1,4 +1,4 @@
-upstream app {
+upstream <%= config[:app_name] %> {
   server 127.0.0.1:<%= config[:port] %>;
 }
 
@@ -15,14 +15,14 @@ server {
     add_header Cache-Control public;
   }
 
-  try_files $uri/index.html $uri @app;
-  location @app {
+  try_files $uri/index.html $uri @<%= config[:app_name] %>;
+  location @<%= config[:app_name] %> {
     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
     proxy_set_header Host $http_host;
     proxy_set_header X-Forwarded-Proto $scheme;
     proxy_set_header X-Real-IP $remote_addr;
     proxy_redirect off;
-    proxy_pass http://app;
+    proxy_pass http://<%= config[:app_name] %>;
   }
 
   client_max_body_size 256M;

data/lib/procsd/version.rb

@@ -1,3 +1,3 @@
 module Procsd
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: procsd
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Victor Afanasev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-17 00:00:00.000000000 Z
+date: 2020-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -124,8 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Manage your application processes in production hassle-free like Heroku CLI