RPdb’s Documentation
Welcome to the RPdb documentation. The documentation is divided into several sections. A high-level overview of how it’s organized will help you know where to look for certain things:
- Getting started: Provides a quick overview of our concepts and applications. It will also describe how to intall the different apps
- Concepts: Detailed description of our concepts and all available features
- Rest-API: API documentation of all endpoints and methods to use them
- Clients: Gives instructions for using special features of a specific client
About RPdb
RPdb is a utility that helps you to execute your programs. By installing it on your PC, server or even on a mobile phone you can trigger the execution of a predefined program, script or command with the provided arguments without hesitation from any other device.
That's sounds pretty easy and straight forward, but why do I need this tool? There are some main aspects that make this application unique and so great.
What's so great?
With RPdb you can execute programs remotely without having to be in front of the device or connecting to your server via ssh. The graphical user interface makes it even easier to run your programs.
There are basically two types of executions available:
- execute a program immediately and get the response code and output to the client,
- or schedule your executions so that they take place in the future
RPdb runs on almost all of your devices. The operating systems Windows, Linux and Android are supported. You can even execute commands on your Android smartphone with the help of Tasker.
Security is always a critical point when talking about such a program. The times when placing an ssh key on your devices and limit the rights of the user are over. RPdb acts like a middleware and secures itself with the concept of API Keys.
Yes, you heared right. RPdb even provides a well documented Rest API which makes the integration into other tools easier.
Support
If you have any questions or don't understand parts of the documentation you can reach us on our help page.
Bugs and feature requests
For bugs and feature requests we use the platform GitHub. Just open an issue if you faced an issue or start a discussion for new features we may implement in the future to make RPdb even better.
Screenshots
This is what RPdb looks like from a graphical view. Excuse us for not showing the console applications - but these are just boring.
That's the main overview of entries and the settings page to match your programs or scripts with your attributes.
Of course, RPdb also supports a light mode. For Linux users we even offer a mode in which colors from your GTK theme are used - to integrate RPdb perfectly into your system.
The web interface to manager your user settings, tokens and attributes looks also beautiful. In the screenshots you can see how the token data is displayed, and the modal to configure an attribute.
As in our desktop applications, we support both a light and a dark mode.
Mobile
Mobile devices are also supported in the web ui and via our native android app.
