# OpenRport Docs

## Rport Documentation

- [OpenRPort Knowledge Base](https://kb.openrport.io/openrport-knowledge-base.md): Learn how to use OpenRPort
- [Features and benefits of RPort](https://kb.openrport.io/what-is-rport/features-and-benefits-of-rport.md)
- [Full feature list](https://kb.openrport.io/what-is-rport/features-and-benefits-of-rport/full-feature-list.md)
- [Screenshots](https://kb.openrport.io/what-is-rport/screenshots.md)
- [Install the RPort Server](https://kb.openrport.io/getting-started/install-the-rport-server.md)
- [Install on-premises](https://kb.openrport.io/getting-started/install-the-rport-server/install-on-premises.md): Learn how to install the rport server inside your intranet on your own (virtual) server.
- [Install RPort on any virgin cloud VM](https://kb.openrport.io/getting-started/install-the-rport-server/install-rport-on-any-virgin-cloud-vm.md): Learn how to install the RPort server on any public cloud-based virtual machine.
- [Enable two factor authentication](https://kb.openrport.io/getting-started/install-the-rport-server/enable-two-factor-authentication.md): Add an extra layer of security to your account
- [Use push on mobile for 2FA](https://kb.openrport.io/getting-started/install-the-rport-server/enable-two-factor-authentication/use-push-on-mobile-for-2fa.md): Use the Pushover app to receive one-time tokens
- [Use TOTP](https://kb.openrport.io/getting-started/install-the-rport-server/enable-two-factor-authentication/use-totp.md): Learn how to use any rfc6238 compliant token generator, e.g. Google or Microsoft authenticator
- [Connecting Clients](https://kb.openrport.io/getting-started/connecting-clients.md): Connect client for remote management
- [Using the remote access](https://kb.openrport.io/getting-started/using-the-remote-access.md): Log in to any server from everywhere via SSH or Remote Desktop
- [Creating tunnels](https://kb.openrport.io/getting-started/using-the-remote-access/creating-tunnels.md): Get access to any remote TCP port
- [VNC via browser](https://kb.openrport.io/getting-started/using-the-remote-access/creating-tunnels/vnc-via-browser.md): Use the browser for VNC connections
- [RDP via Browser](https://kb.openrport.io/getting-started/using-the-remote-access/rdp-via-browser.md): Use the browser to access the remote desktop
- [Open SSH from the browser](https://kb.openrport.io/getting-started/using-the-remote-access/open-ssh-from-the-browser.md): Learn how to open SSH connections directly from the browser
- [Scp,sftp through a tunnel](https://kb.openrport.io/getting-started/using-the-remote-access/scp-sftp-through-a-tunnel.md): Learn how to copy files through a tunnel using scp or sftp
- [Renaming and tagging of clients](https://kb.openrport.io/getting-started/renaming-and-tagging-of-clients.md): Change clients names and add more tags
- [Organize clients with groups](https://kb.openrport.io/getting-started/organize-clients-with-groups.md)
- [Activate the vault](https://kb.openrport.io/getting-started/activate-the-vault.md)
- [Manage users and permissions](https://kb.openrport.io/getting-started/manage-users-and-permissions.md)
- [Troubleshoot common problems](https://kb.openrport.io/need-help/troubleshoot-common-problems.md): Learn how to resolve common issues quickly
- [Restart rport through a tunnel](https://kb.openrport.io/need-help/troubleshoot-common-problems/restart-rport-through-a-tunnel.md): How to restart the rport client safely when connected via tunnel
- [Attributes file path not set](https://kb.openrport.io/need-help/troubleshoot-common-problems/attributes-file-path-not-set.md): How to solve the “attributes file path not set” error
- [Recover lost passwords](https://kb.openrport.io/need-help/troubleshoot-common-problems/recover-lost-passwords.md): Learn how to get access to the RPort server if you have lost all password
- [Client is not connecting](https://kb.openrport.io/need-help/troubleshoot-common-problems/client-is-not-connecting.md): If a client does not connect, likely a firewall causes the problem. Let's check this quickly from the command line.
- [Id is already in use](https://kb.openrport.io/need-help/troubleshoot-common-problems/id-is-already-in-use.md): Solve connection errors caused by duplicated ids
- [Using the API](https://kb.openrport.io/digging-deeper/using-the-api.md): RPort comes with a Restful API that enabled you to integrate RPort into your projects.
- [Create client credentials](https://kb.openrport.io/digging-deeper/using-the-api/create-client-credentials.md): For mass-deployment
- [RPort Technology Explained](https://kb.openrport.io/digging-deeper/rport-technology-explained.md): What happens behind the scenes
- [Commands and Scripts](https://kb.openrport.io/digging-deeper/commands-and-scripts.md): Learn how to execute command and scripts from the browser without an interactive login.
- [Executing commands](https://kb.openrport.io/digging-deeper/commands-and-scripts/executing-commands.md): Execute command on a single client
- [Executing scripts](https://kb.openrport.io/digging-deeper/commands-and-scripts/executing-scripts.md): Learn how to execute scripts directly from the browser or via the API
- [Tacoscript](https://kb.openrport.io/digging-deeper/commands-and-scripts/tacoscript.md): RPort provides its own scripting language to make complex tasks easy.
- [The scheduler](https://kb.openrport.io/digging-deeper/the-scheduler.md): Learn how to schedule scripts or command on a single client or on multiple clients concurrently
- [File copy and reception](https://kb.openrport.io/digging-deeper/file-copy-and-reception.md): Learn how to transfer files from your local desktop to remote clients
- [Client Configuration Options](https://kb.openrport.io/digging-deeper/client-configuration-options.md): Fine tune the client configuration
- [Supervision of OS updates](https://kb.openrport.io/digging-deeper/client-configuration-options/supervision-of-os-updates.md): Starting with rport client version 0.2.4 the supervision of available operating system updates is possible
- [Script and command execution](https://kb.openrport.io/digging-deeper/client-configuration-options/script-and-command-execution.md)
- [Advanced client management](https://kb.openrport.io/digging-deeper/advanced-client-management.md)
- [Install the RPort client manually](https://kb.openrport.io/digging-deeper/advanced-client-management/install-the-rport-client-manually.md): Install the client on any device manually
- [Uninstall the RPort client](https://kb.openrport.io/digging-deeper/advanced-client-management/uninstall-the-rport-client.md): Learn how to remove the client
- [Run with SELinux](https://kb.openrport.io/digging-deeper/advanced-client-management/run-with-selinux.md)
- [Server Maintenance](https://kb.openrport.io/digging-deeper/server-maintenance.md)
- [Monitoring of RPortd](https://kb.openrport.io/digging-deeper/server-maintenance/monitoring-of-rportd.md): Get notified about issues with your rport server
- [Updating RPort](https://kb.openrport.io/digging-deeper/server-maintenance/updating-rport.md): RPort is under active development. Keep your installation up-to-date.
- [Backing up the rport server](https://kb.openrport.io/digging-deeper/server-maintenance/backing-up-the-rport-server.md): Perform regular backups
- [Renewing certificates](https://kb.openrport.io/digging-deeper/server-maintenance/renewing-certificates.md): Set up auto-renewal of Let's encrypt certificates
- [FAQ](https://kb.openrport.io/digging-deeper/faq.md)
- [How to use Cloudflare](https://kb.openrport.io/digging-deeper/faq/how-to-use-cloudflare.md): Q: I can use a Cloudflare proxy in front of my rport server?


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://kb.openrport.io/openrport-knowledge-base.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.