Added: Set parameters from env vars, allow setting url base from command line. Closes #710

Author: theotherp

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

changelog.md

@@ -1,6 +1,9 @@
 # NZB Hydra changelog
 
 ----------
+### 0.2.233
+Added: Set URL base from command line, set some of the parameters using environment variables. See [#710](https://github.com/theotherp/nzbhydra/issues/710).
+
 ### 0.2.232
 Fixed: Results from nzb.su were reported as passworded (not my fault)
 

libs/configargparse.py

@@ -10,7 +10,6 @@
 import glob
 import subprocess
 import os
-import argparse
 import webbrowser
 import nzbhydra
 
@@ -28,6 +27,7 @@
 import nzbhydra.config as config
 
 import requests
+import configargparse
 
 requests.packages.urllib3.disable_warnings()
 
@@ -164,6 +164,7 @@ def run(arguments):
 
         host = config.settings.main.host if arguments.host is None else arguments.host
         port = config.settings.main.port if arguments.port is None else arguments.port
+        nzbhydra.urlBase = config.settings.main.urlBase if arguments.urlbase is None else arguments.urlbase
 
         socksproxy = config.settings.main.socksProxy if arguments.socksproxy is None else arguments.socksproxy
         if socksproxy:
@@ -196,6 +197,8 @@ def run(arguments):
                 f.host = config.settings.main.host
             f.port = port
             f.scheme = "https" if config.settings.main.ssl else "http"
+            if nzbhydra.urlBase is not None:
+                f.path = nzbhydra.urlBase + "/"
             logger.notice("Starting web app on %s:%d" % (f.host, port))
         if not arguments.nobrowser and config.settings.main.startupBrowser:
             if arguments.restarted:
@@ -225,18 +228,19 @@ def _stop_worker_threads():
 
 if __name__ == '__main__':
 
-    parser = argparse.ArgumentParser(description='NZBHydra')
-    parser.add_argument('--config', action='store', help='Settings file to load', default="settings.cfg")
-    parser.add_argument('--database', action='store', help='Database file to load', default="nzbhydra.db")
+    parser = configargparse.ArgParser(description='NZBHydra')
+    parser.add_argument('--config', action='store', env_var="hydra_config", help='Settings file to load. Can also be set using the environment variable "hydra_config"', default="settings.cfg")
+    parser.add_argument('--database', action='store', env_var="hydra_database", help='Database file to load. Can also be set using the environment variable "hydra_database"', default="nzbhydra.db")
     parser.add_argument('--logfile', action='store', help='Log file. If set overwrites config value', default=None)
-    parser.add_argument('--host', '-H', action='store', help='Host to run on')
-    parser.add_argument('--port', '-p', action='store', help='Port to run on', type=int)
-    parser.add_argument('--nobrowser', action='store_true', help='Don\'t open URL on startup', default=False)
+    parser.add_argument('--host', '-H', action='store', env_var="hydra_host", help='Host to run on. Can also be set using the environment variable "hydra_host"')
+    parser.add_argument('--port', '-p', action='store', env_var="hydra_port", help='Port to run on. Can also be set using the environment variable "hydra_port"', type=int)
+    parser.add_argument('--urlbase', '-u', action='store', env_var="hydra_urlbase", help='URL base (e.g. "/nzbhydra"). Can also be set using the environment variable "hydra_urlbase"', default=None)
+    parser.add_argument('--nobrowser', action='store_true', env_var="hydra_nobrowser", help='Don\'t open URL on startup', default=False)
     parser.add_argument('--daemon', '-D', action='store_true', help='Run as daemon. *nix only', default=False)
     parser.add_argument('--pidfile', action='store', help='PID file. Only relevant with daemon argument', default="nzbhydra.pid")
     parser.add_argument('--quiet', '-q', action='store_true', help='Quiet (no output)', default=False)
-    parser.add_argument('--restarted', action='store_true', help=argparse.SUPPRESS, default=False)
-    parser.add_argument('--clearloganddb', action='store_true', help=argparse.SUPPRESS, default=False)
+    parser.add_argument('--restarted', action='store_true', help=configargparse.SUPPRESS, default=False)
+    parser.add_argument('--clearloganddb', action='store_true', help=configargparse.SUPPRESS, default=False)
     parser.add_argument('--socksproxy', action='store', help='SOCKS proxy to use in format socks5://user:pass@host:port', default=None)
 
     args, unknown = parser.parse_known_args()

nzbhydra.py

@@ -5,6 +5,7 @@
 configFile = None
 databaseFile = None
 databaseLock = thread.allocate_lock()
+urlBase = None
 
 def getBasePath():
     try:

nzbhydra/__init__.py

@@ -104,8 +104,8 @@ def get_root_url():
     f.scheme = request.scheme
     f.host = furl(request.host_url).host
     f.port = config.settings.main.port
-    if config.settings.main.urlBase:
-        f.path = config.settings.main.urlBase
+    if nzbhydra.urlBase:
+        f.path = nzbhydra.urlBase
     return str(f) + "/"
 
 

nzbhydra/api.py

@@ -78,9 +78,9 @@ def assertApiUrl(self, url, shouldBeExternal, shouldbeLocal):
 
     def testGetRootUrl(self):
         with web.app.test_request_context('/nzbhydra/'):
-            config.settings.main.urlBase = None
+            nzbhydra.urlBase = None
             config.settings.main.port = 5075
             self.assertEqual("http://localhost:5075/", api.get_root_url())
 
-            config.settings.main.urlBase = "/nzbhydra"
+            nzbhydra.urlBase = "/nzbhydra"
             self.assertEqual("http://localhost:5075/nzbhydra/", api.get_root_url())

nzbhydra/tests/test_Api.py

@@ -316,7 +316,7 @@ def testFullStackTvSearch(self, requestsMock):
     # @requests_mock.Mocker()
     # def testBaseUrl(self, requestsMock):
     #     web.app.template_folder = "../templates"
-    #     config.settings.main.urlBase = "/nzbhydra"
+    #     nzbhydra.urlBase = "/nzbhydra"
     #
     #     expectedItems = self.prepareSearchMocks(requestsMock, 1, 1)
     #     with web.app.test_request_context('/nzbhydra/'):

nzbhydra/tests/test_IntegrationTestsSearch.py

@@ -79,7 +79,7 @@ def __init__(self, app):
         self.app = app
 
     def __call__(self, environ, start_response):
-        base_url = config.settings.main.urlBase
+        base_url = nzbhydra.urlBase # config.settings.main.urlBase
         if base_url is not None and base_url.endswith("/"):
             base_url = base_url[:-1]
         if base_url is not None and base_url != "":
@@ -505,10 +505,10 @@ def login():
             session["rememberMe"] = token
             session["username"] = u["username"]
             session["token"] = create_token(u)
-            return redirect(("/" + config.settings.main.urlBase + "/").replace("//", "/") if config.settings.main.urlBase else "/")
+            return redirect(("/" + nzbhydra.urlBase + "/").replace("//", "/") if nzbhydra.urlBase else "/")
     ip = getIp() if config.settings.main.logging.logIpAddresses else "<HIDDENIP>"
     logger.warn("Unsuccessful form login for user %s from IP %s" % (username, ip))
-    return redirect(("/" + config.settings.main.urlBase + "/").replace("//", "/") if config.settings.main.urlBase else "/" + "login")
+    return redirect(("/" + nzbhydra.urlBase + "/").replace("//", "/") if nzbhydra.urlBase else "/" + "login")
 
 
 @app.route('/auth/logout', methods=['POST'])
@@ -553,7 +553,7 @@ def sendUserInfos():
 @requires_auth("main", disableAuthForForm=True)
 def base(path):
     logger.debug("Sending index.html")
-    base_url = ("/" + config.settings.main.urlBase + "/").replace("//", "/") if config.settings.main.urlBase else "/"
+    base_url = ("/" + nzbhydra.urlBase + "/").replace("//", "/") if nzbhydra.urlBase else "/"
     _, currentVersion = get_current_version()
 
     user = getUserByName(session["username"]) if "username" in session.keys() else None
@@ -578,7 +578,7 @@ def base(path):
 @app.route('/login')
 def loginview():
     logger.debug("Sending login.html")
-    base_url = ("/" + config.settings.main.urlBase + "/").replace("//", "/") if config.settings.main.urlBase else "/"
+    base_url = ("/" + nzbhydra.urlBase + "/").replace("//", "/") if nzbhydra.urlBase else "/"
     return render_template("login.html", base_url=base_url, theme=config.settings.main.theme + ".css", )
 
 

nzbhydra/web.py

@@ -1 +1 @@
-0.2.232
+0.2.233