move on-premise docs to github - #17
Closed
mohammad-anees-khan wants to merge 3 commits into
Closed
Conversation
There was a problem hiding this comment.
Pull request overview
Moves Cryptlex On-premise documentation into the repository by expanding README.md and adding a set of Markdown docs under docs/ (including installation guides).
Changes:
- Replaced the minimal README with an overview, feature list, deployment notes, and doc entrypoints.
- Added new documentation pages for overview, system requirements, server layout, client library configuration, monitoring, and Docker/Kubernetes installation guides.
Reviewed changes
Copilot reviewed 8 out of 10 changed files in this pull request and generated 14 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Reworked README into a full landing page + documentation index. |
| docs/000-overview.md | Adds high-level On-premise overview doc. |
| docs/010-system-requirements.md | Adds OS/software/resource requirements doc. |
| docs/015-server-layout.md | Adds deployment layout guidance and diagram link. |
| docs/020-Installation-Guide/0200-docker.md | Adds Docker Compose installation + upgrade guide. |
| docs/020-Installation-Guide/0205-kubernetes.md | Adds Kubernetes/Helm-based installation guide. |
| docs/025-configuring-client-libraries.md | Adds SDK/agent endpoint configuration instructions. |
| docs/030-monitoring-your-instance.md | Adds New Relic/Bugsnag monitoring instructions. |
Comments suppressed due to low confidence (1)
docs/020-Installation-Guide/0200-docker.md:211
<Alert>...</Alert>is used again here; GitHub won’t render this as a styled admonition. Convert this to GitHub-supported admonitions or plain Markdown callouts for consistent rendering.
```bash
docker compose logs -t -f
Note: The average downtime during the update is less than 1 minute.
</details>
---
💡 <a href="/cryptlex/cryptlex-on-premise/new/master?filename=.github/instructions/*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.
adnan-kamili
reviewed
Jun 8, 2026
adnan-kamili
reviewed
Jun 8, 2026
|
|
||
| ### Using Docker Compose | ||
|
|
||
| All of the Cryptlex Docker images are available on [Docker Hub](https://hub.docker.com/u/cryptlex). If you’re looking for a complete configuration to get up and running quickly, use our [Docker Compose](https://github.com/cryptlex/cryptlex-on-premise) example and follow the steps below. |
Contributor
There was a problem hiding this comment.
This line is self referecning itself
adnan-kamili
reviewed
Jun 8, 2026
adnan-kamili
reviewed
Jun 8, 2026
adnan-kamili
reviewed
Jun 8, 2026
| # Cryptlex On-premise | ||
|
|
||
| Cryptlex On-premise offers a self-hosted version of Cryptlex for organizations that need or want to manage their own data. It can be run in your existing environments. | ||
| ## Self hosted licensing infrastructure for Cryptlex |
Contributor
There was a problem hiding this comment.
not sure this title is correct
Collaborator
Author
There was a problem hiding this comment.
will use a better title
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.