Update documentation

Ruby > 2.2 is now required
Manual installation guide works on Ubuntu 16.04
Remove obsolete `string-scrub` gem

Dominik Sander 7 years ago
parent
commit
b0ae9581d2
6 changed files with 10 additions and 13 deletions
  1. 2 3
      Gemfile
  2. 0 2
      Gemfile.lock
  3. 2 2
      doc/README.md
  4. 1 1
      doc/deployment/capistrano/deploy.rb
  5. 2 2
      doc/manual/installation.md
  6. 3 3
      doc/manual/requirements.md

+ 2 - 3
Gemfile

@@ -1,7 +1,7 @@
1 1
 source 'https://rubygems.org'
2 2
 
3
-# Ruby 2.0 is the minimum requirement
4
-ruby ['2.0.0', RUBY_VERSION].max
3
+# Ruby 2.2.2 is the minimum requirement
4
+ruby ['2.2.2', RUBY_VERSION].max
5 5
 
6 6
 # Load vendored dotenv gem and .env file
7 7
 require File.join(File.dirname(__FILE__), 'lib/gemfile_helper.rb')
@@ -116,7 +116,6 @@ gem 'rufus-scheduler', '~> 3.0.8', require: false
116 116
 gem 'sass-rails',   '~> 5.0.6'
117 117
 gem 'select2-rails', '~> 3.5.4'
118 118
 gem 'spectrum-rails'
119
-gem 'string-scrub'	# for ruby <2.1
120 119
 gem 'therubyracer', '~> 0.12.2'
121 120
 gem 'typhoeus', '~> 0.6.3'
122 121
 gem 'uglifier', '~> 2.7.2'

+ 0 - 2
Gemfile.lock

@@ -527,7 +527,6 @@ GEM
527 527
       colorize (>= 0.7.0)
528 528
       net-scp (>= 1.1.2)
529 529
       net-ssh (>= 2.8.0)
530
-    string-scrub (0.0.5)
531 530
     systemu (2.6.4)
532 531
     term-ansicolor (1.3.2)
533 532
       tins (~> 1.0)
@@ -685,7 +684,6 @@ DEPENDENCIES
685 684
   spring (~> 1.7.2)
686 685
   spring-commands-rspec (~> 1.0.4)
687 686
   spring-watcher-listen (~> 2.0.0)
688
-  string-scrub
689 687
   therubyracer (~> 0.12.2)
690 688
   tumblr_client!
691 689
   twilio-ruby (~> 3.11.5)

+ 2 - 2
doc/README.md

@@ -8,7 +8,7 @@
8 8
 
9 9
 ### Manual installation
10 10
 
11
-Manual installation instructions which will guide through the steps to install Huginn on any Ubuntu 12.04/14.04 or Debian 6/7 server.
11
+Manual installation instructions which will guide through the steps to install Huginn on any Ubuntu 12.04/14.04/16.04 or Debian 6/7 server.
12 12
 
13 13
 - [Install](manual/README.md) Requirements, directory structures and installation from source.
14 14
 - [Update](manual/update.md) Update your installation.
@@ -17,4 +17,4 @@ Manual installation instructions which will guide through the steps to install H
17 17
 ### Heroku
18 18
 
19 19
 - [Deploy to Heroku](heroku/install.md)
20
-- [Update](heroku/update.md) an existing Heroku deployment
20
+- [Update](heroku/update.md) an existing Heroku deployment

+ 1 - 1
doc/deployment/capistrano/deploy.rb

@@ -68,7 +68,7 @@ namespace :foreman do
68 68
 end
69 69
 
70 70
 # If you want to use rvm on your server and have it maintained by Capistrano, uncomment these lines:
71
-#   set :rvm_ruby_string, '2.0.0@huginn'
71
+#   set :rvm_ruby_string, '2.3.1@huginn'
72 72
 #   set :rvm_type, :user
73 73
 #   before 'deploy', 'rvm:install_rvm'
74 74
 #   before 'deploy', 'rvm:install_ruby'

+ 2 - 2
doc/manual/installation.md

@@ -65,8 +65,8 @@ Remove the old Ruby versions if present:
65 65
 Download Ruby and compile it:
66 66
 
67 67
     mkdir /tmp/ruby && cd /tmp/ruby
68
-    curl -L --progress http://cache.ruby-lang.org/pub/ruby/2.3/ruby-2.3.0.tar.bz2 | tar xj
69
-    cd ruby-2.3.0
68
+    curl -L --progress http://cache.ruby-lang.org/pub/ruby/2.3/ruby-2.3.1.tar.bz2 | tar xj
69
+    cd ruby-2.3.1
70 70
     ./configure --disable-install-rdoc
71 71
     make -j`nproc`
72 72
     sudo make install

+ 3 - 3
doc/manual/requirements.md

@@ -4,7 +4,7 @@
4 4
 
5 5
 ### Supported Unix distributions by this guide
6 6
 
7
-- Ubuntu (14.04 and 12.04)
7
+- Ubuntu (16.04, 14.04 and 12.04)
8 8
 - Debian (Jessie and Wheezy)
9 9
 
10 10
 ### Unsupported Unix distributions
@@ -27,7 +27,7 @@ Please consider using a virtual machine to run Huginn on Windows.
27 27
 
28 28
 ## Ruby versions
29 29
 
30
-Huginn requires Ruby (MRI) 2.0, 2.1 or 2.2
30
+Huginn requires Ruby (MRI) 2.2 or 2.3.
31 31
 You will have to use the standard MRI implementation of Ruby.
32 32
 We love [JRuby](http://jruby.org/) and [Rubinius](http://rubini.us/) but Huginn needs several Gems that have native extensions.
33 33
 
@@ -65,4 +65,4 @@ A DelayedJob worker is a separate process which runs your Huginn Agents. It fetc
65 65
 
66 66
 Estimating the amount of workers needed is easy. One worker can perform just one check at a time.  
67 67
 If you have 60 Agents checking websites every minute which take about 1 second to respond, one worker is fine.  
68
-If you need more Agents or are dealing with slow/unreliable websites/services, you should consider running additional workers.
68
+If you need more Agents or are dealing with slow/unreliable websites/services, you should consider running additional workers.