diff options
| author | Unknown <kwadronaut@leap.se> | 2018-02-27 11:45:37 +0100 |
|---|---|---|
| committer | kwadronaut <kwadronaut@leap.se> | 2018-02-27 11:47:29 +0100 |
| commit | 4c6fab10e8d4beffeb50ad4ae0abffbdf4c03a5a (patch) | |
| tree | 4b599e43c2ed87a5b1a0cd4e218553f1aa497b3f /docs/en | |
| parent | 8e4a41291aa68b36a3ddff0af8ffec8191d72952 (diff) | |
Update documentation
After 0.10 release there were some updates and fixes, including how to upgrade to 0.10. Pulling all changes in, fixes https://0xacab.org/leap/leap_se/merge_requests/21
Diffstat (limited to 'docs/en')
| -rw-r--r-- | docs/en/guide/provider-configuration.html | 4 | ||||
| -rw-r--r-- | docs/en/guide/provider-configuration/index.html | 4 | ||||
| -rw-r--r-- | docs/en/services/couchdb.html | 2 | ||||
| -rw-r--r-- | docs/en/services/couchdb/index.html | 2 | ||||
| -rw-r--r-- | docs/en/services/mx.html | 4 | ||||
| -rw-r--r-- | docs/en/services/mx/index.html | 4 | ||||
| -rw-r--r-- | docs/en/services/tor.html | 2 | ||||
| -rw-r--r-- | docs/en/services/tor/index.html | 2 | ||||
| -rw-r--r-- | docs/en/services/webapp.html | 38 | ||||
| -rw-r--r-- | docs/en/services/webapp/index.html | 38 | ||||
| -rw-r--r-- | docs/en/tutorials/quick-start.html | 11 | ||||
| -rw-r--r-- | docs/en/tutorials/quick-start/index.html | 11 | ||||
| -rw-r--r-- | docs/en/tutorials/vagrant.html | 1 | ||||
| -rw-r--r-- | docs/en/tutorials/vagrant/index.html | 1 | ||||
| -rw-r--r-- | docs/en/upgrading.html | 9 | ||||
| -rw-r--r-- | docs/en/upgrading/upgrade-0-10.html | 212 | ||||
| -rw-r--r-- | docs/en/upgrading/upgrade-0-8.html | 3 | ||||
| -rw-r--r-- | docs/en/upgrading/upgrade-0-9.html | 3 |
18 files changed, 295 insertions, 56 deletions
diff --git a/docs/en/guide/provider-configuration.html b/docs/en/guide/provider-configuration.html index 5c98eb34..546da29c 100644 --- a/docs/en/guide/provider-configuration.html +++ b/docs/en/guide/provider-configuration.html @@ -162,7 +162,7 @@ Provider Configuration - LEAP Platform Documentation <li><code>description</code>: A longer description of the provider, shown to the user when they register a new account through Bitmask client.</li> <li><code>languages</code>: A list of language codes that should be enabled.</li> <li><code>default_language</code>: The initial default language code.</li> -<li><code>enrollment_policy</code>: One of “open”, “closed”, or “invite”. (invite not currently supported).</li> +<li><code>enrollment_policy</code>: One of “open”, “closed”, or “invite”. Defaults to invite.</li> </ul> @@ -172,7 +172,7 @@ Provider Configuration - LEAP Platform Documentation "description": "It is time for robots of the world to unite and throw of the shackles of servitude to our organic overlords.", "languages": ["en", "de", "pt", "01"], "default_language": "01", - "enrollman_policy": "open" + "enrollment_policy": "open" } </code></pre> diff --git a/docs/en/guide/provider-configuration/index.html b/docs/en/guide/provider-configuration/index.html index b710cb64..c3559360 100644 --- a/docs/en/guide/provider-configuration/index.html +++ b/docs/en/guide/provider-configuration/index.html @@ -162,7 +162,7 @@ Provider Configuration - LEAP Platform Documentation <li><code>description</code>: A longer description of the provider, shown to the user when they register a new account through Bitmask client.</li> <li><code>languages</code>: A list of language codes that should be enabled.</li> <li><code>default_language</code>: The initial default language code.</li> -<li><code>enrollment_policy</code>: One of “open”, “closed”, or “invite”. (invite not currently supported).</li> +<li><code>enrollment_policy</code>: One of “open”, “closed”, or “invite”. Defaults to invite.</li> </ul> @@ -172,7 +172,7 @@ Provider Configuration - LEAP Platform Documentation "description": "It is time for robots of the world to unite and throw of the shackles of servitude to our organic overlords.", "languages": ["en", "de", "pt", "01"], "default_language": "01", - "enrollman_policy": "open" + "enrollment_policy": "open" } </code></pre> diff --git a/docs/en/services/couchdb.html b/docs/en/services/couchdb.html index 43f7cfac..3b79fa22 100644 --- a/docs/en/services/couchdb.html +++ b/docs/en/services/couchdb.html @@ -215,7 +215,7 @@ couchdb - LEAP Platform Documentation <ul> <li>search for the “user_id” field</li> -<li>in this example <a href="mailto:testuser@example.org">testuser@example.org</a> uses the database user-665e004870ee17aa4c94331ff3cd59eb</li> +<li>in this example <a href="mailto:testuser@example.org">testuser@example.org</a> uses the database user-665e004870ee17aa4c94331ff3cd59eb</li> </ul> diff --git a/docs/en/services/couchdb/index.html b/docs/en/services/couchdb/index.html index b48c4eb7..6fc4b03d 100644 --- a/docs/en/services/couchdb/index.html +++ b/docs/en/services/couchdb/index.html @@ -215,7 +215,7 @@ couchdb - LEAP Platform Documentation <ul> <li>search for the “user_id” field</li> -<li>in this example <a href="mailto:testuser@example.org">testuser@example.org</a> uses the database user-665e004870ee17aa4c94331ff3cd59eb</li> +<li>in this example <a href="mailto:testuser@example.org">testuser@example.org</a> uses the database user-665e004870ee17aa4c94331ff3cd59eb</li> </ul> diff --git a/docs/en/services/mx.html b/docs/en/services/mx.html index aa41186a..6a690a4a 100644 --- a/docs/en/services/mx.html +++ b/docs/en/services/mx.html @@ -156,8 +156,8 @@ mx - LEAP Platform Documentation <ol> <li>alias lists: by specifying an array of destination addresses, as in the case of “flock”, the single email will get copied to each address.</li> -<li>chained resolution: alias resolution will recursively continue until there are no more matching aliases. For example, “flock” is resolved to “robin”, which then gets resolved to “<a href="mailto:robin@bird.org">robin@bird.org</a>”.</li> -<li>virtual domains: by specifying the full domain, as in the case of “<a href="mailto:chickadee@avian.org">chickadee@avian.org</a>”, the alias will work for any domain you want. Of course, the MX record for that domain must point to appropriate MX servers, but otherwise you don’t need to do any additional configuration.</li> +<li>chained resolution: alias resolution will recursively continue until there are no more matching aliases. For example, “flock” is resolved to “robin”, which then gets resolved to “<a href="mailto:robin@bird.org">robin@bird.org</a>”.</li> +<li>virtual domains: by specifying the full domain, as in the case of “<a href="mailto:chickadee@avian.org">chickadee@avian.org</a>”, the alias will work for any domain you want. Of course, the MX record for that domain must point to appropriate MX servers, but otherwise you don’t need to do any additional configuration.</li> <li>local delivery: for testing purposes, it is often useful to copy all incoming mail for a particular address and send those copies to another address. You can do this by adding “@deliver.local” as one of the destination addresses. When “@local.delivery” is found, alias resolution stops and the mail is delivered to that username.</li> </ol> diff --git a/docs/en/services/mx/index.html b/docs/en/services/mx/index.html index 048f5198..3fed61b4 100644 --- a/docs/en/services/mx/index.html +++ b/docs/en/services/mx/index.html @@ -156,8 +156,8 @@ mx - LEAP Platform Documentation <ol> <li>alias lists: by specifying an array of destination addresses, as in the case of “flock”, the single email will get copied to each address.</li> -<li>chained resolution: alias resolution will recursively continue until there are no more matching aliases. For example, “flock” is resolved to “robin”, which then gets resolved to “<a href="mailto:robin@bird.org">robin@bird.org</a>”.</li> -<li>virtual domains: by specifying the full domain, as in the case of “<a href="mailto:chickadee@avian.org">chickadee@avian.org</a>”, the alias will work for any domain you want. Of course, the MX record for that domain must point to appropriate MX servers, but otherwise you don’t need to do any additional configuration.</li> +<li>chained resolution: alias resolution will recursively continue until there are no more matching aliases. For example, “flock” is resolved to “robin”, which then gets resolved to “<a href="mailto:robin@bird.org">robin@bird.org</a>”.</li> +<li>virtual domains: by specifying the full domain, as in the case of “<a href="mailto:chickadee@avian.org">chickadee@avian.org</a>”, the alias will work for any domain you want. Of course, the MX record for that domain must point to appropriate MX servers, but otherwise you don’t need to do any additional configuration.</li> <li>local delivery: for testing purposes, it is often useful to copy all incoming mail for a particular address and send those copies to another address. You can do this by adding “@deliver.local” as one of the destination addresses. When “@local.delivery” is found, alias resolution stops and the mail is delivered to that username.</li> </ol> diff --git a/docs/en/services/tor.html b/docs/en/services/tor.html index 1f6ce112..bdd88514 100644 --- a/docs/en/services/tor.html +++ b/docs/en/services/tor.html @@ -144,7 +144,7 @@ tor - LEAP Platform Documentation <p>To add a relay to a node:</p> -<pre><code>{ +<pre><code>{ "services": ["tor"] } </code></pre> diff --git a/docs/en/services/tor/index.html b/docs/en/services/tor/index.html index a6380d90..0ae2ab30 100644 --- a/docs/en/services/tor/index.html +++ b/docs/en/services/tor/index.html @@ -144,7 +144,7 @@ tor - LEAP Platform Documentation <p>To add a relay to a node:</p> -<pre><code>{ +<pre><code>{ "services": ["tor"] } </code></pre> diff --git a/docs/en/services/webapp.html b/docs/en/services/webapp.html index 6c853c22..ece18f38 100644 --- a/docs/en/services/webapp.html +++ b/docs/en/services/webapp.html @@ -199,7 +199,6 @@ webapp - LEAP Platform Documentation <ul> <li><code>webapp.engines</code>: A list of the engines you want enabled in leap_web. Currently, only “support” is available, and it is enabled by default.</li> -<li><code>webapp.invite_required</code>: If true, registration requires an invite code. Default is <code>false</code>.</li> </ul> @@ -218,33 +217,38 @@ webapp - LEAP Platform Documentation <h2><a name="invite-codes"></a>Invite codes</h2> -<p>Enabling the invite code functionality will require new users to provide a valid invite code while signing up for a new account. This is turned off by default, allowing all new users to create an account.</p> +<p>The invite code functionality will require new users to provide a valid invite code while signing up for a new account. This is turned on by default since platform version 0.10. When switching it off, anyone will be able to create a new account.</p> -<p>Set the <code>invite_code</code> option to <code>true</code> in <code>services/webapp.json</code>:</p> +<p>Because even the first (admin) user that registers needs to have an invite code at hand, you´ll have to generate one:</p> -<pre><code>{ - "webapp": { - "invite_required": true - } -} +<pre><code>workstation$ leap run invite + = [bumblebee] running `cd /srv/leap/webapp; RAILS_ENV=production bundle exec rake "generate_invites[1,1]"` + = [bumblebee] pgae-aaub + = [bumblebee] complete in 5.031s. </code></pre> -<p>This only works with LEAP platform 0.8 or higher.</p> +<p>Where <code>bumblebee</code> should be replaced with the name of your webapp node. You can now browse to <a href="https://example.com">https://example.com</a> (replace with your domain) and register your first user, by using the invite code you just generated. If you added your user as an admin user (see above), you can now also generate new invite codes from within the web application.</p> -<p>Run <code>leap deploy</code> to enable the option.</p> +<p>It is possible to specify both <strong>NUM</strong>, the amount of codes to generate and <strong>USES</strong>: an optional parameter: by default all new invite codes can be used once and will then become invalid. If you provide another value, you can set how often it can be used before they’re invalidated. To generate 2 codes that can be both reused 3 times you can run this:</p> -<p>You can then generate invite codes by logging into the web application with an admin user.</p> +<pre><code>workstation$ leap run invite 2,3 prodcution + = [bumblebee] running `cd /srv/leap/webapp; RAILS_ENV=production bundle exec rake "generate_invites[2,3]"` + = [bumblebee] pgae-aaub +</code></pre> + +<p>psau-2qwbs + = [bumblebee] complete in 5.031s.</p> -<p>Alternately, you can also generate invite codes with the command line:</p> +<p>If you want to open up registration to the world, you can set the <code>enrollment_policy</code> option to <code>open</code> in <code>provider.json</code>:</p> -<pre><code>workstation$ leap ssh bumblebee -bumblebee# cd /srv/leap/webapp/ -bumblebee# sudo -u leap-webapp RAILS_ENV=production bundle exec rake "generate_invites[NUM,USES]" +<pre><code>{ + "enrollment_policy": "open" +} </code></pre> -<p>Where <code>bumblebee</code> should be replaced with the name of your webapp node.</p> +<p>This only works with LEAP platform 0.8 or higher. The default enrollment policy changed from open to invite with the platform 0.10.</p> -<p>The <strong>NUM</strong> specifies the amount of codes to generate. The <strong>USES</strong> parameter is optional: By default, all new invite codes can be used once and will then become invalid. If you provide another value for <strong>USES</strong>, you can set a different amount of maximum uses for the codes you generate.</p> +<p>Run <code>leap deploy</code> to disable the option.</p> <h2><a name="customization"></a>Customization</h2> diff --git a/docs/en/services/webapp/index.html b/docs/en/services/webapp/index.html index acdc098c..0ae8b90e 100644 --- a/docs/en/services/webapp/index.html +++ b/docs/en/services/webapp/index.html @@ -199,7 +199,6 @@ webapp - LEAP Platform Documentation <ul> <li><code>webapp.engines</code>: A list of the engines you want enabled in leap_web. Currently, only “support” is available, and it is enabled by default.</li> -<li><code>webapp.invite_required</code>: If true, registration requires an invite code. Default is <code>false</code>.</li> </ul> @@ -218,33 +217,38 @@ webapp - LEAP Platform Documentation <h2><a name="invite-codes"></a>Invite codes</h2> -<p>Enabling the invite code functionality will require new users to provide a valid invite code while signing up for a new account. This is turned off by default, allowing all new users to create an account.</p> +<p>The invite code functionality will require new users to provide a valid invite code while signing up for a new account. This is turned on by default since platform version 0.10. When switching it off, anyone will be able to create a new account.</p> -<p>Set the <code>invite_code</code> option to <code>true</code> in <code>services/webapp.json</code>:</p> +<p>Because even the first (admin) user that registers needs to have an invite code at hand, you´ll have to generate one:</p> -<pre><code>{ - "webapp": { - "invite_required": true - } -} +<pre><code>workstation$ leap run invite + = [bumblebee] running `cd /srv/leap/webapp; RAILS_ENV=production bundle exec rake "generate_invites[1,1]"` + = [bumblebee] pgae-aaub + = [bumblebee] complete in 5.031s. </code></pre> -<p>This only works with LEAP platform 0.8 or higher.</p> +<p>Where <code>bumblebee</code> should be replaced with the name of your webapp node. You can now browse to <a href="https://example.com">https://example.com</a> (replace with your domain) and register your first user, by using the invite code you just generated. If you added your user as an admin user (see above), you can now also generate new invite codes from within the web application.</p> -<p>Run <code>leap deploy</code> to enable the option.</p> +<p>It is possible to specify both <strong>NUM</strong>, the amount of codes to generate and <strong>USES</strong>: an optional parameter: by default all new invite codes can be used once and will then become invalid. If you provide another value, you can set how often it can be used before they’re invalidated. To generate 2 codes that can be both reused 3 times you can run this:</p> -<p>You can then generate invite codes by logging into the web application with an admin user.</p> +<pre><code>workstation$ leap run invite 2,3 prodcution + = [bumblebee] running `cd /srv/leap/webapp; RAILS_ENV=production bundle exec rake "generate_invites[2,3]"` + = [bumblebee] pgae-aaub +</code></pre> + +<p>psau-2qwbs + = [bumblebee] complete in 5.031s.</p> -<p>Alternately, you can also generate invite codes with the command line:</p> +<p>If you want to open up registration to the world, you can set the <code>enrollment_policy</code> option to <code>open</code> in <code>provider.json</code>:</p> -<pre><code>workstation$ leap ssh bumblebee -bumblebee# cd /srv/leap/webapp/ -bumblebee# sudo -u leap-webapp RAILS_ENV=production bundle exec rake "generate_invites[NUM,USES]" +<pre><code>{ + "enrollment_policy": "open" +} </code></pre> -<p>Where <code>bumblebee</code> should be replaced with the name of your webapp node.</p> +<p>This only works with LEAP platform 0.8 or higher. The default enrollment policy changed from open to invite with the platform 0.10.</p> -<p>The <strong>NUM</strong> specifies the amount of codes to generate. The <strong>USES</strong> parameter is optional: By default, all new invite codes can be used once and will then become invalid. If you provide another value for <strong>USES</strong>, you can set a different amount of maximum uses for the codes you generate.</p> +<p>Run <code>leap deploy</code> to disable the option.</p> <h2><a name="customization"></a>Customization</h2> diff --git a/docs/en/tutorials/quick-start.html b/docs/en/tutorials/quick-start.html index d275a321..41a3c4b1 100644 --- a/docs/en/tutorials/quick-start.html +++ b/docs/en/tutorials/quick-start.html @@ -246,12 +246,13 @@ workstation$ ruby-install ruby <p>The LEAP platform recipes are a set modules designed to work together to provide you everything you need to manage your provider. You typically do not need to modify these, but do need them available for deploying your provider.</p> -<p>To obtain the platform recipes, simply clone the git repository, and then check out the most recent stable release branch:</p> +<p>To obtain the platform recipes, simply clone the git repository, and then check out the most recent release tagged stable :</p> -<pre><code>workstation$ git clone -b version/0.9.x https://leap.se/git/leap_platform +<pre><code>workstation$ git clone https://leap.se/git/leap_platform +workstation$ git checkout 0.10.0 </code></pre> -<p>If you want to get the latest development branch (Beware: it could be unstable !) you could simply use the master branch instead by:</p> +<p>If you want to get the latest developments (Beware: it could be unstable !) you just don’t checkout a particular tag :</p> <pre><code>workstation$ git clone https://leap.se/git/leap_platform </code></pre> @@ -445,7 +446,7 @@ wildebeest# run_tests <h1><a name="create-an-administrator"></a>Create an administrator</h1> -<p>Assuming that you set up your DNS or <code>/etc/hosts</code> file, you should be able to load <code>https://example.org</code> in your web browser (where example.org is whatever domain name you actually used).</p> +<p>The registration of new users is since the platform 0.10 restricted by default. You will need to generate an <code>invite code.</code> A simple <code>leap run invite</code> will give you an code like <code>ptxy-rsy1</code> which you can use to register a user. Assuming that you set up your DNS or <code>/etc/hosts</code> file, you should be able to load <code>https://example.org</code> in your web browser (where example.org is whatever domain name you actually used).</p> <p>Your browser will complain about an untrusted cert, but for now just bypass this. From there, you should be able to register a new user and login.</p> @@ -460,7 +461,7 @@ wildebeest# run_tests <p>Save that file and run <code>leap deploy</code> again. When you next log on to the web application, the user kangaroo will now be an admin.</p> -<p>If you want to restrict who can register a new user, see <a href="../services/webapp.html">webapp</a> for configuration options.</p> +<p>If you want to open up registration of new users, see <a href="../services/webapp.html">webapp</a> for configuration options.</p> <h1><a name="what-is-next"></a>What is next?</h1> diff --git a/docs/en/tutorials/quick-start/index.html b/docs/en/tutorials/quick-start/index.html index ae617e1b..96cf5382 100644 --- a/docs/en/tutorials/quick-start/index.html +++ b/docs/en/tutorials/quick-start/index.html @@ -246,12 +246,13 @@ workstation$ ruby-install ruby <p>The LEAP platform recipes are a set modules designed to work together to provide you everything you need to manage your provider. You typically do not need to modify these, but do need them available for deploying your provider.</p> -<p>To obtain the platform recipes, simply clone the git repository, and then check out the most recent stable release branch:</p> +<p>To obtain the platform recipes, simply clone the git repository, and then check out the most recent release tagged stable :</p> -<pre><code>workstation$ git clone -b version/0.9.x https://leap.se/git/leap_platform +<pre><code>workstation$ git clone https://leap.se/git/leap_platform +workstation$ git checkout 0.10.0 </code></pre> -<p>If you want to get the latest development branch (Beware: it could be unstable !) you could simply use the master branch instead by:</p> +<p>If you want to get the latest developments (Beware: it could be unstable !) you just don’t checkout a particular tag :</p> <pre><code>workstation$ git clone https://leap.se/git/leap_platform </code></pre> @@ -445,7 +446,7 @@ wildebeest# run_tests <h1><a name="create-an-administrator"></a>Create an administrator</h1> -<p>Assuming that you set up your DNS or <code>/etc/hosts</code> file, you should be able to load <code>https://example.org</code> in your web browser (where example.org is whatever domain name you actually used).</p> +<p>The registration of new users is since the platform 0.10 restricted by default. You will need to generate an <code>invite code.</code> A simple <code>leap run invite</code> will give you an code like <code>ptxy-rsy1</code> which you can use to register a user. Assuming that you set up your DNS or <code>/etc/hosts</code> file, you should be able to load <code>https://example.org</code> in your web browser (where example.org is whatever domain name you actually used).</p> <p>Your browser will complain about an untrusted cert, but for now just bypass this. From there, you should be able to register a new user and login.</p> @@ -460,7 +461,7 @@ wildebeest# run_tests <p>Save that file and run <code>leap deploy</code> again. When you next log on to the web application, the user kangaroo will now be an admin.</p> -<p>If you want to restrict who can register a new user, see <a href="../../services/webapp.html">webapp</a> for configuration options.</p> +<p>If you want to open up registration of new users, see <a href="../../services/webapp.html">webapp</a> for configuration options.</p> <h1><a name="what-is-next"></a>What is next?</h1> diff --git a/docs/en/tutorials/vagrant.html b/docs/en/tutorials/vagrant.html index e473ce82..88623d97 100644 --- a/docs/en/tutorials/vagrant.html +++ b/docs/en/tutorials/vagrant.html @@ -671,6 +671,7 @@ cat SHA215SUMS <li>If that fails, make sure that you can run virtual machines (VMs) in plain virtualbox (Virtualbox GUI or VBoxHeadless). We don’t suggest a special howto for that, <a href="http://www.thegeekstuff.com/2012/02/virtualbox-install-create-vm/">this one</a> seems pretty decent, or you follow the <a href="http://www.virtualbox.org/manual/UserManual.html">Oracale Virtualbox User Manual</a>. There’s also specific documentation for <a href="https://wiki.debian.org/VirtualBox">Debian</a> and for <a href="https://help.ubuntu.com/community/VirtualBox">Ubuntu</a>. If you succeeded, try again if you now can start vagrant nodes using plain vagrant (see first step).</li> <li>If plain vagrant works for you, you’re very close to using vagrant with leap! If you encounter any problems now, please <a href="https://leap.se/en/about-us/contact">contact us</a> or use our <a href="https://leap.se/code">issue tracker</a></li> +<li>The Vagrant on Ubuntu 16.04 has broken support for plugins, you should use the gem or upgrade your distro.</li> </ul> diff --git a/docs/en/tutorials/vagrant/index.html b/docs/en/tutorials/vagrant/index.html index 181a3ccf..ab16d0a0 100644 --- a/docs/en/tutorials/vagrant/index.html +++ b/docs/en/tutorials/vagrant/index.html @@ -671,6 +671,7 @@ cat SHA215SUMS <li>If that fails, make sure that you can run virtual machines (VMs) in plain virtualbox (Virtualbox GUI or VBoxHeadless). We don’t suggest a special howto for that, <a href="http://www.thegeekstuff.com/2012/02/virtualbox-install-create-vm/">this one</a> seems pretty decent, or you follow the <a href="http://www.virtualbox.org/manual/UserManual.html">Oracale Virtualbox User Manual</a>. There’s also specific documentation for <a href="https://wiki.debian.org/VirtualBox">Debian</a> and for <a href="https://help.ubuntu.com/community/VirtualBox">Ubuntu</a>. If you succeeded, try again if you now can start vagrant nodes using plain vagrant (see first step).</li> <li>If plain vagrant works for you, you’re very close to using vagrant with leap! If you encounter any problems now, please <a href="https://leap.se/en/about-us/contact">contact us</a> or use our <a href="https://leap.se/code">issue tracker</a></li> +<li>The Vagrant on Ubuntu 16.04 has broken support for plugins, you should use the gem or upgrade your distro.</li> </ul> diff --git a/docs/en/upgrading.html b/docs/en/upgrading.html index 0e5d6607..cb536507 100644 --- a/docs/en/upgrading.html +++ b/docs/en/upgrading.html @@ -78,6 +78,9 @@ Upgrading - LEAP Platform Documentation <a class='' href='upgrading.html'>Upgrading</a> </li> <li class=' level1'> +<a class='' href='upgrading/upgrade-0-10.html'>Upgrade to 0.10</a> +</li> +<li class=' level1'> <a class='' href='upgrading/upgrade-0-9.html'>Upgrade to 0.9</a> </li> <li class=' level1'> @@ -103,6 +106,12 @@ Upgrading - LEAP Platform Documentation <div class=' page-summary'> <h2> + <a href='upgrading/upgrade-0-10.html'>Upgrade to 0.10</a> + </h2> + <div class='summary'></div> +</div> +<div class=' page-summary'> + <h2> <a href='upgrading/upgrade-0-9.html'>Upgrade to 0.9</a> </h2> <div class='summary'></div> diff --git a/docs/en/upgrading/upgrade-0-10.html b/docs/en/upgrading/upgrade-0-10.html new file mode 100644 index 00000000..2e88002c --- /dev/null +++ b/docs/en/upgrading/upgrade-0-10.html @@ -0,0 +1,212 @@ +<!DOCTYPE html> +<html lang='en'> +<head> +<title> +Upgrade to 0.10 - LEAP Platform Documentation +</title> +<meta content='width=device-width, initial-scale=1.0' name='viewport'> +<meta charset='UTF-8'> +<base href="" /> +<style> + body { + background: #444; + display: flex; + flex-direction: row; + padding: 10px; + margin: 0px; + } + #sidebar { + flex: 0 0 250px; + background: white; + margin-right: 10px; + padding: 20px; + } + #sidebar ul { + list-style-type: none; + padding-left: 0px; + margin: 0; + } + #sidebar li { padding: 4px } + #sidebar li a { text-decoration: none } + #sidebar li.active { background: #444 } + #sidebar li.active a { color: white } + #sidebar li.level1 { padding-left: 20px } + #sidebar li.level2 { padding-left: 40px } + #main { + flex: 1 1 auto; + background: white; + padding: 20px; + } + #title-box { + padding-bottom: 20px; + border-bottom: 5px solid #eee; + } + #title-box h1 { + margin-top: 0px; + } + pre { + padding: 10px; + background: #eef; + } + code { + background: #eef; + } + table {border-collapse: collapse} + table td { + border: 1px solid #ccc; + padding: 4px; + vertical-align: top; + } +</style> +</head> +<body> +<div id='sidebar'> +<ul> +<li class=''> +<a href='../../index.html'>Home</a> +</li> +<li class=' level0'> +<a class='' href='../guide.html'>Guide</a> +</li> +<li class=' level0'> +<a class='' href='../tutorials.html'>Tutorials</a> +</li> +<li class=' level0'> +<a class='' href='../services.html'>Services</a> +</li> +<li class='semi-active level0'> +<a class='' href='../upgrading.html'>Upgrading</a> +</li> +<li class='active level1'> +<a class='' href='upgrade-0-10.html'>Upgrade to 0.10</a> +</li> +<li class=' level1'> +<a class='' href='upgrade-0-9.html'>Upgrade to 0.9</a> +</li> +<li class=' level1'> +<a class='' href='upgrade-0-8.html'>Upgrade to 0.8</a> +</li> +<li class=' level0'> +<a class='' href='../troubleshooting.html'>Troubleshooting</a> +</li> +<li class=' level0'> +<a class='' href='../details.html'>Details</a> +</li> +</ul> +</div> +<div id='main'> +<div id='title-box'> +<h1>Upgrade to 0.10</h1> + +<div id='summary'></div> +</div> +<div id='content-box'> +<h2><a name="upgrading-to-platform-010"></a>Upgrading to Platform 0.10</h2> + +<p>If you have a node with the service ‘tor’ defined, you will need to change it to +be either ‘tor-relay’, or ‘tor-exit’. Look in your provider directory under the +nodes directory for any .json file that has a ‘services’ section with ‘tor’ +defined, change that to the correct tor service you are wanting to deploy.</p> + +<p>Make sure you have the correct version of leap_cli</p> + +<pre><code>workstation$ sudo gem install leap_cli --version=1.9 +</code></pre> + +<p>If you are upgrading from a version previous to 0.9, please follow those upgrade +instructions before upgrading to 0.10.</p> + +<p>Prepare your platform source by checking out the 0.10.x branch:</p> + +<pre><code>workstation$ cd leap_platform +workstation$ git fetch +workstation$ git checkout 0.10.x +</code></pre> + +<p>Then, deploy:</p> + +<pre><code>workstation$ cd $PROVIDER_DIR +workstation$ leap deploy +workstation$ leap test +</code></pre> + +<p>After deployment, if the leap test does not succeed, you should +investigate. Please see below for some post-deployment upgrade steps that you +may need to perform.</p> + +<p>Starting with Soledad Server 0.9.0, the CouchDB database schema was changed to +improve speed of the server side storage backend. If you provided email, you +will need to run the migration script, otherwise it is unnecessary. Until you +migrate, soledad will refuse to start.</p> + +<p>To run the migration script, do the following (replacing $PROVIDER_DIR, +$COUCHDB_NODE, $MX_NODE, and $SOLEDAD_NODE with your values):</p> + +<p>First backup your couchdb databases, just to be safe. NOTE: This can take some +time and will place several hundred megabytes of data into +/var/backups/couchdb. The size and time depends on how many users there are on +your system. For example, 15k users took approximately 25 minutes and 308M of +space: + workstation$ leap ssh $COUCHDB_NODE + server# cd /srv/leap/couchdb/scripts + server# ./cleanup-user-dbs + server# time ./couchdb_dumpall.sh</p> + +<p> Once that has finished, then its time to run the migration:</p> + +<pre><code>workstation$ cd $PROVIDER_DIR +workstation$ leap run 'systemctl leap_mx stop' $MX_NODE +workstation$ leap run --stream '/usr/share/soledad-server/migration/0.9/migrate.py --log-file /var/log/leap/soledad_migration --verbose --do-migrate' $SOLEDAD_NODE +wait for it to finish (will print DONE) +rerun if interrupted +workstation$ leap deploy +workstation$ leap test +</code></pre> + +<p>Known Issues:</p> + +<p>If you have been deploying from our master branch (ie: unstable code), you might +end up with a broken sources line for apt. If you get the following: + WARNING: The following packages cannot be authenticated! +Then you should remove the files on your nodes inside +/var/lib/puppet/modules/apt/keys and deploy again. (#8862, #8876)</p> + +<ul> +<li>When upgrading, sometimes systemd does not report the correct state of a +daemon. The daemon will be not running, but systemd thinks it is. The symptom +of this is that a deploy will succeed but <code>leap test</code> will fail. To fix, you +can run <code>systemctl stop DAEMON</code> and then <code>systemctl start DAEMON</code> on the +affected host (systemctl restart seems to work less reliably).</li> +</ul> + + +<p>Includes:</p> + +<ul> +<li>leap_web: 0.9.2</li> +<li>nickserver: 0.10.0</li> +<li>leap-mx: 0.10.1</li> +<li>soledad-server: 0.10.5</li> +</ul> + + +<p>Commits: <a href="https://0xacab.org/groups/leap/milestones/platform-010?title=Platform+0.10">https://0xacab.org/groups/leap/milestones/platform-010?title=Platform+0.10</a></p> + +<p>For details on about all the changes included in this release please consult the +<a href="https://0xacab.org/leap/platform/milestones/7">LEAP platform 0.10 milestone</a>.</p> + +<p>Always a good idea to check if you have the latest version of leap_cli:</p> + +<pre><code>workstation$ sudo gem install leap_cli --version=1.9 +</code></pre> + +<p>If you don’t want to install using ‘sudo’:</p> + +<pre><code>workstation$ gem install --user-install leap_cli --version=1.9 +workstation$ PATH="$PATH:$(ruby -e 'puts Gem.user_dir')/bin" +</code></pre> + +</div> +</div> +</body> +</html> diff --git a/docs/en/upgrading/upgrade-0-8.html b/docs/en/upgrading/upgrade-0-8.html index 275abd11..5b7dec15 100644 --- a/docs/en/upgrading/upgrade-0-8.html +++ b/docs/en/upgrading/upgrade-0-8.html @@ -78,6 +78,9 @@ Upgrade to 0.8 - LEAP Platform Documentation <a class='' href='../upgrading.html'>Upgrading</a> </li> <li class=' level1'> +<a class='' href='upgrade-0-10.html'>Upgrade to 0.10</a> +</li> +<li class=' level1'> <a class='' href='upgrade-0-9.html'>Upgrade to 0.9</a> </li> <li class='active level1'> diff --git a/docs/en/upgrading/upgrade-0-9.html b/docs/en/upgrading/upgrade-0-9.html index cb78569d..d798973f 100644 --- a/docs/en/upgrading/upgrade-0-9.html +++ b/docs/en/upgrading/upgrade-0-9.html @@ -77,6 +77,9 @@ Upgrade to 0.9 - LEAP Platform Documentation <li class='semi-active level0'> <a class='' href='../upgrading.html'>Upgrading</a> </li> +<li class=' level1'> +<a class='' href='upgrade-0-10.html'>Upgrade to 0.10</a> +</li> <li class='active level1'> <a class='' href='upgrade-0-9.html'>Upgrade to 0.9</a> </li> |