Skip to content

Commit

Permalink
Merge pull request #2 from erfjab/dev
Browse files Browse the repository at this point in the history
update to v2.1.1
  • Loading branch information
erfjab authored May 2, 2024
2 parents 91dbc73 + 985623f commit 58cf3c8
Show file tree
Hide file tree
Showing 4 changed files with 397 additions and 331 deletions.
62 changes: 46 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
https://github.com/erfjab/ESSL/assets/143827987/148d7fca-2f89-4b81-8715-22e4e9aabf9e

https://github.com/erfjab/ESSL/assets/143827987/2e9873a6-1ea8-4777-a4f9-a18cd58a0a29

<p align="center">
<a href="./README.md">
Expand All @@ -22,9 +21,13 @@ ESSL (Easy SSL) is a user-friendly script designed to streamline the process of
- Revoke ssl (delete)
- Automatic/Custom patch (support all panel's directory)

> [!IMPORTANT]
> In the current version, only `certbot` is used.
### Support:
- Acme
- Certbot
- Cloudflare api

> [!IMPORTANT]
> The script automatically tests both acme and certbot to generate the certificate.
## How to Use?

Expand All @@ -36,26 +39,53 @@ sudo bash -c "$(curl -sL https://github.com/erfjab/ESSL/raw/main/essl.sh)"
<details>

<summary>Single Domain</summary>

1. acme & certbot
In single domain after set DNS you only need :
- `domain` (e.g: sub.doamin.com)
- `email`

In single domain after set DNS you only need :
- `domain` (e.g: sub.doamin.com)
- `email`
After receiving ssl, it will show you three path, the first one is for the desired path, the second one is for the border panel path and the third one is for the path of other panels. You received a certificate so easily and easily.
2. cloudflare api
> Cloudflare api only generates wildcard certificates.

With cloudflare api you don't need to set dns. well:
- `domain` (e.g: domain.com)
- `cloudflare account email`
- `cloudflare global api key`

how to find cloudflare global api key : [Link](https://coda.io/@vishesh-jain/api-documentation/cloudflare-global-api-key-15)

After receiving ssl, it will show you three path, the first one is for the desired path, the second one is for the border panel path and the third one is for the path of other panels. You received a certificate so easily and easily.

After receiving ssl, it will show you three path, the first one is for the desired path, the second one is for the border panel path and the third one is for the path of other panels. You received a certificate so easily and easily.
</details>


<details>

<summary>Wildcard Domain</summary>

In wildcard domain after set DNS you only need :
- `domain` (e.g: domain.com)
- `email`

Now it gives you a name and text value, which asks you to set them in text dns format, after a few moments, click set enter.
1. acme & certbot

In wildcard domain after set DNS you only need :
- `domain` (e.g: domain.com)
- `email`

Now it gives you a name and text value, which asks you to set them in text dns format, after a few moments, click set enter.

After receiving ssl, it will show you three path, the first one is for the desired path, the second one is for the border panel path and the third one is for the path of other panels. You received a certificate so easily and easily.
2. cloudflare api

> Cloudflare api only generates wildcard certificates.

With cloudflare api you don't need to set dns. well:
- `domain` (e.g: domain.com)
- `cloudflare account email`
- `cloudflare global api key`

how to find cloudflare global api key : [Link](https://coda.io/@vishesh-jain/api-documentation/cloudflare-global-api-key-15)
After receiving ssl, it will show you three path, the first one is for the desired path, the second one is for the border panel path and the third one is for the path of other panels. You received a certificate so easily and easily.

After receiving ssl, it will show you three path, the first one is for the desired path, the second one is for the border panel path and the third one is for the path of other panels. You received a certificate so easily and easily.
</details>


Expand Down Expand Up @@ -86,9 +116,9 @@ If it needs to be extended, it will be extended, otherwise it will say that it i
<summary>Revoke</summary>

In Revoke fi you only need :
- `fullchain.pem path` (e.g: /etc/letsencrypt/live/domain/fullchain.pem)
- `domain` (e.g: *.domain.com (wildcard) sub.domain.com (single))

In revoke, it will first show you the list of domains so you can choose the desired domain and copy/paste the exact address of the domain to be revoked.
If your domain is in the domain list, it will revoked.
</details>

## Support project
Expand Down
53 changes: 42 additions & 11 deletions README_fa.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@

https://github.com/erfjab/ESSL/assets/143827987/148d7fca-2f89-4b81-8715-22e4e9aabf9e
https://github.com/erfjab/ESSL/assets/143827987/2e9873a6-1ea8-4777-a4f9-a18cd58a0a29


<p align="center">
Expand All @@ -23,8 +22,13 @@ https://github.com/erfjab/ESSL/assets/143827987/148d7fca-2f89-4b81-8715-22e4e9aa
- منقضی گواهی (تمدید)
- مسیردهی اتوماتیک/شخصی‌سازی (پیشتیبانی همه‌ی پنل‌ها)

### پشتیبانی:
- Acme
- Certbot
- Cloudflare api

> [!IMPORTANT]
> نسحه‌ی حال حاضر فقط از `certbot` استفاده میکند.
> اسکریپت به صورت اتوماتیک هم acme و هم certbot را برای دریافت گواهی تست میکند.

## نحوه‌ی استفاده؟
Expand All @@ -37,25 +41,52 @@ sudo bash -c "$(curl -sL https://github.com/erfjab/ESSL/raw/main/essl.sh)"
<details>

<summary>تک دامنه</summary>

1. acme & certbot

در تک دامنه بعد از تنظیم دی‌ان‌اس ها نیاز به دو چیز داریم:
- `دامنه` (e.g: sub.doamin.com)
- `ایمیل`

در تک دامنه بعد از تنظیم دی‌ان‌اس ها نیاز به دو چیز داریم:
- `دامنه` (e.g: sub.doamin.com)
- `ایمیل`
بعد از دریافت گواهی به شما سه تا گزینه برای مسیردهی گواهی نمایش میدهد که اولی برای مسیردهی دلخواه دومی برای مسیردهی پنل مرزبان و سومی مسیردهی مناسب سایر پنل‌ها می‌باشد که اتوماتیک انجام میشود.
2. cloudflare api
> توجه کنید که api های کلودفلر فقط گواهی wildcard دریافت میکنند.

با api های کلودفلر شما نیازی به تنظیم dns ندارید، پس:
- `دامنه` (e.g: domain.com)
- `ایمیل اکانت کلودفلر`
- `کلید گلوبال api کلودفلر`

نحوه‌ی یافت کلید گلوبال api در کلودفلر : [Link](https://coda.io/@vishesh-jain/api-documentation/cloudflare-global-api-key-15)

بعد از دریافت گواهی به شما سه تا گزینه برای مسیردهی گواهی نمایش میدهد که اولی برای مسیردهی دلخواه دومی برای مسیردهی پنل مرزبان و سومی مسیردهی مناسب سایر پنل‌ها می‌باشد که اتوماتیک انجام میشود.

بعد از دریافت گواهی به شما سه تا گزینه برای مسیردهی گواهی نمایش میدهد که اولی برای مسیردهی دلخواه دومی برای مسیردهی پنل مرزبان و سومی مسیردهی مناسب سایر پنل‌ها می‌باشد که اتوماتیک انجام میشود.
</details>


<details>

<summary>گواهی همه‌ی ساب‌ها</summary>

1. acme & certbot

در گواهی همه‌ی ساب‌ها بعد از تنظیم دی‌ان‌اس ها نیاز به دو چیز داریم:
- `دامنه` (e.g: doamin.com)
- `ایمیل`

حالا به شما یک اسم و یک text value برای ساخت dns text نمایش میدهد که بعد از ساهت چند ثانیه صبر کنید و enter کلیک کنید تا اسکریپت به کارش ادامه دهد.
بعد از دریافت گواهی به شما سه تا گزینه برای مسیردهی گواهی نمایش میدهد که اولی برای مسیردهی دلخواه دومی برای مسیردهی پنل مرزبان و سومی مسیردهی مناسب سایر پنل‌ها می‌باشد که اتوماتیک انجام میشود.

2. cloudflare api

با api های کلودفلر شما نیازی به تنظیم dns ندارید، پس:
- `دامنه` (e.g: domain.com)
- `ایمیل اکانت کلودفلر`
- `کلید گلوبال api کلودفلر`

نحوه‌ی یافت کلید گلوبال api در کلودفلر : [Link](https://coda.io/@vishesh-jain/api-documentation/cloudflare-global-api-key-15)

بعد از دریافت گواهی به شما سه تا گزینه برای مسیردهی گواهی نمایش میدهد که اولی برای مسیردهی دلخواه دومی برای مسیردهی پنل مرزبان و سومی مسیردهی مناسب سایر پنل‌ها می‌باشد که اتوماتیک انجام میشود.

</details>


Expand Down Expand Up @@ -86,9 +117,9 @@ sudo bash -c "$(curl -sL https://github.com/erfjab/ESSL/raw/main/essl.sh)"
<summary>منقضی</summary>

در هنگام منقضی فقط به یک چیز نیاز داریم:
- `fullchain.pem مسیر` (e.g: /etc/letsencrypt/live/domain/fullchain.pem)

در هنگام منقضی کردن یک دامنه ، اول به شما لیست دامنه ها نمایش داده میشود، سپس از شما سوال می‌شود کدام دامنه را میخواهید منقضی کنید؟ که شما باید از اطلاعات دامنه، مسیر فایل رو طبق الگوی بالا کپی/پیست میکنید تا گواهی منقضی و اطلاعات دامنه حذف شود.
- `نام دامنه` (e.g: *.domain.com (wildcard) sub.domain.com (single))
اگر دامنه‌ی شما در لیست دامنه ها موجود باشد، دامنه منقضی خواهد شد.
</details>

## حمایت پروژه
Expand Down
Binary file removed essl.mp4
Binary file not shown.
Loading

0 comments on commit 58cf3c8

Please sign in to comment.