Skip to content

Commit

Permalink
typos
Browse files Browse the repository at this point in the history
  • Loading branch information
rodber committed May 10, 2024
1 parent 51b4b98 commit 22640e2
Show file tree
Hide file tree
Showing 5 changed files with 60 additions and 15 deletions.
4 changes: 4 additions & 0 deletions application/installing/installation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Installation

::: tip Installation service available
We offer a [paid installation service](https://chevereto.com/support) for Chevereto. We will install Chevereto for you, including all the requirements and configurations.
:::

Installation refers to the process where the **software files** gets provided in the target machine.

## Stack
Expand Down
4 changes: 4 additions & 0 deletions guides/cpanel/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Chevereto cPanel

::: tip Installation service available
We offer a [paid installation service](https://chevereto.com/support) for this guide. We will install Chevereto cPanel for you, including all the requirements and configurations.
:::

cPanel is a web panel software available in managed servers, which are machines where the system libraries are installed and provisioned by your provider. In managed servers there's no need to install packages or compile libraries as cPanel provides an user interface for configuring the server.

This deploy alternative doesn't require tech knowledge. But it comes at a cost as the system infrastructure is not on your control. If you are new to self-hosted and need the convenience of an easy system with user interface this is a good starting point.
Expand Down
59 changes: 44 additions & 15 deletions guides/docker/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# Chevereto Factory
# Chevereto Docker

Roll your own multi-website Chevereto infrastructure with Chevereto Factory, a Docker-based system that allows you to deploy and maintain multiple Chevereto websites on demand.
::: tip Installation service available
We offer a [paid installation service](https://chevereto.com/support) for this guide. We will install Chevereto Docker for you, including all the requirements and configurations.
:::

By the end of this tutorial, you'll have your own Chevereto Factory up and running, capable of deploying and maintaining multiple Chevereto websites on demand, all with automatic sub-domain creation and renewable HTTPS certificates.
Roll your own multi-website Chevereto infrastructure with Chevereto Docker, a Docker-based system that allows you to deploy and maintain one or multiple Chevereto websites on demand.

By the end of this tutorial, you'll have your own Chevereto Docker up and running, capable of deploying and maintaining multiple Chevereto websites on demand, all with automatic sub-domain creation and renewable HTTPS certificates.

## Advantages

Expand All @@ -22,15 +26,15 @@ Check the project repository at [chevereto/docker](https://github.com/chevereto/

To follow this guide, make sure you have:

* A Ubuntu server with shell access and public IP address.
* A domain managed by CloudFlare (if using integration)
* A Chevereto license (required for the paid edition)
* Ubuntu server with shell access and public IP address.
* Domain managed by CloudFlare (if using integration)
* Chevereto license (required for the paid edition)
* [Purchase](https://chevereto.com/pricing) new license
* [Access](https://chevereto.com/panel/license) existing purchase

## Getting a server

You'll need a server where you can install Chevereto Factory For this guide we recommend an Ubuntu server, but any Unix-like system will do.
You'll need a server where you can install Chevereto Docker For this guide we recommend an Ubuntu 24.04 server, but any Unix-like system will do.

## Accessing server shell

Expand All @@ -55,16 +59,16 @@ Make sure to check your server provider's documentation for specific instruction
Start by installing Chevereto Docker repository and its dependencies by running the following command.

```sh
bash <(curl -s https://chevereto.com/sh/ubuntu/22.04/docker.sh)
bash <(curl -s https://chevereto.com/sh/ubuntu/24.04/docker.sh)
```

## Setting up CloudFlare integration

Skip this section if you don't need CloudFlare integration to manage domain DNS.

Integrate Chevereto Factory with CloudFlare to automate sub-domain creation for your websites. If you aren't using CloudFlare go to [cloudflare.com](https://cloudflare.com) to get started, it is free. Add your domain to continue with this guide.
Integrate Chevereto Docker with CloudFlare to automate sub-domain creation for your websites. If you aren't using CloudFlare go to [cloudflare.com](https://cloudflare.com) to get started, it is free. Add your domain to continue with this guide.

To setup CloudFlare with Chevereto Factory:
To setup CloudFlare with Chevereto Docker:

* Navigate to the DNS configuration for your domain on CloudFlare.
* Create a new A record, take note as it will be your `CLOUDFLARE_A_NAME` environment value. Use the following properties:
Expand Down Expand Up @@ -92,14 +96,14 @@ To create the configuration file run the following command and follow the on-scr
make env
```

* `CHEVERETO_KEY`: Your Chevereto license key (required for the paid edition, leave empty for free edition).
* `DOMAIN`: The domain you'll use for spawning Chevereto installations.
* `CHEVERETO_LICENSE_KEY`: Your Chevereto license key (required for the paid edition, leave empty for free edition).
* `DOMAIN`: The domain/hostame you'll use for spawning Chevereto installations.
* `EMAIL_HTTPS`: The email to receive HTTPS certificate notifications from Let’s Encrypt.
* `CLOUDFLARE_*` options: Integration details for CloudFlare.

## Setting up system

By setting up the system you will enable background processing and ingress HTTP proxy.
By setting up the system you will enable background processing and NGINX ingress HTTP proxy.

To set up the system run the following command:

Expand Down Expand Up @@ -135,11 +139,36 @@ make deploy NAMESPACE=demo ADMIN_EMAIL=email@mywebsite.com

The Chevereto website will be available within seconds as the new sub-domain propagates.

## Updating your websites
## Upgrading your websites

To upgrade you need to (1) Sync repository, (2) Re-build the container image, and (3) Update Chevereto instances.

### Step 1: Sync repository

To update re-build the Chevereto container image and run the update command.
Sync this repository to get the latest changes.

```sh
make sync
```

**Note:** If there's a new branch (for example 4.2) switch to that branch running the following command:

```sh
git switch 4.2
```

### Step 2: Re-build the container image

Build a new container image to reflect the newest release.

```sh
make image
```

### Step 3: Update Chevereto instances

This will down and re-up the containers and carry the required database update.

```sh
make update
```
4 changes: 4 additions & 0 deletions guides/plesk/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Chevereto Plesk

::: tip Installation service available
We offer a [paid installation service](https://chevereto.com/support) for this guide. We will install Chevereto Plesk for you, including all the requirements and configurations.
:::

Plesk is a web panel software available in managed servers, which are machines where the system libraries are installed and provisioned by your provider. In managed servers there's no need to install packages or compile libraries as Plesk provides an user interface for configuring the server.

This deploy alternative doesn't require tech knowledge. But it comes at a cost as the system infrastructure is not on your control. If you are new to self-hosted and need the convenience of an easy system with user interface this is a good starting point.
Expand Down
4 changes: 4 additions & 0 deletions guides/server/vps.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Chevereto VPS

::: tip Installation service available
We offer a [paid installation service](https://chevereto.com/support) for this guide. We will install Chevereto VPS for you, including all the requirements and configurations.
:::

VPS stands for Virtual Private Server which for our purpose is described as the type of server where you get root access to install Linux on it.

This deploy alternative provides superb customization. But it comes at a cost as it requires complete system administration.
Expand Down

0 comments on commit 22640e2

Please sign in to comment.