You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@wookie.apache.org by bu...@apache.org on 2012/04/25 21:08:57 UTC
svn commit: r814470 - in /websites/staging/wookie/trunk/content: ./ wookie/docs/developer/release-configuration.html

Author: buildbot
Date: Wed Apr 25 19:08:57 2012
New Revision: 814470

Log:
Staging update by buildbot for wookie

Added:
    websites/staging/wookie/trunk/content/wookie/docs/developer/release-configuration.html
Modified:
    websites/staging/wookie/trunk/content/   (props changed)

Propchange: websites/staging/wookie/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Wed Apr 25 19:08:57 2012
@@ -1 +1 @@
-1330487
+1330490

Added: websites/staging/wookie/trunk/content/wookie/docs/developer/release-configuration.html
==============================================================================
--- websites/staging/wookie/trunk/content/wookie/docs/developer/release-configuration.html (added)
+++ websites/staging/wookie/trunk/content/wookie/docs/developer/release-configuration.html Wed Apr 25 19:08:57 2012
@@ -0,0 +1,205 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+    Licensed to the Apache Software Foundation (ASF) under one or more
+    contributor license agreements.  See the NOTICE file distributed with
+    this work for additional information regarding copyright ownership.
+    The ASF licenses this file to You under the Apache License, Version 2.0
+    (the "License"); you may not use this file except in compliance with
+    the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE- 2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+-->
+
+  <link href="/wookie/css/wookie.css" rel="stylesheet" type="text/css">
+  <link href="/wookie/css/code.css" rel="stylesheet" type="text/css">
+  <title>Apache Wookie (Incubating) - Release Configuration</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+</head>
+
+<body>
+  <div id="banner">
+    <img alt="Apache Wookie (Incubating)" src="/wookie/images/logo.png"/>
+    <h1 class="title">Release Configuration</h1>
+  </div>
+  
+  <div id="navigation">
+  <h1 id="general">General</h1>
+<ul>
+<li><a href="/wookie/index.html">Home</a></li>
+<li><a href="/wookie/news.html">News</a></li>
+<li><a href="/wookie/docs/download.html">Download</a></li>
+<li><a href="http://incubator.apache.org/projects/wookie.html">Incubator page</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</a></li>
+</ul>
+<h1 id="documentation">Documentation</h1>
+<ul>
+<li><a href="/wookie/docs/download.html">Download and Quickstart</a></li>
+<li><a href="/wookie/docs/admin.html">Server Admin</a></li>
+<li><a href="/wookie/docs/embedding.html">Embedding</a></li>
+<li><a href="/wookie/docs/shindig.html">Integrating with Shindig</a></li>
+<li><a href="/wookie/docs/widgets.html">Building widgets</a></li>
+<li><a href="/wookie/docs/faq.html">FAQ</a></li>
+<li><a href="/wookie/docs/api.html">API Reference</a></li>
+</ul>
+<h1 id="community">Community</h1>
+<ul>
+<li><a href="/wookie/get-involved.html">Get Involved</a></li>
+<li><a href="/wookie/mailing-lists.html">Mailing Lists</a></li>
+<li><a href="/wookie/people.html">People</a></li>
+</ul>
+<h1 id="development">Development</h1>
+<ul>
+<li><a href="/wookie/docs/source.html">Getting Started</a></li>
+<li><a href="/wookie/docs/developer/running.html">Running</a></li>
+<li><a href="/wookie/docs/templates.html">Widget Templates</a></li>
+<li><a href="/wookie/docs/developer/features.html">Extension Features</a></li>
+<li><a href="/wookie/docs/developer/widgets.html">Deploying Widgets</a></li>
+<li><a href="/wookie/docs/develop.html">Environment</a></li>
+<li><a href="/wookie/docs/developer/release-management.html">Release Management</a></li>
+<li><a href="/wookie/docs/developer/issues.html">Issue Tracker</a></li>
+<li><a href="/wookie/docs/developer/index.html">Management</a></li>
+<li><a href="/wookie/docs/developer/parser.html">W3C Widget Parser</a></li>
+</ul>
+<h1 id="asf">ASF</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+  </div>
+
+  <div id="content">
+    <h1 id="release-configuration-and-setup">Release configuration and setup</h1>
+<p>These setup steps only need to be performed on a particular machine once.</p>
+<p>Developers using Linux workstations can skip over the references to Cygwin. If using Windows, install cygwin, including Utils/gnupg and Net/openssh packages.</p>
+<h2 id="create-and-install-a-ssh-key">Create and install a SSH key</h2>
+<div class="codehilite"><pre><span class="n">Open</span> <span class="n">a</span> <span class="n">shell</span> <span class="n">window</span><span class="o">.</span> <span class="n">If</span> <span class="n">using</span> <span class="n">Windows</span><span class="p">,</span> <span class="nb">open</span> <span class="n">a</span> <span class="n">cygwin</span> <span class="n">window</span><span class="o">.</span>
+<span class="n">Use</span> <span class="n">ssh</span><span class="o">-</span><span class="n">keygen</span> <span class="n">to</span> <span class="n">create</span> <span class="n">an</span> <span class="n">SSH</span> <span class="n">key</span><span class="o">.</span>
+</pre></div>
+
+
+<p>Follow the latest steps and guides on the <a href="http://www.apache.org/dev/openpgp.html#generate-key">ASF website</a> as you should NOT be using SHA1 and new keys MUST be at least 4096 bits.</p>
+<div class="codehilite"><pre>     <span class="nv">$</span> <span class="nv">ssh</span><span class="o">-</span><span class="n">keygen</span> <span class="o">-</span><span class="n">t</span> <span class="n">rsa</span> <span class="o">-</span><span class="n">b</span> <span class="mi">4096</span>
+</pre></div>
+
+
+<p>Program defaults should be fine. No passphrase is required for the ssh key generation. The keys will be saved in ~/.ssh/id_dsa (private) and ~/.ssh/id_dsa.pub (public).</p>
+<p>See <a href="http://www.networknewz.com/networknewz-10-20030707AuthenticatingbyPublicKeyOpenSSH.html">Authenticating By Public Key (OpenSSH)</a> for a good description on why and how to perform this task.</p>
+<ol>
+<li>
+<p>SCP your SSH public key ~/.ssh/id_dsa.pub created in last step to ~/id_dsa.pub on people.apache.org.</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">cd</span> <span class="o">~/.</span><span class="n">ssh</span>
+<span class="nv">$</span> <span class="nv">scp</span> <span class="n">id_dsa</span><span class="o">.</span><span class="n">pub</span> <span class="nv">@people</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org:id_dsa</span><span class="o">.</span><span class="n">pub</span>
+<span class="nv">$</span> <span class="nv">You</span> <span class="n">will</span> <span class="n">be</span> <span class="n">prompted</span> <span class="k">for</span> <span class="n">your</span> <span class="n">password</span><span class="o">.</span>
+</pre></div>
+
+
+</li>
+<li>
+<p>Use ssh to login to people.apache.org</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">cd</span> <span class="o">~</span>
+<span class="nv">$</span> <span class="nv">ssh</span> <span class="nv">@people</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span>
+</pre></div>
+
+
+</li>
+</ol>
+<p>At this point, you will still be prompted for your password.</p>
+<ol>
+<li>
+<p>Create a ~/.ssh folder in your home directory on people.apache.org and change its file mode to 700.</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">mkdir</span> <span class="o">~/.</span><span class="n">ssh</span>
+<span class="nv">$</span> <span class="nv">chmod</span> <span class="mi">700</span> <span class="o">~/.</span><span class="n">ssh</span>
+</pre></div>
+
+
+</li>
+<li>
+<p>Move or append ~/id_dsa.pub to ~/.ssh/authorized_keys and change its file mode to 600.</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">mv</span> <span class="o">~</span><span class="sr">/id_dsa.pub ~/</span><span class="o">.</span><span class="n">ssh</span><span class="o">/</span><span class="n">authorized_keys</span> 
+<span class="nv">$</span> <span class="nv">chmod</span> <span class="mi">600</span> <span class="o">~</span><span class="sr">/.ssh/</span><span class="n">authorized_keys</span>
+</pre></div>
+
+
+</li>
+</ol>
+<p><em>Each public key in the authorized_keys spans only one line.
+        For example: "ssh-dss AAAAB3NzaC1kc3MAAA ..... agBmmfZ9uAbSqA== dsa-key-20071107"
+        '#' in the first column is a comment line.</em></p>
+<ol>
+<li>
+<p>Exit out of this ssh session.</p>
+</li>
+<li>
+<p>Start a new ssh session. No login should be required this time due to the private ssh key on your local box matching up with the public ssh key in your home directory (~/.ssh).</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">ssh</span> <span class="nv">@people</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span>
+</pre></div>
+
+
+<p>If you are still prompted for a password, then you have not set up the ssh keys properly. Review the steps above and ensure that all of the steps were followed properly. Or, maybe the instructions are still not quite right and they still need some adjusting. In that case, please update the instructions accordingly.</p>
+</li>
+</ol>
+<p>You can alternatively use putty to create and install your ssh key.  The instructions <a href="http://people.apache.org/~gmcdonald/ssh_putty.html">here</a> outline the process.</p>
+<h2 id="create-a-gpg-key">Create a GPG key</h2>
+<p>Apache recommend using GNU Privacy Guard to generate keys and sign artifacts.</p>
+<ol>
+<li>
+<p>Open a shell window. If using Windows, open a cygwin window.</p>
+</li>
+<li>
+<p>Generate a key-pair with gpg, using default key kind ("RSA and RSA") and keys size (4096).</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">gpg</span> <span class="o">--</span><span class="n">gen</span><span class="o">-</span><span class="n">key</span>
+</pre></div>
+
+
+<p>The program's default values should be fine. For the "Real Name" enter your full name (ie. Stan Programmer). For the "e-mail address" enter your apache address (ie. sprogrammer@apache.org). You will also be required to enter a "passphrase" for the GPG key generation. Keep track of this as you will need this for the Release processing.</p>
+</li>
+<li>
+<p>The generated keys are stored in $HOME/.gnupg or %HOME%\Application Data\gnupg subdirectory.</p>
+</li>
+<li>
+<p>Save the content in this subdirectory to a safe media. This contains your private key used to sign all the Wookie release materials.</p>
+</li>
+<li>
+<p>Backup your home directory to another media ||</p>
+</li>
+<li>
+<p>Add your public key to the <a href="https://svn.apache.org/repos/asf/incubator/wookie/KEYS">SVN repository</a>. See the commands describe at the beginning of this KEYS file to perform this task. The gpg key-pair is used to sign the published artifacts for the Wookie releases.</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">gpg</span> <span class="o">--</span><span class="n">list</span><span class="o">-</span><span class="n">sigs</span> <span class="o">&amp;&amp;</span> <span class="n">gpg</span> <span class="o">--</span><span class="n">armor</span> <span class="o">--</span> <span class="n">export</span>
+</pre></div>
+
+
+<p>The <a href="https://svn.apache.org/repos/asf/incubator/wookie/KEYS">KEYS</a> file is updated via normal svn commit procedures.</p>
+</li>
+<li>
+<p>Submit your public key to a key server. E.g. <a href="http://pgp.mit.edu/">MIT</a></p>
+</li>
+<li>
+<p>Following the instructions in http://people.apache.org/~henkp/trust/ and ask multiple (at least 3) current Apache committers to sign your public key.</p>
+</li>
+</ol>
+  </div>
+
+  <div id="footer">
+    <div class="copyright">
+      <p>
+        Copyright &copy; 2011-2012 The Apache Software Foundation, Licensed under
+        the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+        <br />
+        Apache and the Apache feather logos are trademarks of The Apache Software Foundation.
+      </p>
+    </div>
+  </div>
+
+</body>
+</html>