Merge ~morphis/snappy-hwe-snaps/+git/wifi-ap:f/extend-faq into ~snappy-hwe-team/snappy-hwe-snaps/+git/wifi-ap:master

Proposed by Simon Fels
Status: Merged
Approved by: Matteo Croce
Approved revision: c2546b6b058916915c4813e6a91e2bc775345af0
Merged at revision: f171b4b99e02ca26602142add89d491bd3f86600
Proposed branch: ~morphis/snappy-hwe-snaps/+git/wifi-ap:f/extend-faq
Merge into: ~snappy-hwe-team/snappy-hwe-snaps/+git/wifi-ap:master
Diff against target: 94 lines (+69/-0)
3 files modified
docs/faq.md (+19/-0)
docs/metadata.yaml (+2/-0)
docs/reference/snap-configuration.md (+48/-0)
Reviewer Review Type Date Requested Status
System Enablement Bot continuous-integration Approve
Jim Hodapp (community) Needs Fixing
Matteo Croce (community) Approve
Review via email: mp+318378@code.launchpad.net

Description of the change

Extend FAQ and document available snap configuration items

To post a comment you must log in.
Revision history for this message
Matteo Croce (teknoraver) :
review: Approve
Revision history for this message
System Enablement Bot (system-enablement-ci-bot) wrote :
review: Approve (continuous-integration)
Revision history for this message
Jim Hodapp (jhodapp) wrote :

Some changes needed, see below.

review: Needs Fixing
Revision history for this message
System Enablement Bot (system-enablement-ci-bot) wrote :
review: Approve (continuous-integration)

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1diff --git a/docs/faq.md b/docs/faq.md
2index 34848d0..a2b705c 100644
3--- a/docs/faq.md
4+++ b/docs/faq.md
5@@ -7,3 +7,22 @@ table_of_contents: True
6
7 This section covers some of the most commonly encountered problems and attempts
8 to resolve them.
9+
10+## Can I run an AP in parallel to being connected to another WiFi network?
11+
12+Yes this is possible. However, there are known limitations if the device only has
13+one WiFi network device. (e.g. both need to operate on the same channel). See
14+[Simultaneous STA / AP Mode](simultaneous-sta-ap-mode.md) for more details.
15+
16+## Why isn't the AP automatically enabled after I've installed the snap?
17+
18+Normally it should automatically come up if this isn't disabled through the
19+device configuration inside the gadget snap. See
20+[Snap Configuration](reference/snap-configuration.md#automatic-setup.disable)
21+for more details.
22+
23+If the above doesn't help then its most likely that the automatic setup couldn't
24+find a good configuration for your device and you have to manually configure the AP.
25+See [Configuration](reference/configuration.md) for details on this.
26+
27+If this still doesn't help, feel free to file a [bug report](report-bug.md).
28diff --git a/docs/metadata.yaml b/docs/metadata.yaml
29index 903f24b..39d53b3 100644
30--- a/docs/metadata.yaml
31+++ b/docs/metadata.yaml
32@@ -21,6 +21,8 @@ navigation:
33 location: reference/commands.md
34 - title: Configuration
35 location: reference/configuration.md
36+ - title: Snap Configuration
37+ location: reference/snap-configuration.md
38 - title: API Documentation
39 location: reference/rest-api.md
40 children:
41diff --git a/docs/reference/snap-configuration.md b/docs/reference/snap-configuration.md
42new file mode 100644
43index 0000000..03e94fe
44--- /dev/null
45+++ b/docs/reference/snap-configuration.md
46@@ -0,0 +1,48 @@
47+---
48+title: "Snap Configuration"
49+table_of_contents: False
50+---
51+
52+# Snap Configuration
53+
54+In parallel to its own configuration system the wifi-ap snap provides a set of
55+snap configuration items which can be changed through the *snap set* system
56+command. These allow customization of the default behaviour of the wifi-ap snap
57+from a device [gadget snap](https://docs.ubuntu.com/core/en/reference/gadget).
58+
59+The available configuration items are documented in the following sections.
60+
61+## automatic-setup.disable
62+
63+The *automatic-setup.disable* option allows a device to disable the automatic
64+AP setup that the wifi-ap snap comes with by default.
65+
66+Possible values are:
67+
68+ * *false (default):* The automatic setup of the AP on installation of the wifi-ap
69+ snap is **enabled**.
70+ * *true:* The automatic setup of the AP on installation of the wifi-ap snap is
71+ **disabled**.
72+
73+Example:
74+
75+```
76+$ snap set wifi-ap automatic-setup.disable=true
77+```
78+
79+Please note that changing the configuration after installation of the wifi-ap
80+snap does not change its behaviour anymore. The option only has influence on the
81+snap when it is being installed. This can be used from a gadget snap by adding the
82+following lines to the gadget.yaml file:
83+
84+```
85+defaults:
86+ # The alpha numeric key below is the id of the wifi-ap snap assigned in the
87+ # Ubuntu Store. Specifying the snap name instead is not possible.
88+ 2rGgvyaY0CCzlWuKAPwFtCWrgwkM8lqS:
89+ automatic-setup.disable: true
90+```
91+
92+After this snippet is added to the gadget.yaml and an updated version of the
93+gadget snap is deployed onto the device the automatic setup, of the AP is disabled
94+once the wifi-ap is installed from the Ubuntu Store.

Subscribers

People subscribed via source and target branches

to all changes: