more help docs

This commit is contained in:
Jamie Curnow 2023-03-05 22:35:42 +10:00
parent 972e53df71
commit 0dd713e634
No known key found for this signature in database
GPG Key ID: FFBB624C43388E9E
19 changed files with 203 additions and 6 deletions

View File

@ -0,0 +1,3 @@
# Access Lists Help
todo

View File

@ -1,3 +1,29 @@
# Hilfe zu Zertifizierungsstellen
# Certificate Authorities Help
TODO
## What is a Certificate Authority?
A **Certificate Authority (CA)**, also sometimes referred to as a
**Certification Authority**, is a company or organization that acts to validate
the identities of entities (such as websites, email addresses, companies, or
individual persons) and bind them to cryptographic keys through the issuance of
electronic documents known as digital certificates.
## Which CA should I use?
Not all CA's are created equal and you would be fine to use the default,
ZeroSSL.
When using another CA it's worth considering the wildcard support and number of
hosts-per-certificate that it supports.
## Can I use my own custom CA?
Yes, you can run your own CA software. You would only do this if you have a
greater understanding of the SSL ecosystem.
When requesting SSL Certificates through your custom CA and while they will be
successful, browsers will not automatically trust your CA and visiting hosts
using certificates issued by that CA will show errors.
- [StepCA](https://smallstep.com/docs/step-ca)
- [Pebble](https://github.com/letsencrypt/pebble)

View File

@ -0,0 +1,37 @@
# Certificates Help
## HTTP Certificate
A HTTP validated certificate means that the Certificate Authority (CA) will
attempt to reach your domains over HTTP (not HTTPS!) and if successful, the CA
will issue your certificate.
For this method, you will have to have a _Host_ created for your domains(s) that
is accessible with HTTP. After a certificate has been given, you can modify the
_Host_ to also use this certificate for HTTPS connections. However, the _Host_
will still need to be configured for HTTP access in order for the certificate to
renew.
## DNS Certificate
A DNS validated certificate requires you to create a DNS Provider. This DNS
Provider will be used to create temporary records on your domain and then the CA
will query those records to be sure you're the owner and if successful, the CA
will issue your certificate.
You do not need a _Host_ to be created prior to requesting this type of
certificate. Nor do you need to have your _Host_ configured for HTTP access.
## Custom Certificate
Use this option to upload your own SSL Certificate, as provided by your own
Certificate Authority.
## MKCert Certificate
This option will create a self-signed Certificate for development use. When
viewing a _Host_ that using a MKCert Certificate, the browser will show errors.
## Choosing a Certificate Authority
If you're not sure, use **ZeroSSL.**

View File

@ -0,0 +1,14 @@
# DNS Providers Help
A DNS Provider is a service that hosts your domain(s) and this will be
specifically used when requesting new _Certificates_ via DNS Validation.
It is preferred to use DNS Validation, so check if your domain is hosted with
one of the supported Acme.sh providers:
- [DNS Page 1](https://github.com/acmesh-official/acme.sh/wiki/dnsapi)
- [DNS Page 2](https://github.com/acmesh-official/acme.sh/wiki/dnsapi2)
Should your DNS Provider be supported by Acme.sh and not available in this
project, please
[open an issue on Github](https://github.com/NginxProxyManager/nginx-proxy-manager/issues/new/choose).

View File

@ -0,0 +1,3 @@
# Hosts Help
todo

View File

@ -0,0 +1,3 @@
# Hosts Help
todo

View File

@ -0,0 +1,3 @@
# Nginx Templates Help
todo

View File

@ -0,0 +1,3 @@
# Upstreams Help
todo

View File

@ -1 +1,7 @@
export * as AccessLists from "./AccessLists.md";
export * as Certificates from "./Certificates.md";
export * as CertificateAuthorities from "./CertificateAuthorities.md";
export * as DNSProviders from "./DNSProviders.md";
export * as Hosts from "./Hosts.md";
export * as NginxTemplates from "./NginxTemplates.md";
export * as Upstreams from "./Upstreams.md";

View File

@ -24,11 +24,13 @@ certificate. Nor do you need to have your _Host_ configured for HTTP access.
## Custom Certificate
todo
Use this option to upload your own SSL Certificate, as provided by your own
Certificate Authority.
## MKCert Certificate
todo
This option will create a self-signed Certificate for development use. When
viewing a _Host_ that using a MKCert Certificate, the browser will show errors.
## Choosing a Certificate Authority

View File

@ -0,0 +1,3 @@
# Hosts Help
todo

View File

@ -0,0 +1,3 @@
# Access Lists Help
todo

View File

@ -1,3 +1,28 @@
# کمک مقامات صدور گواهی
# راهنمایی‌های مربوط به مراجع صادرکننده گواهینامه
TODO
## مرجع صادرکننده گواهینامه چیست؟
مرجع صادرکننده گواهینامه (CA) یا همان مرجع تأیید شناسه، یک شرکت یا سازمان است که
به منظور تأیید هویت انجام‌دهندگان (مانند وب سایت‌ها، آدرس‌های ایمیل، شرکت‌ها یا
افراد) و اتصال آن‌ها به کلیدهای رمزنگاری، از طریق صدور سند الکترونیکی به نام
گواهینامه دیجیتال، فعالیت می‌کند.
## از کدام مرجع صادرکننده گواهینامه باید استفاده کنم؟
همه مراجع صادرکننده گواهینامه‌ها برابر نیستند و شما می‌توانید از پیش‌فرض ZeroSSL
استفاده کنید.
در هنگام استفاده از یک مرجع صادرکننده گواهینامه دیگر، ارزش پشتیبانی از ویلدکارد
و تعداد میزبان‌ها در هر گواهینامه را در نظر بگیرید.
## آیا می‌توانم از مرجع صادرکننده گواهینامه شخصی خود استفاده کنم؟
بله، می‌توانید نرم‌افزار CA خود را اجرا کنید. این کار را فقط در صورت داشتن درک
بیشتری از بخش SSL انجام دهید.
هنگام درخواست گواهینامه SSL از CA شخصی خود، درخواست‌های شما موفق خواهند بود، اما
مرورگرها به طور خودکار به CA شما اعتماد نخواهند کرد و میزبان‌های با استفاده از
گواهینامه‌های صادر شده توسط آن CA، خطاها را نمایش می‌دهند.
- [StepCA](https://smallstep.com/docs/step-ca)
- [Pebble](https://github.com/letsencrypt/pebble)

View File

@ -0,0 +1,37 @@
# راهنمایی گواهی‌نامه‌ها
## گواهینامه HTTP
گواهینامه معتبرساز (CA) HTTP به معنای آن است که CA سعی خواهد کرد تا به دامنه های
شما به صورت HTTP (نه HTTPS!) دسترسی پیدا کند و در صورت موفقیت، گواهینامه شما را
صادر خواهد کرد.
برای این روش، شما باید یک میزبان (Host) برای دامنه (های) خود ایجاد کنید که با
HTTP قابل دسترسی باشد. پس از صدور گواهینامه، شما می توانید میزبان (Host) خود را
به گواهینامه خود برای اتصالات HTTPS نیز تنظیم کنید. با این حال، میزبان (Host)
همچنان باید برای دسترسی HTTP پیکربندی شود تا گواهینامه تجدید شود.
## گواهینامه DNS
گواهینامه معتبرساز DNS نیازمند ایجاد یک ارائه دهنده DNS است. این ارائه دهنده DNS
برای ایجاد رکوردهای موقت در دامنه شما استفاده خواهد شد و سپس CA برای اطمینان از
اینکه شما مالک آن هستید، این رکوردها را پرس‌وجو خواهد کرد و در صورت موفقیت،
گواهینامه شما را صادر خواهد کرد.
شما نیازی به ایجاد میزبان (Host) قبل از درخواست این نوع گواهینامه ندارید.
همچنین، شما نیازی به پیکربندی میزبان (Host) خود برای دسترسی HTTP ندارید.
## گواهینامه سفارشی
از این گزینه برای بارگذاری گواهینامه SSL خود، به عنوان ارائه شده توسط معتبرساز
گواهینامه خود، استفاده کنید.
## گواهینامه MKCert
این گزینه یک گواهینامه امضای دیجیتالی خود امضا شده برای استفاده در محیط توسعه
ایجاد می‌کند. هنگام مشاهده یک میزبانی (Host) که از گواهینامه MKCert استفاده
می‌کند، مرورگر خطاها را نشان می‌دهد.
## انتخاب یک مرجع اعتبار سنجی
اگر مطمئن نیستید، از ZeroSSL استفاده کنید.

View File

@ -0,0 +1,14 @@
# DNS Providers Help
A DNS Provider is a service that hosts your domain(s) and this will be
specifically used when requesting new _Certificates_ via DNS Validation.
It is preferred to use DNS Validation, so check if your domain is hosted with
one of the supported Acme.sh providers:
- [DNS Page 1](https://github.com/acmesh-official/acme.sh/wiki/dnsapi)
- [DNS Page 2](https://github.com/acmesh-official/acme.sh/wiki/dnsapi2)
Should your DNS Provider be supported by Acme.sh and not available in this
project, please
[open an issue on Github](https://github.com/NginxProxyManager/nginx-proxy-manager/issues/new/choose).

View File

@ -0,0 +1,3 @@
# Hosts Help
todo

View File

@ -0,0 +1,3 @@
# Nginx Templates Help
todo

View File

@ -0,0 +1,3 @@
# Upstreams Help
todo

View File

@ -1 +1,7 @@
export * as AccessLists from "./AccessLists.md";
export * as Certificates from "./Certificates.md";
export * as CertificateAuthorities from "./CertificateAuthorities.md";
export * as DNSProviders from "./DNSProviders.md";
export * as Hosts from "./Hosts.md";
export * as NginxTemplates from "./NginxTemplates.md";
export * as Upstreams from "./Upstreams.md";