Skip to content

Commit

Permalink
chore: fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
armgitaar committed Feb 18, 2024
1 parent 7db8b6f commit 486b486
Show file tree
Hide file tree
Showing 35 changed files with 291 additions and 256 deletions.
20 changes: 20 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"cSpell.words": [
"Alpas",
"Backblaze",
"Cleavr",
"Directus",
"Flarum",
"Grav",
"Hetzner",
"Laravel",
"Multisite",
"nuxt",
"Porkbun",
"Stamatic",
"Strapi",
"Symfony",
"Umami",
"Vultr"
]
}
16 changes: 8 additions & 8 deletions content/documentation/backup-profiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,11 @@ The following are the list of S3 Compatible backup providers that are verified t

![Create Cloudflare R2 Token](/images/s3-backups/r2-create-tokens.png)

Once the token is created copy the `Access Key ID`, `Secret Access Key` and paste them to `Key` and `Secret` input fields respectively.
Once the token is created copy the `Access Key ID`, `Secret Access Key` and paste them to `Key` and `Secret` input fields respectively.

![R2 Access Keys](/images/s3-backups/r2-access-keys.png)

- Bucket: To create a bucket navigate to `R2` > `Overview` > `Create Bucket`. Once the bucket is created enter the name of the buket to the `Bucket` input field in Cleavr.
- Bucket: To create a bucket navigate to `R2` > `Overview` > `Create Bucket`. Once the bucket is created enter the name of the bucket to the `Bucket` input field in Cleavr.

![R2 Create Bucket](/images/s3-backups/r2-create-bucket.png)

Expand All @@ -69,21 +69,21 @@ Once the token is created copy the `Access Key ID`, `Secret Access Key` and past

### [OVHcloud](https://us.ovhcloud.com/)

- Key and Secret: You can access this information in the `S3 users` tab in your OVHcloud Control Panel. Enter the details respectively on the `Key` and `Secret`
input fields.
- Key and Secret: You can access this information in the `S3 users` tab in your OVHcloud Control Panel. Enter the details respectively on the `Key` and `Secret`
input fields.
- Bucket: Enter the S3 bucket name you created from OVHcloud.
- Endpoint: Click on the name of your bucket to view its details. On the details page you can find `Endpoint` of your bucket.
- Region: Region is selected while creating `Object Container`. Make sure to use lowercase value for the region. For e.g.: if the region you've selected is `GRA`
make sure to provide `gra` as the value for region. You can also find region in your endpoint. If your endpoint is `https://s3.gra.perf.cloud.ovh.net` the region
will be `gra`.
- Region: Region is selected while creating `Object Container`. Make sure to use lowercase value for the region. For e.g.: if the region you've selected is `GRA`
make sure to provide `gra` as the value for region. You can also find region in your endpoint. If your endpoint is `https://s3.gra.perf.cloud.ovh.net` the region
will be `gra`.

## DigitalOcean Spaces

The following are specific or important to know for DigitalOcean backups.

- Key - enter the key for the space
- Secret - enter the secret for the space
- Origin URL - enter the origin URL for the space and exclude bucket name from URL; should look similar to `https://nyc3.digitaloceanspaces.com` where `nyc3` is the datacenter location. The origin URL is visible on the main page for your DO space.
- Origin URL - enter the origin URL for the space and exclude bucket name from URL; should look similar to `https://nyc3.digitaloceanspaces.com` where `nyc3` is the data center location. The origin URL is visible on the main page for your DO space.

## SFTP

Expand Down
17 changes: 9 additions & 8 deletions content/documentation/change-domain.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
---
title: 'Change Domain'
description: 'Change existing domain to any other domain.'
image: 'https://docs.cleavr.io/images/cleavr-twitter.png'
video: ''
title: "Change Domain"
description: "Change existing domain to any other domain."
image: "https://docs.cleavr.io/images/cleavr-twitter.png"
video: ""
---

To change the domain, navigate to the site in Cleavr, click **Rename site**, and then fill the input field with the new domain.

Be sure not add `http`, `https`, or `www` as an A record. Just type in the hostname and any non-www A record.
Be sure not add `http`, `https`, or `www` as an A record. Just type in the hostname and any non-www A record.

