> For the complete documentation index, see [llms.txt](https://docs.steadybit.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.steadybit.com/install-and-configure/install-on-prem-platform.md). # Install On-Prem Platform {% hint style="info" %} This part of the documentation is only intended in the context of a supported PoC (Proof of Concept) together with the Steadybit team. Please, [book an appointment](https://www.steadybit.com/book-demo) to scope your PoC before continuing to evaluate the on-prem solution. If you just want to try out Steadybit, we recommend you [sign up for our SaaS platform](https://signup.steadybit.com). {% endhint %} This guide helps you with the initial installation and deployment of our Steadybit platform On-Premise. It is explicitly of use for spaces where it is not yet possible to take advantage of our Software as a Service (SaaS) platform and the need to host our platform yourself. After completing this getting started, continue by [setting up Steadybit](/install-and-configure/install-agent.md). Installing and deploying the Steadybit platform on your servers is simple: * [Step 0 - Check Prerequisites](#step-0-check-prerequisites) * [Step 1 - Get your keys](#step-1-get-your-keys) * [Step 2 - Deploy Platform](#step-2-deploy-platform) If you need help, please [reach out to us](https://www.steadybit.com/contact). ## Step 0 - Check Prerequisites Before continuing, make sure that access to the following URLs via HTTPS (443) is possible from your location of installation: * and (Docker Image) * (Agent Linux Installation) * (Setup Scripts) * (when using Kubernetes and helm) The platform itself exposes the following ports: * Port `8080`: Application port for UI/API/agents * Port `7878`: Websocket port for agents ## Step 1 - Get your keys To install the platform on-premise and connect the agents against it you need an agent key and a valid license.\ Get in touch with us, and we will provide you an on-prem license key and an agent key. The agent key is also used to authenticate against our Docker registry `docker.steadybit.io` hosting the platform images. The username is `_` and the password is the agent key. ## Step 2 - Deploy Platform It is our goal to make the installation as easy as possible for you, that's why we recommend you to use our Helm chart that takes a lot of the work out of it and only requires a few parameters from you. If you are not familiar with Helm and would like to learn more about it, check out [helm's QuickStart](https://helm.sh/docs/intro/quickstart/) {% hint style="info" %} In case you can't use Helm or Kubernetes at all, get in touch with us and we'll find the best solution. The platform can be deployed without Helm and also on plain Docker hosts. When pulling the platform images manually, e.g., on plain Docker hosts or to mirror them into an internal registry, log in to our Docker registry first using your agent key from [Step 1 - Get your keys](#step-1-get-your-keys): ```bash docker login docker.steadybit.io --username _ --password ``` {% endhint %} Please replace the placeholders `replace-with-agent-key` and `replace-with-license-key` with your agent key and license key of [Step 1 - Get your keys](#step-1-get-your-keys): ```bash helm repo add steadybit https://steadybit.github.io/helm-charts helm repo update helm install steadybit-platform \ --create-namespace \ --namespace steadybit-platform \ --set platform.tenant.agentKey= \ --set platform.tenant.license= \ steadybit/steadybit-platform ``` The Helm chart automatically creates the Kubernetes image pull secret for `docker.steadybit.io` from your agent key, so no manual `docker login` is required. To make it convenient for you, we have a default for everything. That's also why we include the necessary Postgres database and set up everything for you automatically. Nevertheless, feel free to adjust parameters after having a look on the helm chart in our public [GitHub repository](https://github.com/steadybit/helm-charts/tree/master/charts/steadybit-platform). > **BE AWARE:** The database is not backed up and if the pod is deleted the data is lost! > > For productive usage, we strongly recommend to setup your own Postgres database and configure the Steadybit platform as described [here](/install-and-configure/install-on-prem-platform/advanced-configuration.md). ## What's next? Done, the platform is running. The default login for the on-prem platform is * username: `admin` * password: `admin` Now you can set it up by connecting the first agents to it. We'll show you how to do that in our getting started [Set up Platform & Agents](/quick-start/set-up-agents.md), at step 1. ### Productive Usage As mentioned above, this getting started helped to set up quickly a Steadybit platform. Before using Steadybit * configure your own Postgres database as [described here](/install-and-configure/install-on-prem-platform/advanced-configuration.md#database-configuration). * we recommend to use your internal authorization services such as LDAP or OIDC provider as [described here](/install-and-configure/install-on-prem-platform/advanced-configuration.md#ldap-authentication). ### Advanced Configuration More configuration options can be found in [Advanced Configuration](/install-and-configure/install-on-prem-platform/advanced-configuration.md) ### Troubleshooting If you have any problems, check our [Troubleshooting](/troubleshooting/common-fixes/on-prem-platform.md) page. Or please [reach out to us](https://www.steadybit.com/contact). --- # 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 that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.steadybit.com/install-and-configure/install-on-prem-platform.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.