|
1 | 1 | --- |
2 | 2 | id: cloud-installation |
3 | | -title: Keploy Cloud Installation |
4 | | -sidebar_label: Installation |
| 3 | +title: Keploy Enterprise Installation |
| 4 | +sidebar_label: Enterprise Installation |
5 | 5 | tags: |
6 | 6 | - explanation |
7 | 7 | - feature guide |
8 | | - - keploy cloud |
| 8 | + - keploy enterprise |
9 | 9 | - installation |
10 | 10 | keywords: |
11 | | - - keploy cloud |
| 11 | + - keploy enterprise |
12 | 12 | - installation |
13 | 13 | - API key |
14 | 14 | --- |
15 | 15 |
|
16 | | -## Introduction 📘 |
| 16 | +import ProductTier from '@site/src/components/ProductTier'; |
17 | 17 |
|
18 | | -#### Welcome to the Keploy Cloud Guide! |
| 18 | +<ProductTier tiers="Enterprise" offerings="Self-Hosted, Dedicated" /> |
19 | 19 |
|
20 | | -In this guide, you will find information about Keploy Cloud, onboarding, features, and how to use them. |
| 20 | +This guide provides a complete overview of **Keploy Enterprise**, including onboarding instructions, key features, and steps to get started. It is designed to help teams quickly adopt Keploy Enterprise and integrate it into their development and testing workflows. |
21 | 21 |
|
22 | | -#### Requesting a Keploy Cloud Account |
| 22 | +### Requesting a Keploy Enterprise Account |
23 | 23 |
|
24 | | -To request a Keploy Cloud account, please complete the request form [here](https://forms.gle/jGBbyRyh9H7AKXZX6). Our team will review your request and get back to you as soon as possible. |
| 24 | +To get access to Keploy Enterprise, you’ll first need an enterprise account. |
25 | 25 |
|
26 | | -#### Getting Started with Keploy Cloud |
| 26 | +#### Note: You can request one by reaching out to us [here](https://calendar.app.google/cXVaj6hbMUjvmrnt9). |
27 | 27 |
|
28 | | -Once your account is set up, you can start exploring features of Keploy Cloud. Here are some key features to can get started with: |
| 28 | +--- |
| 29 | + |
| 30 | +### Getting Started with Keploy Enterprise |
29 | 31 |
|
30 | | -- **Time Freezing** ❄️: Keploy Cloud allows you to freeze/rollback the time in every test run, back to when the test case was recorded. This allows developers to ensure time-sensitive objects don’t expire or change, making tests consistent and more reliable. |
| 32 | +Once your enterprise account is set up, you can begin exploring and using the core features of Keploy Enterprise. Below are some of the key capabilities that help teams achieve reliable, scalable, and production-grade API testing. |
31 | 33 |
|
32 | | -- **AI-Driven Test Generation** 🧠: Keploy will automatically uncover your API's edge cases and generate test cases to expose more code paths, thereby increasing code coverage. |
| 34 | +- **Time Freezing** ❄️ |
| 35 | + Keploy Enterprise allows you to freeze or roll back time during every test run to the exact moment when the test case was recorded. This ensures that time-sensitive data does not expire or change, making test executions consistent and highly reliable. |
33 | 36 |
|
34 | | -- **Test Deduplication** 📊 : Keploy detects duplicate/redundant tests automatically, which will be particularly useful if you plan to record numerous scenarios from a live environment and wish to retain only unique scenario tests. |
| 37 | +- **AI-Driven Test Generation** 🧠 |
| 38 | + Keploy Enterprise automatically identifies edge cases in your APIs and generates test cases to uncover additional execution paths. This helps improve overall code coverage and detect issues that are often missed in manual testing. |
35 | 39 |
|
36 | | -- **Keploy Console** 📈: We are ensuring a smooth experience of visualising bugs found with Keploy and sharing reports with your team. |
| 40 | +- **Test Deduplication** 📊 |
| 41 | + Keploy Enterprise intelligently detects and removes duplicate or redundant test cases. This is especially useful when recording scenarios from live environments, allowing teams to retain only meaningful and unique test coverage. |
37 | 42 |
|
38 | | -- **Asynchronous Processes Support** ⏱ : Keploy V2 captures and replays asynchronous tasks effectively. We're also incorporating support for adding custom user-defined behaviours or assertions. |
| 43 | +- **Keploy Console** 📈 |
| 44 | + The Keploy Console provides a seamless experience for visualizing bugs, analyzing test results, and sharing reports across teams. It enables better collaboration and faster feedback cycles. |
39 | 45 |
|
40 | | -- **Mock Registry** 📂: The Mock Registry is a system designed to handle large mock files by uploading them to cloud storage, preventing these sizable files from being committed to Git repositories. This approach optimizes repository size and performance while maintaining an efficient and streamlined development workflow. |
| 46 | +- **Asynchronous Processes Support** ⏱ |
| 47 | + Keploy v2 effectively captures and replays asynchronous workflows. In addition, support for custom user-defined behaviors and assertions is being incorporated to provide greater flexibility in testing complex systems. |
41 | 48 |
|
42 | | -To get started with Keploy Cloud, you will need to install the Keploy Cloud Agent and authenticate your account. |
| 49 | +- **Mock Registry** 📂 |
| 50 | + The Mock Registry is designed to manage large mock files by storing them in cloud storage instead of committing them to Git repositories. This helps keep repositories lightweight while ensuring efficient mock management at scale. |
| 51 | + |
| 52 | +To begin using Keploy Enterprise, you need to install the **Keploy Enterprise Agent** and authenticate using your API key. |
| 53 | + |
| 54 | +--- |
43 | 55 |
|
44 | 56 | ## Installation 🛠️ |
45 | 57 |
|
46 | | -Install and Validate the Keploy Cloud Agent by following the steps below: |
| 58 | +Follow the steps below to install and validate the Keploy Enterprise Agent: |
47 | 59 |
|
48 | 60 | ```bash |
49 | 61 | curl --silent -O -L https://keploy.io/ent/install.sh && source install.sh |
50 | 62 | ``` |
51 | 63 |
|
52 | | -Enter your **API Key** when prompted, ask your org Admin to re-regenerate the API key in case you lose it. |
| 64 | +When recording API calls using the Enterprise Agent, you will be prompted to provide your **API key**. |
53 | 65 |
|
54 | | -Once validated, you can start using Keploy Cloud to record-test. |
| 66 | +An API key typically looks like this: |
55 | 67 |
|
56 | | -### Need Help? |
| 68 | +``` |
| 69 | +b1dNl.... |
| 70 | +``` |
57 | 71 |
|
58 | | -If you have any questions or need assistance, our support team is here to help. You can reach out to us through our support portal, Slack or by emailing us at hello[at]keploy.io. |
| 72 | +Once the API key is successfully validated, the Keploy Enterprise Agent will begin recording API calls. |
0 commit comments