def set_auth_token(token, pyngrok_config=None):
"""
Set the :code:`ngrok` auth token in the config file, enabling authenticated features (for instance,
more concurrent tunnels, custom subdomains, etc.).
If :code:`ngrok` is not installed at :class:`~pyngrok.conf.PyngrokConfig`'s :code:`ngrok_path`, calling this method
will first download and install :code:`ngrok`.
:param token: The auth token to set.
:type token: str
:param pyngrok_config: The :code:`pyngrok` configuration to use when interacting with the :code:`ngrok` binary.
:type pyngrok_config: PyngrokConfig, optional
"""
if pyngrok_config is None:
pyngrok_config = PyngrokConfig()
ensure_ngrok_installed(pyngrok_config.ngrok_path)
process.set_auth_token(pyngrok_config, token)
def set_auth_token(token, pyngrok_config=None):
"""
Set the ``ngrok`` auth token in the config file, enabling authenticated features (for instance,
more concurrent tunnels, custom subdomains, etc.).
If ``ngrok`` is not installed at :class:`~pyngrok.conf.PyngrokConfig`'s ``ngrok_path``, calling this method
will first download and install ``ngrok``.
:param token: The auth token to set.
:type token: str
:param pyngrok_config: The ``pyngrok`` configuration to use when interacting with the ``ngrok`` binary,
defaults to ``conf.DEFAULT_PYNGROK_CONFIG``.
:type pyngrok_config: PyngrokConfig, optional
"""
if pyngrok_config is None:
pyngrok_config = conf.DEFAULT_PYNGROK_CONFIG
ensure_ngrok_installed(pyngrok_config.ngrok_path)
process.set_auth_token(pyngrok_config, token)
def set_auth_token(token, ngrok_path=None, config_path=None):
"""
Set the `ngrok` auth token in the config file, enabling authenticated features (for instance,
more concurrent tunnels, custom subdomains, etc.).
If `ngrok` is not installed at the given path, calling this method will first download
and install `ngrok`.
:param token: The auth token to set.
:type token: string
:param ngrok_path: A `ngrok` binary override (instead of using `pyngrok`'s).
:type ngrok_path: string, optional
:param config_path: A config path override.
:type config_path: string, optional
"""
ngrok_path = ngrok_path if ngrok_path else DEFAULT_NGROK_PATH
config_path = config_path if config_path else DEFAULT_CONFIG_PATH
ensure_ngrok_installed(ngrok_path)
process.set_auth_token(ngrok_path, token, config_path)
