stickler 2.2.4 → 2.3.0

data/lib/stickler/server/public/css/style.css

@@ -0,0 +1,19 @@
+body { background-color: #fcfcfc}
+.container { background-color: #ffffff; border-left: 2px solid #e9e9e9; border-right: 2px solid #e9e9e9; }
+header h1 { font-weight: bold; text-align: center; color: #A11A00; padding: 1em; }
+header samp { text-align: center; padding: 1em; }
+
+nav { background-color: #ededed; border-top: 2px solid #ddd; border-bottom: 2px solid #ddd;}
+nav  ol { text-align: center; margin-bottom: 0; list-style: none;}
+nav ol li { display: inline-block; padding: 0px 3px 0px 3px; }
+nav ol li a { text-decoration: none; color: #393939;}
+nav ol li a:hover { font-weight: bold; background-color: #fff;  color: #333333; }
+
+.gemlist ol { list-style: none; }
+.gemlist li.stripe { background-color: #e9e9e9; }
+.gem          { padding: 10px; border-bottom: 2px solid #ddd; }
+.gem .name    { text-align: left; vertical-align: top; display: inline-block; width: 50%; letter-spacing: 0.2em; font-weight: 900;}
+.gem .version { text-align: right; vertical-align: top; display: inline-block; width: 49%; color: #939393;}
+
+.letter-start a { text-decoration: none; }
+.letter-start h2 { font-weight: 900; color: #A11A00; text-align: center; }

data/man/stickler-passenger-config.1

@@ -0,0 +1,83 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "STICKLER\-PASSENGER\-CONFIG" "1" "March 2013" "" ""
+.
+.SH "NAME"
+stickler\-passenger\-config \- output a Phusion Passenger config for stickler
+.
+.SH "SYNOPSIS"
+\fIstickler\-passenger\-config\fR [\-\-help] [COMMAND] [COMMAND_OPTIONS] /path/to/stickler/root
+.
+.SH "DESCRIPTION"
+\fIstickler\-passenger\-config\fR will create a stickler web application directory, including the config\.ru file for use with Phusion Passenger \fIhttp://modrails\.com/\fR\. It will then output the stanza to be incorporated into an Apache \fIhttp://httpd\.apache\.org/\fR or Nginx \fIhttp://nginx\.net\fR configuration\.
+.
+.SH "COMMANDS"
+\fIapache2\fR: Output an Apache config\.
+.
+.P
+\fInginx\fR: Output an Nginx config\.
+.
+.SH "OPTIONS"
+\fI\-h, \-\-help\fR:
+.
+.IP "" 4
+.
+.nf
+
+Show the help message
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fI\-v, \-\-version\fR:
+.
+.IP "" 4
+.
+.nf
+
+Output the version\.
+.
+.fi
+.
+.IP "" 0
+.
+.SH "EXAMPLES"
+Output a passenger config for use with apache\.
+.
+.IP "" 4
+.
+.nf
+
+stickler\-passenger\-config apache2 /var/lib/stickler
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Output a pasenger a config to be integrated with an nginx config\.
+.
+.IP "" 4
+.
+.nf
+
+stickler\-passenger\-config nginx /var/lib/stickler
+.
+.fi
+.
+.IP "" 0
+.
+.SH "SEE ALSO"
+stickler(1), stickler\-server(1)
+.
+.SH "AUTHOR"
+Written by Jeremy Hinegardner \fIjeremy@copiousfreetime\.org\fR
+.
+.SH "RESOURCES"
+GitHub project \fIhttps://www\.github\.com/copiousfreetime/stickler\fR
+.
+.SH "BUGS"
+Please report bugs to the github issue tracker \fIhttps://github\.com/copiousfreetime/stickler/issues\fR

data/man/stickler-passenger-config.1.ronn

@@ -0,0 +1,70 @@
+STICKLER-PASSENGER-CONFIG(1)
+============================
+
+NAME
+----
+stickler-passenger-config - output a Phusion Passenger config for stickler
+
+
+SYNOPSIS
+--------
+*stickler-passenger-config* [--help] [COMMAND] [COMMAND_OPTIONS] /path/to/stickler/root
+
+
+DESCRIPTION
+-----------
+*stickler-passenger-config* will create a stickler web application directory,
+including the config.ru file for use with [Phusion Passenger](http://modrails.com/).
+It will then output the stanza to be incorporated into an
+[Apache](http://httpd.apache.org/) or [Nginx](http://nginx.net)
+configuration.
+
+
+COMMANDS
+--------
+
+*apache2*: Output an Apache config.
+
+*nginx*: Output an Nginx config.
+
+
+OPTIONS
+-------
+*-h, --help*:
+    Show the help message
+
+*-v, --version*:
+    Output the version.
+
+
+EXAMPLES
+--------
+Output a passenger config for use with apache.
+
+    stickler-passenger-config apache2 /var/lib/stickler
+
+
+Output a pasenger a config to be integrated with an nginx config.
+
+    stickler-passenger-config nginx /var/lib/stickler
+
+
+SEE ALSO
+--------
+stickler(1), stickler-server(1)
+
+
+AUTHOR
+------
+Written by Jeremy Hinegardner <jeremy@copiousfreetime.org>
+
+
+RESOURCES
+---------
+[GitHub project](https://www.github.com/copiousfreetime/stickler)
+
+
+BUGS
+----
+Please report bugs to the [github issue tracker](https://github.com/copiousfreetime/stickler/issues)
+

data/man/stickler-server.1

@@ -0,0 +1,168 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "STICKLER\-SERVER" "1" "March 2013" "" ""
+.
+.SH "NAME"
+stickler\-server \- start and stop the stickler server process
+.
+.SH "SYNOPSIS"
+\fIstickler\-server\fR [\-\-help] [COMMAND] [COMMAND_OPTIONS] /path/to/stickler/root
+.
+.SH "DESCRIPTION"
+stickler\-server is the daemon process that houses the repositories of proprietary gems and/or mirrors of third party gems\.
+.
+.SH "COMMANDS"
+\fIstart\fR:
+.
+.IP "" 4
+.
+.nf
+
+Start the stickler server process
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fIstop\fR:
+.
+.IP "" 4
+.
+.nf
+
+Stop the stickler server process
+.
+.fi
+.
+.IP "" 0
+.
+.SH "OPTIONS"
+\fI\-d, \-\-daemonize\fR:
+.
+.IP "" 4
+.
+.nf
+
+Daemonize the server
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fI\-\-help\fR:
+.
+.IP "" 4
+.
+.nf
+
+Show the help message
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fI\-h, \-\-host\fR=\'HOST\':
+.
+.IP "" 4
+.
+.nf
+
+The host address to bind to (default: 0\.0\.0\.0)
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fI\-o, \-\-port\fR=\'PORT\':
+.
+.IP "" 4
+.
+.nf
+
+The port to bind to (default: 6789)
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fI\-p, \-\-pid\fR=\'PID_FILE\':
+.
+.IP "" 4
+.
+.nf
+
+Path to wriate a pid file to after daemonizing
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fI\-s, \-\-server\fR=\'SERVER\':
+.
+.IP "" 4
+.
+.nf
+
+The rack handler to use: thin, mongrel, webrick, etc\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fI\-v, \-\-version\fR:
+.
+.IP "" 4
+.
+.nf
+
+Output the version\.
+.
+.fi
+.
+.IP "" 0
+.
+.SH "EXAMPLES"
+Start the server, daemonized, using /var/lib/stickler as the root directory of all the repositories\.
+.
+.IP "" 4
+.
+.nf
+
+stickler\-server start \-\-daemonize /var/lib/stickler
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Stop the server that is using /var/lib/stickler as its root directory\.
+.
+.IP "" 4
+.
+.nf
+
+stickler\-server stop /var/lib/stickler
+.
+.fi
+.
+.IP "" 0
+.
+.SH "SEE ALSO"
+stickler(1), stickler\-passenger\-config(1)
+.
+.SH "AUTHOR"
+Written by Jeremy Hinegardner \fIjeremy@copiousfreetime\.org\fR
+.
+.SH "RESOURCES"
+GitHub project \fIhttps://www\.github\.com/copiousfreetime/stickler\fR
+.
+.SH "BUGS"
+Please report bugs to the github issue tracker \fIhttps://github\.com/copiousfreetime/stickler/issues\fR

data/man/stickler-server.1.ronn

@@ -0,0 +1,84 @@
+STICKLER-SERVER(1)
+==================
+
+NAME
+----
+stickler-server - start and stop the stickler server process
+
+
+SYNOPSIS
+--------
+*stickler-server* [--help] [COMMAND] [COMMAND_OPTIONS] /path/to/stickler/root
+
+
+DESCRIPTION
+-----------
+stickler-server is the daemon process that houses the repositories of
+proprietary gems and/or mirrors of third party gems.
+
+
+COMMANDS
+--------
+*start*:
+    Start the stickler server process
+
+*stop*:
+    Stop the stickler server process
+
+
+OPTIONS
+-------
+*-d, --daemonize*:
+    Daemonize the server
+
+*--help*:
+    Show the help message
+
+*-h, --host*='HOST':
+    The host address to bind to (default: 0.0.0.0)
+
+*-o, --port*='PORT':
+    The port to bind to (default: 6789)
+
+*-p, --pid*='PID_FILE':
+    Path to wriate a pid file to after daemonizing
+
+*-s, --server*='SERVER':
+    The rack handler to use: thin, mongrel, webrick, etc.
+
+*-v, --version*:
+    Output the version.
+
+
+EXAMPLES
+--------
+Start the server, daemonized, using /var/lib/stickler as the root directory of
+all the repositories.
+
+    stickler-server start --daemonize /var/lib/stickler
+
+Stop the server that is using /var/lib/stickler as its root directory.
+
+    stickler-server stop /var/lib/stickler
+
+
+SEE ALSO
+--------
+stickler(1), stickler-passenger-config(1)
+
+
+AUTHOR
+------
+Written by Jeremy Hinegardner <jeremy@copiousfreetime.org>
+
+
+RESOURCES
+---------
+[GitHub project](https://www.github.com/copiousfreetime/stickler)
+
+
+BUGS
+----
+Please report bugs to the [github issue
+tracker](https://github.com/copiousfreetime/stickler/issues)
+

data/man/stickler.1

@@ -0,0 +1,321 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "STICKLER" "1" "March 2013" "" ""
+.
+.SH "NAME"
+stickler \- command line program to interact with a stickler\-server
+.
+.SH "SYNOPSIS"
+\fIstickler\fR [\-\-help] [COMMAND] [COMMAND_OPTIONS] [gemfile(s)]
+.
+.SH "DESCRIPTION"
+Stickler is a tool to organize and maintain an internal gem repository of proprietary gems and/or a mirror of third party gems\.
+.
+.P
+The stickler(1) command interacts with an instance of stickler\-server(1) to control the publishing and mirroring of ruby gems\.
+.
+.SH "COMMANDS"
+\fIpush\fR:
+.
+.IP "" 4
+.
+.nf
+
+Push one or more gems to a gemserver\.  This works the same as `gem push`
+although there is no authorization mechanism\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fIyank\fR:
+.
+.IP "" 4
+.
+.nf
+
+Remove a gem from the gemserver\'s index\.  It will still be available from
+direct download\.  This works the same as `gem yank`\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fImirror\fR:
+.
+.IP "" 4
+.
+.nf
+
+Pull a specific version of a gem from an upstream gem server and
+store it in a stickler\-server(1)\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fIconfig\fR:
+.
+.IP "" 4
+.
+.nf
+
+Access or update the stickler client configuration\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fIlist\fR:
+.
+.IP "" 4
+.
+.nf
+
+List all the gems in the remote repository\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fIunyank\fR:
+.
+.IP "" 4
+.
+.nf
+
+Put a gem that was _yanked_ back into the gemserver index\. This reverses a
+`yank`\.
+.
+.fi
+.
+.IP "" 0
+.
+.SH "OPTIONS"
+These are the options for all commands\. Not all options apply to all commands\.
+.
+.P
+\fI\-a, \-\-add\fR:
+.
+.IP "" 4
+.
+.nf
+
+Add the `\-\-server` or `\-\-upstream` items to the config file when using the
+`config` command\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fI\-d, \-\-debug\fR:
+.
+.IP "" 4
+.
+.nf
+
+Output debug information
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fI\-g, \-\-gem\-version\fR=\'VERSION\':
+.
+.IP "" 4
+.
+.nf
+
+The version of the gem to yank from `\-\-server` or to mirror from
+`\-\-upstream`\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fI\-h, \-\-help\fR:
+.
+.IP "" 4
+.
+.nf
+
+Show the help message
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fI\-l, \-\-list\fR:
+.
+.IP "" 4
+.
+.nf
+
+Display the current configuration when using the `config` command\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fI\-p, \-\-platform\fR=\'PLATFORM\':
+.
+.IP "" 4
+.
+.nf
+
+The platform of the gem to yank from `\-\-server` or to mirror from
+`\-\-upstream` (e\.g\.  ruby, java, mswin32)
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fI\-s, \-\-server\fR=\'SERVER\':
+.
+.IP "" 4
+.
+.nf
+
+The gem server or stickler\-server(1) URL\.  This is used by all the commands\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fI\-u, \-\-upstream\fR=\'SERVER\':
+.
+.IP "" 4
+.
+.nf
+
+The upstream server from which to mirror a gem when using the `mirror`
+command\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fI\-v, \-\-version\fR:
+.
+.IP "" 4
+.
+.nf
+
+Output the version\.
+.
+.fi
+.
+.IP "" 0
+.
+.SH "CONFIGURATION"
+Stickler uses the \fB\.gem/stickler\fR file to hold its configuration\. It is a yaml file and Currently there are two options\. These are altered using the \fBstickler config\fR command\.
+.
+.P
+\fIupstream\fR: The default upstream server from which to mirror gems\. \fIserver\fR: The default linkstick:stickler\-server[1] to interact with\.
+.
+.P
+An example config file
+.
+.IP "" 4
+.
+.nf
+
+\-\-\-
+:server: http://stickler\.example\.com
+:upstream: https://rubygems\.org
+.
+.fi
+.
+.IP "" 0
+.
+.SH "EXAMPLES"
+Push the local \fBmy_gem\-1\.0\.0\.gem\fR file to the stickler\-server(1) at \fIstickler\.example\.com\fR
+.
+.IP "" 4
+.
+.nf
+
+stickler push \./my_gem\-1\.0\.0\.gem \-\-server http://stickler\.example\.com/
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Push all the gems in the \fBpkg\fR directory to the stickler\-server(1) at \fIstickler\.example\.com\fR
+.
+.IP "" 4
+.
+.nf
+
+stickler push \-\-server http://stickler\.example\.com/ \./pkg/*\.gem
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Yank vesion 1\.0\.0 of my_gem from the gem index on sticker\.example\.com
+.
+.IP "" 4
+.
+.nf
+
+stickler yank my_gem \-\-version 1\.0\.0 \-\-server http://stickler\.example\.com/
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Take the +third_party+ gem, version +1\.4\.2+ that is on \fIrubygems\.org\fR and mirror it on \fIstickler\.example\.com\fR
+.
+.IP "" 4
+.
+.nf
+
+stickler mirror third_party_gem \-\-gem\-version 0\.4\.2 \-\-upstream http://rubygems\.org/ \-\-server http://stickler\.example\.com/
+stickler mirror \-\-help
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Set the \fBserver\fR and \fBupstream\fR configration values in the \fB\.gem/stickler\fR file\.
+.
+.IP "" 4
+.
+.nf
+
+stickler config \-\-add \-\-server http://stickler\.example\.com \-\-upstream http://rubygems\.org/
+.
+.fi
+.
+.IP "" 0
+.
+.SH "SEE ALSO"
+stickler\-server(1), stickler\-passenger\-config(1)
+.
+.SH "AUTHOR"
+Written by Jeremy Hinegardner \fIjeremy@copiousfreetime\.org\fR
+.
+.SH "RESOURCES"
+GitHub project \fIhttps://www\.github\.com/copiousfreetime/stickler\fR
+.
+.SH "BUGS"
+Please report bugs to the github issue tracker \fIhttps://github\.com/copiousfreetime/stickler/issues\fR