chore: add custom ssl feature added in documentation

tanmoysrt · tanmoysrt · commit 8be82098f14e · 2024-11-09T20:58:08.000+05:30
diff --git a/docs/contribution_guideline.md b/docs/contribution_guideline.md
@@ -12,7 +12,7 @@ First off, thanks for having interest in contributing to SwiftWave! 🎉
 We have couple of projects under SwiftWave organization. You can contribute to any of them.
 
 | Project                       | Description                                                                     | Tech Stack         | GitHub Link                                                   | Setup Guide                                                   |
-| ----------------------------- | ------------------------------------------------------------------------------- | ------------------ | ------------------------------------------------------------- |---------------------------------------------------------------|
+| ----------------------------- | ------------------------------------------------------------------------------- | ------------------ | ------------------------------------------------------------- | ------------------------------------------------------------- |
 | SwiftWave                     | Core PaaS                                                                       | Golang             | [Click Here](https://github.com/swiftwave-org/swiftwave)      | [Click Here](./development_setup)                             |
 | Dashboard                     | Web interface for SwiftWave.                                                    | VueJS, TailwindCSS | [Click Here](https://github.com/swiftwave-org/dashboard)      | [Click Here](https://github.com/swiftwave-org/dashboard)      |
 | UDPProxy                      | Custom UDP Proxy to forward UDP traffic from outside word to internal services. | Golang             | [Click Here](https://github.com/swiftwave-org/udpproxy)       | [Click Here](https://github.com/swiftwave-org/udpproxy)       |
@@ -39,5 +39,5 @@ We have couple of projects under SwiftWave organization. You can contribute to a
 - Please follow the [**Conventional Commit Message  Guidelines**](https://www.conventionalcommits.org/en/v1.0.0/) while writing commit messages.
 
 ### 📌 Need Help?
-- You can join our Slack Workspace and ask your queries in **#general** channel.
-  - **Joining Link :** [slack.swiftwave.org](https://slack.swiftwave.org/)
+- You can join our Discord Workspace and ask your queries in **#new-contributors** channel.
+  - **Joining Link :** [community.swiftwave.org](https://community.swiftwave.org)
diff --git a/docs/dashboard/domains.md b/docs/dashboard/domains.md
@@ -6,7 +6,7 @@ sidebar_position: 10
 
 In **Domains** section, you can manage all the custom domains you have added to swiftwave.
 
-![Domains List](/assets/2.0.x/domain-list.png)
+![Domains List](/assets/2.2.x/domain-list.png)
 
 ### Register a new domain
 You can click on `Register New` button and fill in the required details to register a new domain.
@@ -30,7 +30,43 @@ You can click on `Verify DNS` button to verify if domain is correctly pointing t
 
 
 ### Issue SSL Certificate 🛡️
-Swiftwave has Let's Encrypt integration. You can issue a SSL certificate for your domain by clicking on `Issue SSL` button.
 
-### SSL Auto Renewal
-From V2, Swiftwave supports SSL auto renewal. You don't need to worry about renewing your SSL certificate manually.
+You can issue a SSL certificate automatically via Let's Encrypt or by manually providing SSL certificate and private key.
+
+- **Issue Automatically via Let's Encrypt**
+
+  Swiftwave has Let's Encrypt integration. You can issue a SSL certificate for your domain by clicking on `Issue SSL` button.
+
+  ![Issue SSL via Let's Encrypt](/assets/2.2.x/letsencrypt-ssl-issue.png)
+
+  :::tip
+
+  If you issue SSL certificate via Let's Encrypt, you don't need to worry about renewing your SSL certificate manually. Swiftwave will automatically renew your SSL certificate before it expires.
+
+  :::
+
+- **Add Custom SSL Certificate**
+
+  - Click on `Issue SSL` button.
+  - Choose `Custom SSL Certificate` option.
+
+    ![Add Custom SSL](/assets/2.2.x/add-custom-ssl.png)
+
+  - Now, provide your SSL certificate and private key in valid OpenSSL format.
+    > **🤝 Need help to generate self-signed SSL certificate ?**
+    > 
+    > You can run following command to generate private key and self-signed certificate.
+    > ```bash
+    > openssl req -x509 -newkey rsa:1024 -keyout key.pem -out cert.pem -sha256 -days 365 -nodes
+    > ```
+  - Submit and done !
+  - It will take few minutes to apply the changes.
+
+    :::warning
+
+    You should only use this option 
+    - if you can't open your server's port 80 and 443 to the internet due to security reasons. 
+    - Also, you may have purchased SSL certificate from a third party and you want to use it.
+    - If you just want to use self-signed certificate, you can go with this option.
+
+    :::
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -233,8 +233,8 @@ const config = {
             title: "Links",
             items: [
               {
-                label: "Join Slack",
-                to: "https://slack.swiftwave.org/",
+                label: "Join Discord",
+                to: "https://community.swiftwave.org",
               },
               {
                 label: "Visit GitHub",
diff --git a/static/assets/2.2.x/add-custom-ssl.png b/static/assets/2.2.x/add-custom-ssl.png
diff --git a/static/assets/2.2.x/domain-list.png b/static/assets/2.2.x/domain-list.png
diff --git a/static/assets/2.2.x/letsencrypt-ssl-issue.png b/static/assets/2.2.x/letsencrypt-ssl-issue.png
diff --git a/versioned_docs/version-1.x.x/contribution_guideline.md b/versioned_docs/version-1.x.x/contribution_guideline.md
@@ -11,12 +11,12 @@ First off, thanks for having interest in contributing to SwiftWave! 🎉
 
 We have couple of projects under SwiftWave organization. You can contribute to any of them.
 
-| Project | Description | Tech Stack | GitHub Link | Setup Guide                                                  |
-| --- | --- | --- | --- |--------------------------------------------------------------|
-| SwiftWave | Core PaaS | Golang, Docker | [Click Here](https://github.com/swiftwave-org/swiftwave) | [Click Here](./development_setup)                            |
-| SwiftWave Dashboard | Web interface for SwiftWave. | VueJS, TailwindCSS | [Click Here](https://github.com/swiftwave-org/dashboard) | [Click Here](https://github.com/swiftwave-org/dashboard)     |
-| SwiftWave Docs + Landing Page | Official landing page and documentation website | Docusaurus | [Click Here](https://github.com/swiftwave-org/swiftwave.org) | [Click Here](https://github.com/swiftwave-org/swiftwave.org) |
-| Quick DNS | Service to provide ***.swiftwave.xyz** domain for your swiftwave installation | Golang | [Click Here](https://github.com/swiftwave-org/dns) | [Click Here](https://github.com/swiftwave-org/dns)           |
+| Project                       | Description                                                                   | Tech Stack         | GitHub Link                                                  | Setup Guide                                                  |
+| ----------------------------- | ----------------------------------------------------------------------------- | ------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| SwiftWave                     | Core PaaS                                                                     | Golang, Docker     | [Click Here](https://github.com/swiftwave-org/swiftwave)     | [Click Here](./development_setup)                            |
+| SwiftWave Dashboard           | Web interface for SwiftWave.                                                  | VueJS, TailwindCSS | [Click Here](https://github.com/swiftwave-org/dashboard)     | [Click Here](https://github.com/swiftwave-org/dashboard)     |
+| SwiftWave Docs + Landing Page | Official landing page and documentation website                               | Docusaurus         | [Click Here](https://github.com/swiftwave-org/swiftwave.org) | [Click Here](https://github.com/swiftwave-org/swiftwave.org) |
+| Quick DNS                     | Service to provide ***.swiftwave.xyz** domain for your swiftwave installation | Golang             | [Click Here](https://github.com/swiftwave-org/dns)           | [Click Here](https://github.com/swiftwave-org/dns)           |
 
 ### 📝 How to Contribute to any of the project
 1. Fork the repository
@@ -35,5 +35,5 @@ We have couple of projects under SwiftWave organization. You can contribute to a
 - Please follow the [**Conventional Commit Message  Guidelines**](https://www.conventionalcommits.org/en/v1.0.0/) while writing commit messages.
 
 ### 📌 Need Help?
-- You can join our [**Slack Workspace**](https://slack.swiftwave.org/) and ask your queries in **#general** channel.
-  - Joining Link: [s**lack.swiftwave.org**](https://slack.swiftwave.org/)
+- You can join our Discord Workspace and ask your queries in **#new-contributors** channel.
+  - **Joining Link :** [community.swiftwave.org](https://community.swiftwave.org)
diff --git a/versioned_docs/version-2.0.x/contribution_guideline.md b/versioned_docs/version-2.0.x/contribution_guideline.md
@@ -12,7 +12,7 @@ First off, thanks for having interest in contributing to SwiftWave! 🎉
 We have couple of projects under SwiftWave organization. You can contribute to any of them.
 
 | Project                       | Description                                                                     | Tech Stack         | GitHub Link                                                   | Setup Guide                                                   |
-| ----------------------------- | ------------------------------------------------------------------------------- | ------------------ | ------------------------------------------------------------- |---------------------------------------------------------------|
+| ----------------------------- | ------------------------------------------------------------------------------- | ------------------ | ------------------------------------------------------------- | ------------------------------------------------------------- |
 | SwiftWave                     | Core PaaS                                                                       | Golang             | [Click Here](https://github.com/swiftwave-org/swiftwave)      | [Click Here](./development_setup)                             |
 | Dashboard                     | Web interface for SwiftWave.                                                    | VueJS, TailwindCSS | [Click Here](https://github.com/swiftwave-org/dashboard)      | [Click Here](https://github.com/swiftwave-org/dashboard)      |
 | UDPProxy                      | Custom UDP Proxy to forward UDP traffic from outside word to internal services. | Golang             | [Click Here](https://github.com/swiftwave-org/udpproxy)       | [Click Here](https://github.com/swiftwave-org/udpproxy)       |
@@ -39,5 +39,5 @@ We have couple of projects under SwiftWave organization. You can contribute to a
 - Please follow the [**Conventional Commit Message  Guidelines**](https://www.conventionalcommits.org/en/v1.0.0/) while writing commit messages.
 
 ### 📌 Need Help?
-- You can join our Slack Workspace and ask your queries in **#general** channel.
-  - **Joining Link :** [slack.swiftwave.org](https://slack.swiftwave.org/)
+- You can join our Discord Workspace and ask your queries in **#new-contributors** channel.
+  - **Joining Link :** [community.swiftwave.org](https://community.swiftwave.org)
diff --git a/versioned_docs/version-2.1.x/contribution_guideline.md b/versioned_docs/version-2.1.x/contribution_guideline.md
@@ -12,7 +12,7 @@ First off, thanks for having interest in contributing to SwiftWave! 🎉
 We have couple of projects under SwiftWave organization. You can contribute to any of them.
 
 | Project                       | Description                                                                     | Tech Stack         | GitHub Link                                                   | Setup Guide                                                   |
-| ----------------------------- | ------------------------------------------------------------------------------- | ------------------ | ------------------------------------------------------------- |---------------------------------------------------------------|
+| ----------------------------- | ------------------------------------------------------------------------------- | ------------------ | ------------------------------------------------------------- | ------------------------------------------------------------- |
 | SwiftWave                     | Core PaaS                                                                       | Golang             | [Click Here](https://github.com/swiftwave-org/swiftwave)      | [Click Here](./development_setup)                             |
 | Dashboard                     | Web interface for SwiftWave.                                                    | VueJS, TailwindCSS | [Click Here](https://github.com/swiftwave-org/dashboard)      | [Click Here](https://github.com/swiftwave-org/dashboard)      |
 | UDPProxy                      | Custom UDP Proxy to forward UDP traffic from outside word to internal services. | Golang             | [Click Here](https://github.com/swiftwave-org/udpproxy)       | [Click Here](https://github.com/swiftwave-org/udpproxy)       |
@@ -39,5 +39,5 @@ We have couple of projects under SwiftWave organization. You can contribute to a
 - Please follow the [**Conventional Commit Message  Guidelines**](https://www.conventionalcommits.org/en/v1.0.0/) while writing commit messages.
 
 ### 📌 Need Help?
-- You can join our Slack Workspace and ask your queries in **#general** channel.
-  - **Joining Link :** [slack.swiftwave.org](https://slack.swiftwave.org/)
+- You can join our Discord Workspace and ask your queries in **#new-contributors** channel.
+  - **Joining Link :** [community.swiftwave.org](https://community.swiftwave.org)
diff --git a/versioned_docs/version-2.2.x/contribution_guideline.md b/versioned_docs/version-2.2.x/contribution_guideline.md
@@ -12,7 +12,7 @@ First off, thanks for having interest in contributing to SwiftWave! 🎉
 We have couple of projects under SwiftWave organization. You can contribute to any of them.
 
 | Project                       | Description                                                                     | Tech Stack         | GitHub Link                                                   | Setup Guide                                                   |
-| ----------------------------- | ------------------------------------------------------------------------------- | ------------------ | ------------------------------------------------------------- |---------------------------------------------------------------|
+| ----------------------------- | ------------------------------------------------------------------------------- | ------------------ | ------------------------------------------------------------- | ------------------------------------------------------------- |
 | SwiftWave                     | Core PaaS                                                                       | Golang             | [Click Here](https://github.com/swiftwave-org/swiftwave)      | [Click Here](./development_setup)                             |
 | Dashboard                     | Web interface for SwiftWave.                                                    | VueJS, TailwindCSS | [Click Here](https://github.com/swiftwave-org/dashboard)      | [Click Here](https://github.com/swiftwave-org/dashboard)      |
 | UDPProxy                      | Custom UDP Proxy to forward UDP traffic from outside word to internal services. | Golang             | [Click Here](https://github.com/swiftwave-org/udpproxy)       | [Click Here](https://github.com/swiftwave-org/udpproxy)       |
@@ -39,5 +39,5 @@ We have couple of projects under SwiftWave organization. You can contribute to a
 - Please follow the [**Conventional Commit Message  Guidelines**](https://www.conventionalcommits.org/en/v1.0.0/) while writing commit messages.
 
 ### 📌 Need Help?
-- You can join our Slack Workspace and ask your queries in **#general** channel.
-  - **Joining Link :** [slack.swiftwave.org](https://slack.swiftwave.org/)
+- You can join our Discord Workspace and ask your queries in **#new-contributors** channel.
+  - **Joining Link :** [community.swiftwave.org](https://community.swiftwave.org)
diff --git a/versioned_docs/version-2.2.x/dashboard/domains.md b/versioned_docs/version-2.2.x/dashboard/domains.md
@@ -6,7 +6,7 @@ sidebar_position: 10
 
 In **Domains** section, you can manage all the custom domains you have added to swiftwave.
 
-![Domains List](/assets/2.0.x/domain-list.png)
+![Domains List](/assets/2.2.x/domain-list.png)
 
 ### Register a new domain
 You can click on `Register New` button and fill in the required details to register a new domain.
@@ -30,7 +30,43 @@ You can click on `Verify DNS` button to verify if domain is correctly pointing t
 
 
 ### Issue SSL Certificate 🛡️
-Swiftwave has Let's Encrypt integration. You can issue a SSL certificate for your domain by clicking on `Issue SSL` button.
 
-### SSL Auto Renewal
-From V2, Swiftwave supports SSL auto renewal. You don't need to worry about renewing your SSL certificate manually.
+You can issue a SSL certificate automatically via Let's Encrypt or by manually providing SSL certificate and private key.
+
+- **Issue Automatically via Let's Encrypt**
+
+  Swiftwave has Let's Encrypt integration. You can issue a SSL certificate for your domain by clicking on `Issue SSL` button.
+
+  ![Issue SSL via Let's Encrypt](/assets/2.2.x/letsencrypt-ssl-issue.png)
+
+  :::tip
+
+  If you issue SSL certificate via Let's Encrypt, you don't need to worry about renewing your SSL certificate manually. Swiftwave will automatically renew your SSL certificate before it expires.
+
+  :::
+
+- **Add Custom SSL Certificate**
+
+  - Click on `Issue SSL` button.
+  - Choose `Custom SSL Certificate` option.
+
+    ![Add Custom SSL](/assets/2.2.x/add-custom-ssl.png)
+
+  - Now, provide your SSL certificate and private key in valid OpenSSL format.
+    > **🤝 Need help to generate self-signed SSL certificate ?**
+    > 
+    > You can run following command to generate private key and self-signed certificate.
+    > ```bash
+    > openssl req -x509 -newkey rsa:1024 -keyout key.pem -out cert.pem -sha256 -days 365 -nodes
+    > ```
+  - Submit and done !
+  - It will take few minutes to apply the changes.
+
+    :::warning
+
+    You should only use this option 
+    - if you can't open your server's port 80 and 443 to the internet due to security reasons. 
+    - Also, you may have purchased SSL certificate from a third party and you want to use it.
+    - If you just want to use self-signed certificate, you can go with this option.
+
+    :::

Original file line number	Diff line number	Diff line change
`@@ -233,8 +233,8 @@ const config = {`
`233`	`233`	`title: "Links",`
`234`	`234`	`items: [`
`235`	`235`	`{`
`236`		`- label: "Join Slack",`
`237`		`- to: "https://slack.swiftwave.org/",`
	`236`	`+ label: "Join Discord",`
	`237`	`+ to: "https://community.swiftwave.org",`
`238`	`238`	`},`
`239`	`239`	`{`
`240`	`240`	`label: "Visit GitHub",`