Skip to content

Add details about using display remotely #45

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
suryabhupa wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add details about using display remotely #45

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,13 @@ See `example.lua` or `example.py` for a bigger example.

![](https://raw.github.com/szym/display/master/example.png)

### Tunneling display to localhost
In some cases, such as accessing a remote server using SSH (e.g. AWS, etc.) with a terminal interface, it is not possible to open a browser and navigate to localhost. Alternatively, we can _forward the port_ through SSH. For example, if the display server is running on port 8888 on the remote server, then you SSH using:

ssh -L 8000:localhost:8888 username@example.com

Now, we can access the display server on our local machine on port 8000, or by navigating to `http://0.0.0.0:8000/`.

## <a name='usage'></a> Usage

Each command creates a new window (pane) on the desktop that can be independently positioned, resized, maximized.
Expand Down