Merge pull request #70 from uyuni-project/rename_use_ssl

Rename the USE_SSL flag

Author: moio

README.md

@@ -9,6 +9,7 @@ Servers are registered and can be managed from the Hub just like normal SUSE Man
 ## Getting Started
 
 ### Requirements
+
  - one central SUSE Manager/Uyuni Server (hereinafter: "Hub")
  - two or more peripheral Servers registered to the Hub as Salt clients
  - any number of end clients registered to peripheral Servers
@@ -29,12 +30,13 @@ Install the package `hub-xmlrpc-api`, available from SUSE Manager 4.1 and Uyuni
  - `HUB_API_URL`: URL to the Hub XMLRPC API endpoint
  - `HUB_CONNECT_TIMEOUT`: maximum number of seconds to wait for a response when connecting to a Server
  - `HUB_REQUEST_TIMEOUT`: maximum numbr of seconds to wait for a response when calling a Server method
- - `USE_SSL`: use https instead of plain http for communicating with peripheral Servers
+ - `HUB_CONNECT_USING_SSL`: use https instead of plain http for communicating with peripheral Servers
 
- Default values should suffice in most settings.
+Default values should suffice in most settings.
 
 ### Note
-In order to use https to connect to peripheral Servers, in addition to setting `USE_SSL` flag to true, SSL certificates for all the peripheral Servers need to be installed on the machine where the `hub-xmlrpc-api` service runs. This can be achieved by copying the `RHN-ORG-TRUSTED-SSL-CERT` certificate file from each peripheral Server's `pub` directory (`https://<server-url>/pub/`) to `/etc/pki/trust/anchors/` and then running the `update-ca-certificates` command.
+
+In order to use https to connect to peripheral Servers, in addition to setting `HUB_CONNECT_USING_SSL` flag to true, SSL certificates for all the peripheral Servers need to be installed on the machine where the `hub-xmlrpc-api` service runs. This can be achieved by copying the `RHN-ORG-TRUSTED-SSL-CERT` certificate file from each peripheral Server's `pub` directory (`https://<server-url>/pub/`) to `/etc/pki/trust/anchors/` and then running the `update-ca-certificates` command.
 
 
 ## Usage

config/config.go

@@ -19,10 +19,10 @@ type Config struct {
 func NewConfig() *Config {
 
 	k.Load(confmap.Provider(map[string]interface{}{
-		"HUB_API_URL":         "http://localhost/rpc/api",
-		"HUB_CONNECT_TIMEOUT": 10,
-		"HUB_REQUEST_TIMEOUT": 10,
-		"USE_SSL":             false,
+		"HUB_API_URL":           "http://localhost/rpc/api",
+		"HUB_CONNECT_TIMEOUT":   10,
+		"HUB_REQUEST_TIMEOUT":   10,
+		"HUB_CONNECT_USING_SSL": false,
 	}, "."), nil)
 
 	k.Load(env.Provider("HUB_", ".", nil), nil)
@@ -31,6 +31,6 @@ func NewConfig() *Config {
 		HubAPIURL:      k.String("HUB_API_URL"),
 		ConnectTimeout: k.Int("HUB_CONNECT_TIMEOUT"),
 		RequestTimeout: k.Int("HUB_REQUEST_TIMEOUT"),
-		UseSSL:         k.Bool("USE_SSL"),
+		UseSSL:         k.Bool("HUB_CONNECT_USING_SSL"),
 	}
 }

release/hub.conf

@@ -1,4 +1,4 @@
 HUB_API_URL=http://localhost/rpc/api
 HUB_CONNECT_TIMEOUT=10
 HUB_REQUEST_TIMEOUT=10
-USE_SSL=false
+HUB_CONNECT_USING_SSL=false