-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Add a seperate directory for remote server installation guide w…
…ith some outlines and placeholders.
- Loading branch information
1 parent
25d855e
commit 352630b
Showing
33 changed files
with
97 additions
and
2 deletions.
There are no files selected for viewing
4 changes: 2 additions & 2 deletions
4
...react/docs/docs/02-Installation/index.mdx → .../docs/02-Installation Localhost/index.mdx
This file contains 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
14 changes: 14 additions & 0 deletions
14
apps/react/docs/docs/03-Installation Remote Server/00-Prerequisites/index.mdx
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
id: prerequisites | ||
title: 🔍 Prerequisites | ||
--- | ||
|
||
# Prerequisites | ||
|
||
## 💻 Hardware and Software Requirements | ||
|
||
> List the minimum and recommended server specifications for running the platform remotely. | ||
## 🛠️ Initial Setup | ||
|
||
> Step-by-step guide on configuring servers to meet the platform’s operational requirements. May include network configurations as needed. |
22 changes: 22 additions & 0 deletions
22
apps/react/docs/docs/03-Installation Remote Server/01-Installation Guide/index.mdx
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
id: installation | ||
title: 🛠️ Installation Guide | ||
--- | ||
|
||
# Installation Guide | ||
|
||
### Customizing Environment Variables 🛠️ | ||
|
||
> Instructions on how to effectively set and customize environment variables. | ||
### Configuration File Management 📋 | ||
|
||
> Tips on managing .yml/.yaml files, including common tweaks and optimizations. | ||
## 🚀 Installing the WKS Power Platform | ||
|
||
> Detailed steps for installing the platform, including downloading necessary software, deploying services, and initial service configuration. | ||
## ✅ Post-Installation Checks | ||
|
||
> Checklist to ensure everything is set up correctly and running as expected. |
14 changes: 14 additions & 0 deletions
14
...s/docs/03-Installation Remote Server/02-Troubleshooting Common Issues/index.mdx
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
id: troubleshooting-common-issues | ||
title: 👷 Troubleshooting Issues | ||
--- | ||
|
||
# Troubleshooting Common Issues | ||
|
||
## 🔍 Identifying Common Problems | ||
|
||
> A list of frequent issues encountered during remote deployments. | ||
## 🛠️ Recommended Solutions | ||
|
||
> Practical solutions and troubleshooting steps for each listed problem. |
14 changes: 14 additions & 0 deletions
14
...ct/docs/docs/03-Installation Remote Server/03-Security Best Practices/index.mdx
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
id: security-best-practices | ||
title: 🔒 Security Best Practices | ||
--- | ||
|
||
# Security Best Practices | ||
|
||
## 🔑 Keycloak Security Setups | ||
|
||
> Detailed best practices for configuring Keycloak in a remote environment to ensure robust security. | ||
## 🛡️ General Security Tips | ||
|
||
> General advice on maintaining the security integrity of the platform when hosted remotely. |
27 changes: 27 additions & 0 deletions
27
apps/react/docs/docs/03-Installation Remote Server/index.mdx
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
id: installation-guide-remote | ||
title: Installation on Remote Server | ||
--- | ||
|
||
# WKS Platform Installation Guide for Remote Servers | ||
|
||
## 🌟 Introduction | ||
|
||
Multi-tenancy on the WKS Power Platform is designed to provide each tenant with a secure and isolated operational environment, akin to providing separate office suites within a single corporate building. This architecture allows service providers to manage multiple clients efficiently while ensuring that each client's data and operations remain private and secure. | ||
|
||
## 🏛️ Architectural Overview | ||
|
||
### Tenant URL Structure 🌐 | ||
|
||
- Each tenant accesses their environment through a unique subdomain, following the format tenant_id.somedomain.com (e.g., saasCustomer1.wksplatform.com). | ||
- This subdomain serves as the dedicated entry point to the tenant’s specific portion of the platform, ensuring direct and secure access. | ||
|
||
### Keycloak Realms 🔐 | ||
|
||
- Each tenant has a separate Keycloak realm, providing a dedicated security domain that controls authentication and authorization. This setup ensures that user credentials and permissions are managed locally within each tenant's realm, enhancing security and privacy. | ||
- Upon onboarding a new tenant, a realm is specifically created and configured with unique security settings and user management protocols tailored to meet the tenant's needs. | ||
|
||
### MongoDB Databases 🗃️ | ||
|
||
- Each tenant has a separate database to store tenant-specific data securely and maintain complete data isolation between tenants. | ||
- Creating a dedicated MongoDB database for each new tenant setup, ensuring that data from one tenant is completely inaccessible to another. |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -43,4 +43,8 @@ img[alt$="><"] { | |
height: auto; | ||
margin: auto; | ||
float: none!important; | ||
} | ||
|
||
h1 { | ||
margin-top: 1rem; | ||
} |