vlad_freebsd 1.0.0 → 1.0.1

data/History.txt

@@ -4,3 +4,6 @@
 
   * Birthday!
 
+=== 1.0.1 / 2010-04-27
+
+* Rdoc & README

data/README.txt

@@ -1,30 +1,36 @@
 = vlad_freebsd
 
-* FIX (url)
+* http://www.bitbucket.org/mml/vlad_freebsd
 
 == DESCRIPTION:
 
-FIX (describe your package)
+A few simple functions to ease provisioning FreeBSD systems.
 
 == FEATURES/PROBLEMS:
 
-* FIX (list of features or problems)
+* Create users
+* Update ports tree
+* Install ports with custom flags.
 
 == SYNOPSIS:
 
-  FIX (code sample of usage)
+Simply
+  
+  require 'vlad/freebsd' in your rakefile to gain access to the functions.
 
 == REQUIREMENTS:
 
-* FIX (list of requirements)
+* portupgrade package
+* sudo
+* a login with sudo access on the FreeBSD system
 
 == INSTALL:
 
-* FIX (sudo gem install, anything else)
+* gem install vlad_freebsd
 
 == DEVELOPERS:
 
-After checking out the source, run:
+See rdoc for more information on available functions
 
   $ rake newb
 
@@ -35,7 +41,7 @@ and generate the RDoc.
 
 (The MIT License)
 
-Copyright (c) 2010 FIX
+Copyright (c) 2010 McClain Looney
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/vlad/freebsd.rb

@@ -1,15 +1,37 @@
+#This file defines a number of methods for manipulating a FreeBSD system. Simply require this file into your vlad rakefile.
+#
+#Some examples:
+#
+#  remote_task :on_app, :roles => :app do
+#    pass_ruby = "/usr/local/bin/ruby"
+#    put_template 'etc/nginx.conf.erb', '/usr/local/etc/nginx/nginx.conf', binding 
+#    install_port "devel/ruby-gems"
+#    install_port "www/nginx" do |cmdar|
+#      cmdar.last << "-M 'WITH_HTTP_UPLOAD_PROGRESS=1 WITH_HTTP_UPLOAD_MODULE=1 WITH_PASSENGER_MODULE=1'" 
+#    end 
+#    install_port "databases/postgresql84-client" do |cmdar|
+#      cmdar.last << "-M 'WITHOUT_NLS=1 WITHOUT_XML=1 WITHOUT_LDAP=1 WITH_TZDATA=1 WITH_INTDATE=1'"
+#    end 
+#  end 
+
+# Uploads file as a public key
+# [user] username
+# [keyfile] keyfile to upload (.ssh/id_dsa.pub is a popular choice)
 def upload_pubkey(user, keyfile)
   run sudo "mkdir -pvm 755 ~#{user}/.ssh"
-  put_template keyfile, '.ssh/authorized_keys', binding 
-  run "chown #{user}:#{user} ~#{user}/.authorized_keys"
+  put_template keyfile, '~/#{user}/.ssh/authorized_keys', binding 
+  run "chown #{user}:#{user} ~#{user}/.ssh/.authorized_keys"
 end
 
+# Updates ports, uses portsnap update.
 def update_ports
   sudo "portsnap update"
 end
 
-#this is a driver for the pw command. pass arguments in as a hash of k-v. simple flags map to nil.
-#will only add a user if it doesn't exist
+# This is a driver for the pw command. pass arguments in as a hash of k-v. simple flags map to nil.
+# will only add a user if it doesn't exist
+# You can pass arbitrary arguments to pw using the args hash in the form:
+# {'-flag'=>'value'}. See the pw man page for extensive documentation.
 def adduser(username, args={})
   args = { '-s' => '/usr/local/bin/bash', "-c"=>"'service user'", "-n"=>username, "-m"=>nil, '-w'=>'no'}.merge(args)
   slug = "if [ $(id -u sophia > /dev/null) ];then \n"
@@ -22,7 +44,9 @@ def adduser(username, args={})
   sudo slug
 end
 
-
+# Installs a port. Uses the portinstall command in --batch mode.  Note that if a block is passed, an array is yielded
+# allowing the caller to manipulate the actually executed command; handy for setting make args and the like. See
+# portinstall manpage for extensive documentation.
 def install_port(port)
   commands = []
   commands << "portinstall --batch  #{port} "
@@ -32,6 +56,12 @@ def install_port(port)
   commands.each {|x| sudo x}
 end
 
+# Upload a file and copy it into a final location. Uses sudo to copy after uploading. Templating
+# is done via ERB, the user passes in the desired binding.
+#
+# [tmpl] template file
+# [dest] destination path
+# [b] binding
 def put_template(tmpl, dest, b)
   tmpl = File.read(tmpl)
   buf = ERB.new(tmpl).result(b)

data/lib/vlad_freebsd.rb

@@ -1,5 +1,5 @@
 puts "executing #{__FILE__}"
 require 'vlad/freebsd'
 class Vlad::Freebsd
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: vlad_freebsd
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - McClain Looney
@@ -42,7 +42,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 2.5.0
     version: 
-description: FIX (describe your package)
+description: A few simple functions to ease provisioning FreeBSD systems.
 email: 
 - m@loonsoft.com
 executables: []
@@ -85,6 +85,6 @@ rubyforge_project: vlad_freebsd
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: FIX (describe your package)
+summary: A few simple functions to ease provisioning FreeBSD systems.
 test_files: []