Docs / Obsidian Remote / Reference
Settings
Open Settings with the gear button at the top right of the main window, or from the tray icon's menu. The pages are listed on the left. Changes take effect when you click OK; Cancel throws them away.
The Security page and This PC's server on the Network page are settings of this PC as a remote PC, the part that lets people in. Changing them needs the person signed in at this PC or an administrator, and needs that part to be running (otherwise the page says so). Settings your organization sets by policy are greyed out, with a note saying the server policy sets them.
General
| Setting | What it does |
|---|---|
| Colour theme | The app's colours: one of the Obsidian themes, Windows (light or dark) to follow Windows, Light or Dark. Takes effect the next time the app starts. |
| Start Obsidian Remote when I sign in to Windows | Opens the app when you sign in. |
| Start in the notification area (no window) | Starts it in the tray, without opening the main window. |
Unattended access needs neither: on an installed PC the service runs without anyone signed in.
Security
Accepting connections
How someone gets in to this PC:
- Password, or the person at this PC clicks Accept (the default),
- Password only (unattended),
- Only when the person at this PC clicks Accept.
See Letting someone connect and Unattended access.
Scam protection
Warn about first-time viewers (on): the first time someone connects, the request warns about phone scams, Deny comes first and Accept waits 10 seconds, and a one-time password typed by someone new needs your Accept. Only an administrator can turn it off (on an installed copy; on a portable copy only your organization's policy can), for PCs its own staff connect to every day. While someone controls the PC, a bar on top of every screen says so and Esc pressed twice ends it - that always stays.
The line below says how many viewers have connected to you before (they get the normal request). Treat them all as first-time again forgets them - useful if you let someone in you shouldn't have.
One-time password
| Setting | What it does |
|---|---|
| Use a one-time password | Show and accept a one-time password. On by default. |
| Length | 6 to 16 characters; 8 by default. |
| A new one after every session | Change it after each session that used it. On by default. |
Permanent password
Type a password of at least 8 characters into New permanent password and Again to set or change it. Remove the permanent password removes it when you click OK. It is stored only in a scrambled form. If your organization doesn't allow permanent passwords, the page says so.
On a PC with several Windows users, each user who is not an administrator has their own permanent password and their own choices for how connections are accepted: setting yours leaves theirs alone. Yours works while you are signed in at the PC, and at the sign-in screen while nobody is. A permanent password set by an administrator (in the app started with Run as administrator) works always and replaces everyone's own.
Two-factor sign-in
Set up two-factor sign-in..., Turn off two-factor sign-in, the number of remembered viewers and Forget remembered viewers. See Two-factor sign-in.
Direct connections
| Setting | What it does |
|---|---|
| Accept direct connections from the local network | Viewers on the same network connect straight to this PC instead of through the relay. On by default. |
| Allow direct IP access without the server | Also accept people who connect to this PC's address without your server. Off by default: anyone who can reach this PC's port can then try the password, so only turn it on in a network you trust. |
| Port | The port for direct connections; 21118 by default. |
| Answer LAN discovery (show up in other PCs' Discovered list) | On by default. |
| Only allow viewers from these addresses | One address or range per line, for example 10.0.0.0/8 or 203.0.113.10. Empty means from anywhere. |
See Local network and Wake-on-LAN.
What viewers may do
The permissions a new session starts with: Mouse and keyboard, Clipboard, File transfer, Sound, Restart, sign out, shut down, Recording on the viewer's side, TCP tunnels, Terminal, Block my mouse and keyboard and Privacy mode (black out my screen). All are ticked at first. The connection manager can narrow them for each session, but never widen them.
Sessions
| Setting | What it does |
|---|---|
| Disconnect idle sessions after (minutes, 0 = never) | Ends a session that had no input from the viewer for that long. |
| Lock this PC when a session ends | Locks Windows when the last session ends. |
| Allow a terminal at the sign-in screen (runs as SYSTEM) | Lets the terminal work while nobody is signed in, with the PC's system account. Only an administrator can change it. Not available on a portable copy. |
Network
| Setting | What it does |
|---|---|
| This PC's server | The client config string of the server this PC registers with, for example host=remote.example.com:21114;key=.... Empty: this PC is reachable on the local network only. The line under the box says what the app understood. |
| Server for connecting | The server used to reach other PCs by ID. Empty: the same as this PC's server. |
| Account | Whether you are signed in to your server, with Sign in... (or Sign in again...). See The main window. |
Display
What new sessions start with. Each session's toolbar can change these for that session.
| Setting | What it does |
|---|---|
| Picture | Best picture, Balanced (the default), Fastest response or Custom. |
| Custom: frames per second | 5 to 120; 30 by default. |
| Custom: bit rate (kbit/s, 0 = automatic) | 0 by default. |
| Scale | Fit the window (the default), Original size or Stretch. |
| Show the remote cursor | On by default. |
| Keyboard sends characters (this PC's layout) instead of physical keys | Off by default. See Keyboard, mouse and clipboard. |
| Sync the clipboard | On by default. |
| Play the remote PC's sound | On by default. |
Recording
Folder: where session recordings go; Videos\Obsidian Remote unless you choose another. Choose... picks a folder and Open the folder opens it. See Chat, sound, recording and screenshots.
About
- The app's version, and the version and mode of this PC's host (installed or portable) with its ID.
- This PC's key: read it to someone connecting to this PC by address, so they can check they reached the right PC.
- Updates: Check for updates by itself and Check now. See Updates.
- Licences of the components Obsidian Remote uses and Open the log folder.
Where things are kept
| What | Where |
|---|---|
| The app's settings, Recent and Favourites, the keys of PCs you connected to, remembered two-factor sign-ins | %LocalAppData%\ObsidianRemote\viewer |
| The app's log files | %LocalAppData%\ObsidianRemote\viewer\logs |
| This PC's settings, ID and key (installed) | %ProgramData%\ObsidianRemote (SYSTEM and administrators only) |
| This PC's settings, ID and key (portable) | %LocalAppData%\ObsidianRemote |
| Recordings and screenshots | Videos\Obsidian Remote and Pictures\Obsidian Remote |