Skip to content

man/labgrid-client: mention LG_PROXY requirements for exporter resources #1807

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rohieb wants to merge 2 commits into
base: master
Choose a base branch
from
Open

man/labgrid-client: mention LG_PROXY requirements for exporter resources #1807

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
38bfc88
treewide: correct several misspellings of "varibale"
rohieb Jan 15, 2026
f45b02f
man/client: mention additional requirements for resources behing proxy
rohieb Jan 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/man/client.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,12 @@ This variable can be used to specify a SSH proxy hostname which should be used
to connect to the coordinator and any resources which are normally accessed
directly.

Note: this proxy is only used to connect to the coordinator.
Additional steps may be required to connect to ressources.
See <https://labgrid.readthedocs.io/en/latest/overview.html#proxy-mechanism>
(or the file ``doc/overview.rst`` in the labgrid source tree)
for more information.

LG_HOSTNAME
~~~~~~~~~~~
Override the hostname used when accessing a resource. Typically only useful for
Expand Down
2 changes: 1 addition & 1 deletion dockerfiles/staging/dut/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ RUN apt update -q=2 && \

COPY --chown=root:root ./authorized_keys /root/.ssh/authorized_keys

# As sshd scrubs ENV variables if they are set by the ENV varibale ensure to put the into /etc/profile as shown below
# As sshd scrubs ENV variables if they are set by the ENV variable ensure to put the into /etc/profile as shown below
ENV NOTVISIBLE="in users profile"
RUN echo "export VISIBLE=now" >> /etc/profile

Expand Down
2 changes: 1 addition & 1 deletion labgrid/remote/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1826,7 +1826,7 @@ def get_parser(auto_doc_mode=False) -> "argparse.ArgumentParser | AutoProgramArg
"-s",
"--state",
type=str,
help="strategy state to switch into before command (default: value from env varibale LG_STATE)",
help="strategy state to switch into before command (default: value from env variable LG_STATE)",
)
parser.add_argument(
"-i",
Expand Down
8 changes: 7 additions & 1 deletion man/labgrid-client.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ place name/alias (default: value from env variable LG_PLACE)
.INDENT 0.0
.TP
.B \-s <state>, \-\-state <state>
strategy state to switch into before command (default: value from env varibale LG_STATE)
strategy state to switch into before command (default: value from env variable LG_STATE)
.UNINDENT
.INDENT 0.0
.TP
Expand Down Expand Up @@ -1116,6 +1116,12 @@ This variable can be used to set the default coordinator in the format
This variable can be used to specify a SSH proxy hostname which should be used
to connect to the coordinator and any resources which are normally accessed
directly.
.sp
Note: this proxy is only used to connect to the coordinator.
Additional steps may be required to connect to ressources.
See <\%<https://\:labgrid\:.readthedocs\:.io/\:en/\:latest/\:overview\:.html#\:proxy-mechanism>>
(or the file \fBdoc/overview.rst\fP in the labgrid source tree)
for more information.
.SS LG_HOSTNAME
.sp
Override the hostname used when accessing a resource. Typically only useful for
Expand Down
Loading