From 19955f55b7eb8139e44d7299115183e1ba60a89c Mon Sep 17 00:00:00 2001 From: ckykenken <26035978+ckykenken@users.noreply.github.com> Date: Wed, 16 Jan 2019 13:38:16 +0800 Subject: [PATCH 1/4] Added documentation for acme.sh --- tutorials/creating_ssl_certificates.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/tutorials/creating_ssl_certificates.md b/tutorials/creating_ssl_certificates.md index d6aa4cdd..28d087dd 100644 --- a/tutorials/creating_ssl_certificates.md +++ b/tutorials/creating_ssl_certificates.md @@ -1,6 +1,8 @@ # Creating SSL Certificates -This tutorial briefly covers creating new SSL certificates for your panel and daemon using LetsEncrypt™. To -begin, we will be installing certbot, a simple script that will automatically renew our certificates and allow much +This tutorial briefly covers creating new SSL certificates for your panel and daemon using LetsEncrypt™. + +## Method 1: Using Certbot +To begin, we will be installing certbot, a simple script that will automatically renew our certificates and allow much cleaner creation of them. The command below is for Ubuntu distributions, but you can always check [Certbot's official site](https://certbot.eff.org/) for installation instructions. @@ -10,7 +12,7 @@ sudo apt update sudo apt install certbot ``` -## Creating a Certificate +### Creating a Certificate After installing certbot, we need to then generate a certificate. There are a couple ways to do that, but the easiest is to have letsencrypt spin-up a temporary web-server to do this. In order for this to work, you will first need to stop NGINX or Apache. @@ -26,10 +28,10 @@ that you've already configured the webservers to use SSL). certbot certonly -d example.com ``` -## Auto Renewal +### Auto Renewal You'll also probably want to configure automatic renewal by adding the command below to a cronjob that runs daily. You can add the command below to that crontab. For advanced users, we suggest installing and using [acme.sh](https://acme.sh) -which provides more options, and is much more powerful than certbot. +which provides more options (see below), and is much more powerful than certbot. ``` text certbot renew From 8bcd067cb53bb67444d3935fbc76f0ac3491a2ac Mon Sep 17 00:00:00 2001 From: "Michael (Parker) Parker" Date: Mon, 4 Feb 2019 15:39:26 -0500 Subject: [PATCH 2/4] Create new community tutorials section Import #61 from the core docs moving them to a community tutorial section. --- .vuepress/config.js | 7 +++ .../tutorials/creating_ssl_certificates.md | 43 +++++++++++++++++++ 2 files changed, 50 insertions(+) create mode 100644 community/tutorials/creating_ssl_certificates.md diff --git a/.vuepress/config.js b/.vuepress/config.js index 9788a3b5..610f47d8 100644 --- a/.vuepress/config.js +++ b/.vuepress/config.js @@ -90,6 +90,13 @@ module.exports = { '/community/games/minecraft.md', ], }, + { + title: 'Tutorials', + collapsable: false, + children: [ + '/community/tutorials/creating_ssl_certificates.md', + ], + }, ], '/': [ { diff --git a/community/tutorials/creating_ssl_certificates.md b/community/tutorials/creating_ssl_certificates.md new file mode 100644 index 00000000..80bff960 --- /dev/null +++ b/community/tutorials/creating_ssl_certificates.md @@ -0,0 +1,43 @@ +# Creating SSL Certificates +These are community manages tutorials on how to generate an ssl cert. + + +## Cloudflare +This tutorial briefly covers creating new SSL certificates for your panel and daemon using Cloudflare + +### Using acme.sh +This is for advanced users, of which their server systems do not have access to port 80. The command below is for Ubuntu distributions and CloudFlare API (you may google for other APIs for other DNS providers), but you can always check [acme.sh's official site](https://github.com/Neilpang/acme.sh) for installation instructions. + +``` bash +curl https://get.acme.sh | sh +``` + +### Obtaining CloudFlare API Key +After installing acme.sh, we need to fetch a CloudFlare API key. Please make sure that a DNS record (A or CNAME record) is pointing to your target node, and set the cloud to grey (bypassing CloudFlare proxy). Then go to My Profile > API keys and on Glocal API Key subtab, click on "view", enter your CloudFlare password, and copy the API key to clipboard. + +### Creating a Certificate +Since the configuration file is based on Certbot, we need to create the folder manually. + +```bash +sudo mkdir /etc/letsencrypt/live/example.com +``` + +After installing certbot and obtaining CloudFlare API key, we need to then generate a certificate. First input the CloudFlare API credentials. + +```bash +export CF_Key="Your_CloudFlare_API_Key" +export CF_Email="Your_CloudFlare_Account@example.com" +``` +Then create the certificate. + +```bash +acme.sh --issue --standalone -d "example.com" --dns dns_cf \ +--key-file /etc/letsencrypt/live/example.com/privkey.pem \ +--fullchain-file /etc/letsencrypt/live/example.com/fullchain.pem +``` +### Auto Renewal +After running the script for the first time, it will be added to the crontab automatically. You may edit the auto renewal interval by editing the crontab. + +```bash +sudo crontab -e +``` \ No newline at end of file From d8a7c579d3509ba3af2652ee074fc523c17998c9 Mon Sep 17 00:00:00 2001 From: "Michael (Parker) Parker" Date: Sun, 21 Apr 2019 17:52:33 -0400 Subject: [PATCH 3/4] Add user creation header Add a header for creating a user to the docs. Make it easier to find. --- panel/getting_started.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/panel/getting_started.md b/panel/getting_started.md index f16d8547..b56e0c07 100644 --- a/panel/getting_started.md +++ b/panel/getting_started.md @@ -137,6 +137,8 @@ command will setup the database tables and then add all of the Nests & Eggs that php artisan migrate --seed ``` + +### Create Your First User You'll then need to create an administrative user so that you can log into the panel. To do so, run the command below. At this time passwords **must** meet the following requirements: 8 characters, mixed case, at least one number. From ec934eff6f31a989fb9531e6262ca88e0e4be4f3 Mon Sep 17 00:00:00 2001 From: "Michael (Parker) Parker" Date: Mon, 6 May 2019 08:57:45 -0400 Subject: [PATCH 4/4] add header for adding a user People miss it all the time. --- panel/getting_started.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/panel/getting_started.md b/panel/getting_started.md index f16d8547..495127eb 100644 --- a/panel/getting_started.md +++ b/panel/getting_started.md @@ -137,6 +137,8 @@ command will setup the database tables and then add all of the Nests & Eggs that php artisan migrate --seed ``` + +### Add The First User You'll then need to create an administrative user so that you can log into the panel. To do so, run the command below. At this time passwords **must** meet the following requirements: 8 characters, mixed case, at least one number.