Difference between revisions of "Features/Proxy Settings"

From Sugar Labs
Jump to: navigation, search
(UI Design: update screenshots)
(Update to reflect current status)
Line 5: Line 5:
 
== Summary ==
 
== Summary ==
  
Setting proxy parameters via special Control Panel component.
+
Allow the user to configure proxy settings using the Sugar Control Panel.
  
 
== Owner ==
 
== Owner ==
  
* Code: [[User:alsroot|Aleksey Lim]]
+
[[User:sascha_silbe|Sascha Silbe]]
* Icons: [[User:M_anish| Anish Mangal]]
 
  
 
== Current status ==
 
== Current status ==
  
* Targeted release: 0.96
+
* Targeted release: 0.98
* Last updated: 2Tue Nov 22 20:40:01 UTC 2011
+
* Last updated: 2012-02-14
 
* Percentage of completion: 95%
 
* Percentage of completion: 95%
  
 
== Detailed Description ==
 
== Detailed Description ==
  
In some cases people might be behind HTTP proxy. For now, there is no any users friendly way in Sugar to setup proxy setting.
+
Both individual users and deployments need to be able to set a proxy for
 +
Sugar and activities to use. While we'd like the system to work that all
 +
out automatically (e.g. using [https://en.wikipedia.org/wiki/Web_Proxy_Autodiscovery_Protocol WPAD]), this often isn't possible. Common
 +
reasons include legacy ("inherited") setups and network uplinks simply being
 +
out of control of the user respectively deployment.
 +
 
 +
The existing Network Control Panel is enhanced by adding a new section for the
 +
proxy settings. For consistency between Sugar and Gnome, the basic layout of
 +
the Gnome 3 proxy settings has been mirrored: A combo box allows the user to
 +
select how the proxy setting should be determined (None=direct connection,
 +
Automatic=WPAD or PAC, Manual=enter host names and ports for each protocol).
 +
Based on which method was selected, additional configuration options are
 +
presented to the user.
 +
 
 +
The settings are stored via gconf, using the same keys as Gnome 2.
  
 
== Benefit to Sugar ==
 
== Benefit to Sugar ==
  
Set proxy parameters without using low level tools like gconftool or switching to Gnome session. This is especially required in Australia and is being developed by ActivityCentral following their input.
+
See [[#Detailed Description|Detailed Description]].
  
 
== Scope ==
 
== Scope ==
  
New Control Panel component.
+
Modifying the existing Network Control Panel.
  
 
== UI Design ==
 
== UI Design ==
Line 46: Line 59:
 
== How To Test ==
 
== How To Test ==
  
* clone [http://git.sugarlabs.org/alsroot/proxy_cp sources]
+
* Set up a proxy on a computer in the same network
* symlink cloned directory to CP components directory, {{Code|/usr/share/sugar/extensions/cpsection}} by default
+
* Open Owner icon → Network Control Panel
* restart sugar shell
+
* Change the proxy settings according to your proxy setup
* open Proxy CP component and setup proxy connection
+
* Switch to Gnome and check that Gnome Control Center → Network → Network proxy has the same options set
* open gnome-network-setting and check if it has the same options set
+
* Use Browse to access the [https://www.sugarlabs.org/ Sugar Labs home page]
  
 
== User Experience ==
 
== User Experience ==
  
The feature is entirely localized only within Control Panel.
+
See [[#UI Design|UI Design]]
  
 
== Dependencies ==
 
== Dependencies ==
  
None.
+
There are no new dependencies.
  
 
== Contingency Plan ==
 
== Contingency Plan ==
  
Do not use new Control Panel component.
+
Users can continue to use the Gnome Control Center to configure proxy settings.
  
 
== Documentation ==
 
== Documentation ==
  
''Is there upstream documentation on this feature, or notes you have written yourself?  Has this topic been discussed in the mailing list or during a meeting? Link to that material here so other interested developers can get involved.''
+
There is no documentation beyond this page.
  
 
== Release Notes ==
 
== Release Notes ==
''The Sugar Release Notes inform end-users about what is new in the release. An Example is [[0.84/Notes]]. The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this feature, indicate them here.  You can also link to upstream documentation if it satisfies this need.  This information forms the basis of the release notes edited by the release team and shipped with the release.''
+
 
 +
There have been no changes to public API. The Release Notes merely need to mention that users can now configure proxy settings from within Sugar. As detailed above, the UI is very similar to the Gnome UI.
  
 
== Comments and Discussion ==
 
== Comments and Discussion ==
 
* See [[{{TALKPAGENAME}}|discussion tab for this feature]] <!-- This adds a link to the "discussion" tab associated with your page.  This provides the ability to have ongoing comments or conversation without bogging down the main feature page. -->
 
* See [[{{TALKPAGENAME}}|discussion tab for this feature]] <!-- This adds a link to the "discussion" tab associated with your page.  This provides the ability to have ongoing comments or conversation without bogging down the main feature page. -->

Revision as of 09:36, 14 February 2012


Summary

Allow the user to configure proxy settings using the Sugar Control Panel.

Owner

Sascha Silbe

Current status

  • Targeted release: 0.98
  • Last updated: 2012-02-14
  • Percentage of completion: 95%

Detailed Description

Both individual users and deployments need to be able to set a proxy for Sugar and activities to use. While we'd like the system to work that all out automatically (e.g. using WPAD), this often isn't possible. Common reasons include legacy ("inherited") setups and network uplinks simply being out of control of the user respectively deployment.

The existing Network Control Panel is enhanced by adding a new section for the proxy settings. For consistency between Sugar and Gnome, the basic layout of the Gnome 3 proxy settings has been mirrored: A combo box allows the user to select how the proxy setting should be determined (None=direct connection, Automatic=WPAD or PAC, Manual=enter host names and ports for each protocol). Based on which method was selected, additional configuration options are presented to the user.

The settings are stored via gconf, using the same keys as Gnome 2.

Benefit to Sugar

See Detailed Description.

Scope

Modifying the existing Network Control Panel.

UI Design

The Feature adds a new section to the Network Control Panel.

Upper part of the Network Control Panel
No proxy (direct connection)
Automatic proxy selection (WPAD)
Manual proxy settings (no authentication)
Manual proxy settings (with authentication)

For comparison, this is what the Gnome 3 proxy settings dialog looks like:

Gnome-3-proxy-settings.png

How To Test

  • Set up a proxy on a computer in the same network
  • Open Owner icon → Network Control Panel
  • Change the proxy settings according to your proxy setup
  • Switch to Gnome and check that Gnome Control Center → Network → Network proxy has the same options set
  • Use Browse to access the Sugar Labs home page

User Experience

See UI Design

Dependencies

There are no new dependencies.

Contingency Plan

Users can continue to use the Gnome Control Center to configure proxy settings.

Documentation

There is no documentation beyond this page.

Release Notes

There have been no changes to public API. The Release Notes merely need to mention that users can now configure proxy settings from within Sugar. As detailed above, the UI is very similar to the Gnome UI.

Comments and Discussion