### If you update the domain, there may be other updates you need to make, such as:
- **Backups**: update the path for any filesystems that previously pointed to the directory of the free domain
- **Cron jobs**: update the path for any cron job processes that included the free domain in the path
### If you update the domain, there may be other updates you need to make, such as:

- **Backups**: update the path for any file systems that previously pointed to the directory of the free domain
- **Cron jobs**: update the path for any cron job processes that included the free domain in the path
- **Process monitors**: update the path for any process monitor that included the free domain in the path
- **SSL Certificates**: there is an option to `Install free SSL` while renaming a site which will take care of SSL Certificate for the primary domain. For any other SSL Certificates please navigate to SSL Certificates page and create a new certificate.
- **Aliases**: navigate to the `Domain Aliases` page and update the aliases.
25 changes: 13 additions & 12 deletions content/documentation/clean-disk-space.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,29 @@
---
title: 'Clean Disk Space'
description: 'Clean up disk space when your server is running low on space.'
image: 'https://docs.cleavr.io/images/cleavr-twitter.png'
video:
title: "Clean Disk Space"
description: "Clean up disk space when your server is running low on space."
image: "https://docs.cleavr.io/images/cleavr-twitter.png"
video:
---

Clean your server's disk space when space is running low. This action will clean up old files that pile up over time and take up space on your disk.
Clean your server's disk space when space is running low. This action will clean up old files that pile up over time and take up space on your disk.

## Run Disk Clean Space
To run disk clean up, from the Dahboard or Servers page, click on the ellipsis icon for the server you want to clear space on and then click the **Clean Disk Space** option on the menu.

To run disk clean up, from the Dashboard or Servers page, click on the ellipsis icon for the server you want to clear space on and then click the **Clean Disk Space** option on the menu.

![server menu clean disk space option](/images/clean-disk/menu-clean-disk.png)

A modal will display where you can select which cleanup options you want to run. You can learn more about the options in the sections below.
A modal will display where you can select which cleanup options you want to run. You can learn more about the options in the sections below.

![cleavr server clean disk space](/images/clean-disk/clean-disk-space.png)

### Clean cache

This operation runs `apt-get clean` which clears downloaded package files. This removes everything except the partials folder and lock file from the `/var/cache/apt/archives` directory.
This operation runs `apt-get clean` which clears downloaded package files. This removes everything except the partials folder and lock file from the `/var/cache/apt/archives` directory.

### Clear compressed log files

This operation clears compressed archived files, `*.gz`, from the `/var/log` directory.
This operation clears compressed archived files, `*.gz`, from the `/var/log` directory.

### Clean systemd journal logs

Expand All @@ -38,8 +39,8 @@ This operation clears the MySQL bin logs, which are logs that contain event info

## Schedule Clean Disk Space Job

Set a scheduled disk clean up job to automatically run on a set schedule. Enable the cleanup options you want to schedule and then configure what interval you want the job to run on.
Set a scheduled disk clean up job to automatically run on a set schedule. Enable the cleanup options you want to schedule and then configure what interval you want the job to run on.

If you reschedule a job, this will overwrite any existing scheduled jobs.
If you reschedule a job, this will overwrite any existing scheduled jobs.

To remove a scheduled job so that it no longer runs, click **Remove** to delete the job.
To remove a scheduled job so that it no longer runs, click **Remove** to delete the job.
2 changes: 1 addition & 1 deletion content/documentation/dark-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ If you'd like to switch modes, you will need to go to you devices general settin

For example, Mac users can change the appearance under System Preferences > General.

You can also togle between light and dark mode from the Preferences section which you can get to from your Avatar menu.
You can also toggle between light and dark mode from the Preferences section which you can get to from your Avatar menu.
8 changes: 4 additions & 4 deletions content/documentation/databases.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,13 @@ To add a new database user, select **Add New Database User**. Once you add the n

Select the ellipsis icon for databases and database users to remove the selected resource.

## MySQL Plugins and Adminstrations
## MySQL Plugins and Administrations

If you need to add a plugin or modify roles, you can SSH into your server as root user and access MySQL by running `mysql` command in the terminal.

## Postgres Plugins and Admin Role

Click on the elipsis icon for a postgres database to add a PostgreSQL extension. For example, you can add the popular `uuid-ossp` extension.
Click on the ellipsis icon for a postgres database to add a PostgreSQL extension. For example, you can add the popular `uuid-ossp` extension.

In some cases, you may need to make a postgres databases user a superuser. To do so, click on the elipsis for the postgres user and then select the **Make Superuser** option.

Expand Down Expand Up @@ -91,7 +91,7 @@ MySQL 5.7, MySQL 8.0, and MariaDB 10.4 will work with your WordPress site.

## Database Troubleshooting

### MySQL / MariaDB SUPER privelege and binary logging error
### MySQL / MariaDB SUPER privilege and binary logging error

Have you ran into the following error?

Expand All @@ -101,7 +101,7 @@ binary logging is enabled (you *might* want to use the less safe
log_bin_trust_function_creators variable)
```

To move past this error, you'd have to either assign super priveleges to the user, which should be done with caution, or, more preferebly, run the following command in mysql terminal:
To move past this error, you'd have to either assign super privileges to the user, which should be done with caution, or, more preferably, run the following command in mysql terminal:

```
mysql -u USERNAME -p
Expand Down
2 changes: 1 addition & 1 deletion content/documentation/delete-account.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ Deleting your Cleavr account will remove all records from Cleavr's database. Thi

After you make the request to delete your account, you will receive a confirmation email to verify that you want your account deleted. After selecting the confirmation button, your account will be removed from Cleavr.

You may create a new account at any time using the same email previously tied to the account you removed. This includes eligibilty to the 5-day free trial as Cleavr will view you as a brand new user.
You may create a new account at any time using the same email previously tied to the account you removed. This includes eligibility to the 5-day free trial as Cleavr will view you as a brand new user.
2 changes: 1 addition & 1 deletion content/documentation/deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ appropriate hooks configured and enabled.

There are several ways to trigger a deployment:

- Cliking the **Deploy** button for the deployment workflow
- Clicking the **Deploy** button for the deployment workflow
- Push-to-deploy will deploy when new commits are submitted
- GitHub Actions, available for NodeJS apps, will trigger a deployment with either method above
- Using the [deployment trigger hook](/workflow-settings#deployment-trigger-hook)
Expand Down
2 changes: 1 addition & 1 deletion content/documentation/dns-profiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ In your Cloudflare account, grab your API Key from your **Profile > API Tokens >

### [AWS Route 53](https://aws.amazon.com/route53/)

The Route 53 DNS profile requires an AWS API key that has priveleges for Route 53.
The Route 53 DNS profile requires an AWS API key that has privileges for Route 53.

### [DigitalOcean](https://www.digitalocean.com/)

Expand Down
62 changes: 33 additions & 29 deletions content/documentation/flash-deployments.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---

title: 'Flash Deployments'
description: 'Flash deploy launches your apps quickly and effortlessly'
image: 'https://docs.cleavr.io/images/cleavr-twitter.png'
video: 'https://youtu.be/wbwQvp7GFag'

title: "Flash Deployments"
description: "Flash deploy launches your apps quickly and effortlessly"
image: "https://docs.cleavr.io/images/cleavr-twitter.png"
video: "https://youtu.be/wbwQvp7GFag"
---

Quickly provision a new server, set up, and deploy your app in one-fell-swoop - giving yourself more time for ☕️, 🚶‍♀️, or 👨🏾‍💻.
Quickly provision a new server, set up, and deploy your app in one-fell-swoop - giving yourself more time for ☕️, 🚶‍♀️, or 👨🏾‍💻.

<YouTube video="wbwQvp7GFag"></YouTube>

## In one-fell-swoop
With Flash Deploy, tell Cleavr what you want to deploy and where to. Cleavr then takes over and -

With Flash Deploy, tell Cleavr what you want to deploy and where to. Cleavr then takes over and -

- Provisions a new server on your selected cloud hosting provider
- Installs all necessary dependencies according to the web app type
- Collects project code from your repository
Expand All @@ -28,7 +28,8 @@ In just a few steps, Cleavr will be working hard for you, freeing up your time f

#### App Type

Select from any app type that is supported by Cleavr, including:
Select from any app type that is supported by Cleavr, including:

- AdonisJS v4 and v5
- NuxtJS SSR and Static
- Laravel PHP
Expand All @@ -40,7 +41,7 @@ Select from any app type that is supported by Cleavr, including:

#### Version Control Provider

If you have already tied your Cleavr account with a VC Provider, you can select it from the list. If not, you may also select the option to
If you have already tied your Cleavr account with a VC Provider, you can select it from the list. If not, you may also select the option to
connect to your GitHub, GitLab, or Bitbucket account.

<base-info>
Expand All @@ -49,18 +50,21 @@ This and the following steps are hidden if you've selected WordPress.

#### Repository

After selecting your VC Provider, you can now enter a repository in any of the following manners:
After selecting your VC Provider, you can now enter a repository in any of the following manners:

- For GitHub, a list of repositories you have access to will be available to select from
- For GitLab or Bitbucket, either enter the full url of the repository or designate by `username/repository-name`
- For GitHub, you can also provide a path to any public repository
- For GitHub, you can also provide a path to any public repository

#### Branch to deploy

Enter the name of the branch to deploy. Be sure this branch exists!
Enter the name of the branch to deploy. Be sure this branch exists!

#### Additional settings for NodeJS-based apps
For NodeJS-based apps, including AdonisJS and NuxtJS, you'll also set the following:
- Entry point

For NodeJS-based apps, including AdonisJS and NuxtJS, you'll also set the following:

- Entry point
- Arguments
- Build command (for Node SSR and Static apps)
- Artifact path (for Node SSR and Static apps)
Expand All @@ -70,49 +74,49 @@ For NodeJS-based apps, including AdonisJS and NuxtJS, you'll also set the follow
#### Server Provider

Select a VPS Provider that Cleavr will provision a new server on. You can choose an existing VPS Provider that you have connected with Cleavr, choose
to connect to a provider at this time, or select <nuxt-link to="custom-servers">Custom Server</nuxt-link> if you'd prefer to use a provider Cleavr does not currently integrate with.
to connect to a provider at this time, or select <nuxt-link to="custom-servers">Custom Server</nuxt-link> if you'd prefer to use a provider Cleavr does not currently integrate with.

<base-alert>
If you select <nuxt-link to="custom-servers">custom</nuxt-link>, then you will be asked to run a script on the server and add that server's public IP.
</base-alert>

#### Server Plan

Choose the plan type you'd like Cleavr to set up on your server.
Choose the plan type you'd like Cleavr to set up on your server.

Just a reminder, you will be billed separately by the provider for the plan you choose.
Just a reminder, you will be billed separately by the provider for the plan you choose.

#### Server Reqion
#### Server Region

Select which server region to provision a server at.
Select which server region to provision a server at.

### How Are We Persisting Data?

Many dynamic apps require a database to connect to. You can have Cleavr also install a database server on your new server, create a new database,
and a new database user. Cleavr will also take care of adding variables to your production .env file.
Many dynamic apps require a database to connect to. You can have Cleavr also install a database server on your new server, create a new database,
and a new database user. Cleavr will also take care of adding variables to your production .env file.

Choose from either a MySQL style database (Maria, MySQL) or a PostgreSQL database.
Choose from either a MySQL style database (Maria, MySQL) or a PostgreSQL database.

Cleavr will create random database name, user name, and password. However, you can choose to change them if you'd like.
Cleavr will create random database name, user name, and password. However, you can choose to change them if you'd like.

### Any Additional Variables Needed?

#### Server name
#### Server name

Cleavr will assign a random server name, but you can customize it.
Cleavr will assign a random server name, but you can customize it.

#### Domain

A free cleavr.rocks domain will be created for your site. But, don't worry! You can apply your own custom domain name afterwards.
A free cleavr.rocks domain will be created for your site. But, don't worry! You can apply your own custom domain name afterwards.

#### Environment Variables

If your app type requires an .env file, we'll pre-populate one for you based on your selected app type. If any additional environment
variables are required for your app in production, please add them here. You can always modify these variables later in the `web app > environment` section.
variables are required for your app in production, please add them here. You can always modify these variables later in the `web app > environment` section.

### Deploy! 🚀

When you're done with the settings, deploy away!

Cleavr will run through the process of provisioning a new server, adding a new site to the server, creating a new web app, and then
Cleavr will run through the process of provisioning a new server, adding a new site to the server, creating a new web app, and then
will deploy your web app. You'll receive an email when the Flash Deployment is complete. 📬
Loading

0 comments on commit 486b486

Please sign in to comment.