Merge ~ines-almeida/launchpad:update-starter-docs-remote-access-section into launchpad:master

Proposed by Ines Almeida
Status: Merged
Approved by: Ines Almeida
Approved revision: 2e0282978fef9c0d4109af9816cdca47ed4fe9d6
Merge reported by: Otto Co-Pilot
Merged at revision: not available
Proposed branch: ~ines-almeida/launchpad:update-starter-docs-remote-access-section
Merge into: launchpad:master
Diff against target: 67 lines (+33/-13)
1 file modified
doc/how-to/running.rst (+33/-13)
Reviewer Review Type Date Requested Status
Colin Watson (community) Approve
Review via email: mp+443498@code.launchpad.net

Commit message

Clarify "Setting up remote access" section in starter docs

No information change, but updated the title and added a paragraph to clarify some of details, to make it more accessible to everyone regardless of experience with containers.

Description of the change

Only updating starter docs. No content change, only wording and adding information for clarity.

To post a comment you must log in.
Revision history for this message
Colin Watson (cjwatson) :
review: Approve
Revision history for this message
Ines Almeida (ines-almeida) wrote :

Thank you Colin. Comments were addressed

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1diff --git a/doc/how-to/running.rst b/doc/how-to/running.rst
2index a217a19..802a2a6 100644
3--- a/doc/how-to/running.rst
4+++ b/doc/how-to/running.rst
5@@ -287,8 +287,12 @@ need to do ``make schema`` every time, and you should avoid it because it's
6 expensive and because it will clean out any data you might have put into
7 your test instance (through the web UI or by running other scripts).
8
9-Setting up remote access
10-========================
11+Accessing your web application
12+==============================
13+
14+When running ``make run``, your application is running in your container, but it
15+is not yet accessible outside of it - this includes your host machine, i.e.,
16+you won't, for example, be able to access your application from your browser.
17
18 Unless the only thing you're doing is running parts of the test suite, you
19 probably want to make your new Launchpad instance accessible from other
20@@ -312,20 +316,36 @@ Amending the hosts file
21
22 Launchpad makes extensive use of virtual hosts, so you'll need to add
23 entries to ``/etc/hosts`` on any machine from which you want to access the
24-Launchpad instance. You'll see the relevant hostnames in ``/etc/hosts`` on
25-the machine running the instance - they need to be added to the remote
26-machine, mapped to the server machine or container's external IP address.
27+Launchpad instance.
28+
29+Within the container running the instance, you can see the relevant hostnames
30+in ``/etc/hosts`` - these need to be added to the machine you want to access
31+the application from, mapped to the server machine or container's external IP address.
32+
33+For example, to access the application in your host system (and your browser),
34+you should copy the ``*.launchpad.test`` hostnames you see in the ``hosts`` file
35+within the container running the application, and append them to your host system's
36+``hosts`` file, mapped to the IPv4 address of the container running the app.
37+
38+This should look similar to this:
39+
40+.. code-block::
41+
42+ # Launchpad virtual domains. This should be on one line.
43+ <your container IPv4 address> launchpad.test answers.launchpad.test archive.launchpad.test api.launchpad.test bazaar.launchpad.test bazaar-internal.launchpad.test blueprints.launchpad.test bugs.launchpad.test code.launchpad.test feeds.launchpad.test keyserver.launchpad.test lists.launchpad.test ppa.launchpad.test private-ppa.launchpad.test testopenid.test translations.launchpad.test xmlrpc-private.launchpad.test xmlrpc.launchpad.test
44+
45+.. note::
46
47-If some of those other machines run Windows, it may be helpful to know that
48-the Windows equivalent of ``/etc/hosts`` is located at
49-``C:\WINDOWS\system32\drivers\etc\hosts``. Note that Windows' version has a
50-line length limit, so you might have to split it across multiple lines or
51-only include the hostnames that you need.
52+ To access the application in a Windows machine, it may be helpful to know that
53+ the Windows equivalent of ``/etc/hosts`` is located at
54+ ``C:\WINDOWS\system32\drivers\etc\hosts``. Note that Windows' version has a
55+ line length limit, so you might have to split it across multiple lines or
56+ only include the hostnames that you need.
57
58 You should now be able to access ``https://launchpad.test/`` in a web
59-browser on a suitably configured remote computer. Accept the local
60-self-signed certificate. You can log in as ``admin@canonical.com`` without
61-a password. (This is only for development convenience, and assumes that you
62+browser on a suitably configured remote computer. Accept the local
63+self-signed certificate. You can log in as ``admin@canonical.com`` without
64+a password. (This is only for development convenience, and assumes that you
65 trust machines that can route to your LXD containers; of course a production
66 deployment would need real authentication.). If you want to create more user
67 accounts, see :doc:`new-user`.

Subscribers

People subscribed via source and target branches

to status/vote changes: