From f55a265362853c9e24ad49fa342fb05003b55d1a Mon Sep 17 00:00:00 2001 From: Adam Miedema Date: Wed, 3 Jan 2024 19:33:44 -0700 Subject: [PATCH] chore: update docs per new functionality --- content/documentation/dns-profiles.md | 32 ++++++++++++------- .../documentation/environment-variables.md | 31 ++++++++++++------ content/documentation/vps-profiles.md | 4 +++ 3 files changed, 47 insertions(+), 20 deletions(-) diff --git a/content/documentation/dns-profiles.md b/content/documentation/dns-profiles.md index 5f65611..db37e64 100644 --- a/content/documentation/dns-profiles.md +++ b/content/documentation/dns-profiles.md @@ -1,8 +1,8 @@ --- -title: 'DNS Profiles' -description: 'Add DNS profiles to connect notification DNS management accounts.' -image: 'https://docs.cleavr.io/images/cleavr-twitter.png' -video: +title: "DNS Profiles" +description: "Add DNS profiles to connect notification DNS management accounts." +image: "https://docs.cleavr.io/images/cleavr-twitter.png" +video: --- We try to keep everything a click away in Cleavr. This includes bringing in DNS record management. This makes setting up @@ -12,15 +12,25 @@ domains for your sites zoom! 🏎 ### [Cloudflare](https://www.cloudflare.com/) -Cloudflare is a web infrastructure and security tool that assists with many valuable services such as DNS record management, -DDoS mitigation, SSL certificate creation and management, and much more. Cloudflare is a great service to use in conjunction -with Cleavr if you are looking for even more layers of protection. +Cloudflare is a web infrastructure and security tool that assists with many valuable services such as DNS record management, +DDoS mitigation, SSL certificate creation and management, and much more. Cloudflare is a great service to use in conjunction +with Cleavr if you are looking for even more layers of protection. -In your Cloudflare account, grab your API Key from your **Profile > API Tokens > View Global API Key** +In your Cloudflare account, grab your API Key from your **Profile > API Tokens > View Global API Key** + +### [AWS Route 53](https://aws.amazon.com/route53/) + +The Route 53 DNS profile requires an AWS API key that has priveleges for Route 53. ### [DigitalOcean](https://www.digitalocean.com/) -DigitalOcean also provides some DNS record management functions. If you already have DO setup as a VPS provider, you can -use the same **Personal Access Token** to setup the DNS records connection. +DigitalOcean also provides some DNS record management functions. If you already have DO setup as a VPS provider, you can +use the same **Personal Access Token** to setup the DNS records connection. + +You will need to ensure that your [domain points to DigitalOcean's nameservers](https://www.digitalocean.com/community/tutorials/how-to-point-to-digitalocean-nameservers-from-common-domain-registrars). + +### [Porkbun](https://porkbun.com/) + +Porkbun makes it easy to purchase domains. It's also equally as easy to connect to your Porkbun account thru Cleavr to manage DNS records. -You will need to ensure that your [domain points to DigitalOcean's nameservers](https://www.digitalocean.com/community/tutorials/how-to-point-to-digitalocean-nameservers-from-common-domain-registrars). +For creating a new DNS profile for Porkbun, you'll need the email associated with your Porkbun account and an API key which you can create from the Account section. diff --git a/content/documentation/environment-variables.md b/content/documentation/environment-variables.md index 72b4ab1..d2fc05c 100644 --- a/content/documentation/environment-variables.md +++ b/content/documentation/environment-variables.md @@ -1,22 +1,35 @@ --- -title: 'Environment Variables' -description: 'Manage production environment variables.' -image: 'https://docs.cleavr.io/images/cleavr-twitter.png' -video: '' +title: "Environment Variables" +description: "Manage production environment variables." +image: "https://docs.cleavr.io/images/cleavr-twitter.png" +video: "" --- ## What are environment variables? -Env files typically hold sensitive information for how you apps might connect to other servers, databases, services, etc. + +Env files typically hold sensitive information for how you apps might connect to other servers, databases, services, etc. + Cleavr lets you override the production .env file on a server by adding the variables to the environment section. + +For this functionality to fully work, you'll need to ensure that your stack supports reading from a .env file in production. Many frameworks support this feature out-of-the-box. Otherwise, you may need to install a package in order to set this up correctly. Lastly, some frameworks are phasing out .env files in production. If this is the situation with the framework you are using, trying adding (or synching) the environment variables with PM2 (for Node-based apps only). + + ## Configure Deployment Workflow Servers -Navigate to your deployment workflow and select Environment. If you have existing environment variables on a server, you can select the -server and fetch the current variables to then make edits. Otherwise, if a fresh app with no variables, you can use either the -text area to copy and paste from your env file, or you can use the form fields view to enter new variables. -Depending on the type of site (PHP, Alpas, Laravel, etc) you will have post synch options available to run post sync. Such as: +Navigate to your deployment workflow and select Environment. If you have existing environment variables on a server, you can select the +server and fetch the current variables to then make edits. Otherwise, if a fresh app with no variables, you can use either the +text area to copy and paste from your env file, or you can use the form fields view to enter new variables. + +Depending on the type of site (PHP, Alpas, Laravel, etc) you will have post synch options available to run post sync. Such as: - Clear and build config cache (Laravel) - Reload php-fpm (PHP, Laravel) - Restart queue (Laravel) - Restart App (NodeJS, Alpas) + +## PM2 Environment Variables + +In the Environment section, you can select the option to sync variables with PM2. If you'd like to see the variables, select 'PM2' from the navigation bar to view the PM2 Ecosystem settings. + +Some NodeJS frameworks, such as Nuxt and Strapi, are configured to look for production variables from here as opposed to a .env file. diff --git a/content/documentation/vps-profiles.md b/content/documentation/vps-profiles.md index 871def3..b70daea 100644 --- a/content/documentation/vps-profiles.md +++ b/content/documentation/vps-profiles.md @@ -34,6 +34,8 @@ If you are based in Europe, Hetzner has affordable cloud options for you. To create a key, go to your project that you created > **Access > API Tokens** and generate api token. +The Hetzner integration supports IPv6 in addition to IPv4. + ### [UpCloud](https://upcloud.com/signup/?promo=38D8TP) With a focus on small / medium businesses and with developer productivity in mind, UpCloud is a great VPS provider @@ -48,6 +50,8 @@ DigitalOcean has plenty of global data centers and well-priced options that shou To create a key, go to **API > personal access tokens** and generate a new key +The DNS integration supports IPv6 in addition to IPv4. + ### [AWS](https://aws.amazon.com/) Amazon Web Services is one of the largest cloud providers in the world. If you are looking for servers that scale with demand,