Merge lp:~themue/juju-core/docs-003-config-local-firewall-note into lp:juju-core/docs

[Frank Mueller]

config-local: added a note regarding ufw (conflicts with juju local)

[Dave Cheney (dave-cheney)]

review: Approve (lgtm)

=== modified file 'htmldocs/config-local.html'
--- htmldocs/config-local.html	2013-09-05 12:01:47 +0000
+++ htmldocs/config-local.html	2013-09-05 12:17:36 +0000
@@ -57,57 +57,61 @@
           <article>
             <section id="config_local">
             <h1>Configuring for Local Provider</h1>
+
             <h2>Prerequisites</h2>
             <p>The local provider enables you to run Juju on a single system like your local computer or a single server. This way you can simply evaluate the software or service configurations, develop your own charms or run a single server system.</p> 
             <p>To do this, Juju uses the <strong>LXC Linux Container</strong>, which can be installed on your computer with the command:</p>
-<pre class="prettyprint lang-yaml">
+<pre class="prettyprint lang-bash">
 sudo apt-get install lxc
 </pre>
             <p>Additionally the local provider needs <strong>MongoDB</strong> to be installed. This is done with the command:</p> 
-<pre class="prettyprint lang-yaml">
-            sudo apt-get install mongodb-server
+<pre class="prettyprint lang-bash">
+sudo apt-get install mongodb-server
 </pre>
             <p>In case of <strong>precise</strong> or <strong>quantal</strong> versions of Ubuntu, MongoDB has to be installed from a different repository. So in this case call</p>
-<pre class="prettyprint lang-yaml">
-            sudo apt-add-repository ppa:juju/stable
-            sudo apt-get update
+<pre class="prettyprint lang-bash">
+sudo apt-add-repository ppa:juju/stable
+sudo apt-get update
 </pre>
             <p>beforehand. In case you're not sure take a look into the file <code>/etc/lsb-release</code> which identifies the series with the variable <code>DISTRIB_CODENAME</code>. If you're not running Ubuntu please consult your operating system distribution's documentation for instructions on installing the LXC userspace tools and the MongoDB server. Juju requires a MongoDB server built with SSL support.</p>
             <p>The dependence on the LXC Linux Container shows that the local provider only runs on Linux systems. All steps above are also printed in case of any unsatisfied prerequisite.</p>
 
             <h2>Configuration</h2>
             <p>You should start by generating a generic configuration file for Juju, using the command:
-<pre class="prettyprint lang-bash">juju generate-config</pre>
+<pre class="prettyprint lang-bash">
+juju init
+</pre>
             <p>This will generate a file, <strong>environments.yaml</strong>, which will live in your <strong>~/.juju/</strong> directory (and will create the directory if it doesn't already exist).
-            <p class ="note"><strong>Note:</strong> If you have an existing configuration, you can use <code>juju generate-config --show</code> to output the new config file, then copy and paste relevant areas in a text editor etc.</p>
+            <p class ="note"><strong>Note:</strong>If you have an existing configuration, you can use <code>juju generate-config --show</code> to output the new config file, then copy and paste relevant areas in a text editor etc.</p>
             <p>The generic configuration sections generated for the local provider will look something like this:</p>
 <pre class="prettyprint lang-yaml">
 ## https://juju.ubuntu.com/get-started/local/
 local:
-type: local
-admin-secret: 772b9471131c6b5883475e3908156d32
-#Override the directory that is used for the storage files and database.
-#The default location is $JUJU_HOME.
-# $JUJU_HOME defaults to ~/.juju
-# root-dir: ~/.juju/local
-# Override the storage port if you have multiple local providers, or if the
-# default port is used by another program.
-# storage-port: 8040
-# Override the shared storage port if you have multiple local providers,
-# or if the default port is used by another program.
-# shared-storage-port: 8041
+    type: local
+    admin-secret: 772b9471131c6b5883475e3908156d32
+    # Override the directory that is used for the storage files and database.
+    # The default location is $JUJU_HOME.
+    # $JUJU_HOME defaults to ~/.juju
+    # root-dir: ~/.juju/local
+    # Override the storage port if you have multiple local providers, or if the
+    # default port is used by another program.
+    # storage-port: 8040
+    # Override the shared storage port if you have multiple local providers,
+    # or if the default port is used by another program.
+    # shared-storage-port: 8041
 </pre>
             <p>Running Juju with this configuration the storage files and the database will be located in the directory specified by the environment variable <strong>$JUJU_HOME</strong>, which defaults to <strong>~/.juju/</strong>. By uncommenting and setting <strong>root-dir</strong> this location can be changed as well as the ports of the storage and the shared storage. This may be useful in the case of multiple parallel running local providers or conflicts with other programs on your system. Also when using encrypted home directories you have to set <strong>$JUJU_HOME</strong> or <strong>root-dir</strong> to point to a location outside your home directory.
 
             <h2>Bootstrapping and Destroying</h2>
             <p>The usage of LXC Linux Containers enforces that bootstrapping and destroying of an environment are done as <strong>root</strong>. All other operations can be executed as non-root. E.g.</p>
-<pre class="prettyprint lang-yaml">
+<pre class="prettyprint lang-bash">
 sudo juju bootstrap
 juju deploy mysql
 ...
 sudo juju destroy-environment
 </pre>
-
+            <p class ="note"><strong>Note:</strong>In case of a running firewall like <strong>ufw</strong> it has
+            to be stopped.</p>
              </section>
           </article>
         </div>