Merge branch 'master' into r4.1

README.md

@@ -10,12 +10,9 @@ will not support it.  For Qubes OS 4.0, check branch `r4.0`.
 
 ## Why?
 
-Qubes OS is a magnificent operating system, but there are so many use cases that its networking model cannot crack:
+Qubes OS is a magnificent operating system.  That said, there are many use cases its networking
+model does not work well for:
 
-* As an automated integration testing system.  Qubes OS would be
-  phenomenal for this, and its automation tools would make it
-  extremely easy to bring up and tear down entire environments.
-  If only those environments could network with each other securely!
 * Remote management of Qubes OS instances.  Vanilla Qubes OS cannot
   easily be managed remotely.  A better networking model would allow
   for orchestration tools — such as
@@ -24,8 +21,12 @@ Qubes OS is a magnificent operating system, but there are so many use cases that
   within each VM.
 * Anything that involves a secure server, serving data to people or
   machines, simply cannot be done under vanilla Qubes OS.
+* As an automated integration testing system.  Qubes OS would be
+  phenomenal for this, and its automation tools would make it
+  extremely easy to bring up and tear down entire environments.
+  If only those environments could network with each other securely!
 
-## Enhanced networking model
+### The traditional Qubes networking model
 
 The traditional Qubes OS networking model contemplates a client-only
 use case.  User VMs (AppVMs or StandaloneVMs) are attached to ProxyVMs,
@@ -43,7 +44,9 @@ for multiple VMs, which need to carefully override the existing firewall
 rules, and require careful thought not to open the system to unexpected
 attack vectors.  The Qubes OS user interface provides no help either.
 
-Qubes network server changes all that.
+### The Qubes network server networking model
+
+Qubes network server builds on that.
 
 ![Qubes network server model](./doc/Qubes network server model.png)
 
@@ -65,12 +68,18 @@ to machines on the same network as the NetVM.
 
 ## How to use this software
 
-Once installed (see below), usage of the software is straightforward.
+Once installed (**see below for installation instructions**), usage of
+the software is straightforward.
 
-These sample instructions assume you already have an AppVM VM set up,
+These sample instructions assume:
-named `testvm`, and that your `sys-net` VM is attached to a network with
-subnet `192.168.16.0/24`.
 
+* you understand the distinction between dom0 and qubes
+* you already have an AppVM VM set up, named `testvm`,
+* your `sys-net` VM is attached to a network with subnet `192.168.16.0/24`
+  — this, of course, may vary depending on your local router configuration.
+
+*Do not proceed any further if you do not yet meet these requirements.*
+  
 First, attach the VM you want to expose to the network
 to a NetVM that has an active network connection:
 
@@ -100,9 +109,9 @@ Here are documents that will help you take advantage of Qubes network server:
 * [Setting up your first server](doc/Setting up your first server.md)
 * [Setting up an SSH server](doc/Setting up an SSH server.md)
 
-## Installation
+## Installation of packages
 
-Installation consists of two steps:
+Package installation consists of two steps (**the package creation instructions are below**):
 
 1. Deploy the `qubes-core-admin-addon-network-server` RPM to your `dom0`.
 2. Deploy the `qubes-network-server` RPM to the TemplateVM backing your

build.parameters

@@ -0,0 +1 @@
+["RELEASE": "25 34"]

doc/Setting up your first server.md

@@ -5,13 +5,14 @@ is meant to be a standalone VM that contains files, being served by
 a running HTTP server (port 80) within it.  This VM is attached to a
 NetVM `sys-net`, with IP address `192.168.1.4` on a local network
 `192.168.1.0/24`.  Our goal will be to make `httpserver` accessible
-to your laptop on the same physical network, which we'll assume has
+to your client laptop on the same physical network, which we'll
-IP address `192.168.1.8`.
+assume has IP address `192.168.1.8`.
 
 ##Assign a static address
 
 First step is to assign an address — let's make it `192.168.1.6` —
-to `httpserver`:
+to `httpserver` (of course, you should make sure that this IP
+address isn't used by any other equipment in your network):
 
 ```
 qvm-prefs -s httpserver ip 192.168.1.6

qubes-network-server.spec

@@ -3,7 +3,7 @@
 %define mybuildnumber %{?build_number}%{?!build_number:1}
 
 Name:           qubes-network-server
-Version:        0.0.13
+Version:        0.0.16
 Release:        %{mybuildnumber}%{?dist}
 Summary:        Turn your Qubes OS into a network server
 BuildArch:      noarch
@@ -89,7 +89,7 @@ echo 'enable qubes-routing-manager.service' > "$RPM_BUILD_ROOT"/%{_presetdir}/75
 %doc README.md TODO
 
 %files -n       qubes-core-admin-addon-network-server
-%attr(0644, root, root) %{python3_sitelib}/qubesnetworkserver
+%attr(0644, root, root) %{python3_sitelib}/qubesnetworkserver/*
 %{python3_sitelib}/qubesnetworkserver-*.egg-info
 
 %post