From d43736943ef2c1cfe21af26f5343df4dd2d0a344 Mon Sep 17 00:00:00 2001 From: Rodolfo Berrios <20590102+rodber@users.noreply.github.com> Date: Thu, 22 Feb 2024 08:46:17 -0300 Subject: [PATCH] remarks on upgrading --- application/installing/from-free.md | 13 +++++++--- application/installing/installation.md | 33 ++++++++++++++++++-------- application/installing/updating.md | 26 +++++++++++++------- guides/cpanel/README.md | 8 ++----- guides/docker/README.md | 6 +---- guides/plesk/README.md | 8 ++----- guides/server/vps.md | 8 ++----- 7 files changed, 58 insertions(+), 44 deletions(-) diff --git a/application/installing/from-free.md b/application/installing/from-free.md index fbd1d9d..0672f78 100644 --- a/application/installing/from-free.md +++ b/application/installing/from-free.md @@ -1,12 +1,19 @@ # From free -You can upgrade from any free edition to paid Chevereto V4. +You can upgrade from any free edition to paid Chevereto. ## chevereto/chevereto -Users of [chevereto/chevereto](https://github.com/chevereto/chevereto) need to follow the [Updating](updating.md) documentation using the paid edition files. +Users of [chevereto/chevereto](https://github.com/chevereto/chevereto) can one-click upgrade from the dashboard panel. -If you are using [Docker](../../guides/docker/README.md) you will need to build the container image and re-start your containers. +* Go to `/dashboard` +* Click on **License key** button +* Enter license key and click on **Save changes** +* Follow the on-screen upgrade instructions + +To manual upgrade follow the [Updating](updating.md) documentation using the paid edition files. + +**Note:** [Docker](../../guides/docker/README.md) users don't need any of these steps, simply re-build the container image ([make image](https://github.com/chevereto/docker/blob/4.0/docs/BUILDING.md) or [docker build](https://github.com/chevereto/docker/blob/4.0/docs/PURE-DOCKER.md)) and re-start your containers. ## rodber/chevereto-free diff --git a/application/installing/installation.md b/application/installing/installation.md index 9d40f18..460d6eb 100644 --- a/application/installing/installation.md +++ b/application/installing/installation.md @@ -2,18 +2,31 @@ Installation refers to the process where the **software files** gets provided in the target machine. -## Requirements +## Stack -To run Chevereto it will require [PHP](../stack/php.md), [Web Server](../stack/web-server.md), [MySQL database](../stack/mysql-server.md) and [CRON](../stack/cron.md). +Chevereto requires [PHP](../stack/php.md), a [Web Server](../stack/web-server.md), [MySQL database](../stack/mysql-server.md) and [CRON](../stack/cron.md). -## Installation guides +## Official guides -For fresh installations continue with one of the following guides: +For fresh installations continue with one of the following guides. -* [Docker](../../guides/docker/README.md) for installing our container-based provisioning. -* [VPS](../../guides/server/vps.md) for private servers. * [cPanel](../../guides/cpanel/README.md) for cPanel servers. * [Plesk](../../guides/plesk/README.md) for Plesk servers. +* [Docker](../../guides/docker/README.md) for installing our container-based provisioning. +* [VPS](../../guides/server/vps.md) for private servers. + +## Community guides + +The following guides have been contributed by users of the software. + +* [Chevereto on Synology NAS](https://mariushosting.com/how-to-install-chevereto-on-your-synology-nas/) + +## Using installer software + +Chevereto is available at the following installers, look for this software at your hosting control panel. + +* [Installatron](https://installatron.com/chevereto) +* [Softaculous](https://www.softaculous.com/apps/galleries/Chevereto_Free) ## Using release package @@ -24,7 +37,7 @@ The release package is a `zip` file containing the software files. ### Manual (CLI) -Run the following [command](https://github.com/chevereto/vps#get) to download and extract Chevereto package: +Run the following [command](https://github.com/chevereto/vps#get) to download and extract package: ```sh bash <(curl -s https://raw.githubusercontent.com/chevereto/vps/4.0/common/get.sh) @@ -41,12 +54,12 @@ bash <(curl -s https://raw.githubusercontent.com/chevereto/vps/4.0/common/get.sh Once the software files are provided the software is ready for [Setup](#setup). This is required only once per instance. -Setup refers to the process when the Chevereto database tables and its admin user is created. You can carry this process in [HTTP](#http-setup) or [CLI](#cli-install) context. +Setup refers to the process when the Chevereto database tables and its admin user is created. You can carry this process in [HTTP](#install-gui) or [CLI](#install-cli) context. -### HTTP setup +### Install (GUI) * Go to `/install` -### CLI install +### Install (CLI) * Refer to [CLI install](../reference/cli.md#install). diff --git a/application/installing/updating.md b/application/installing/updating.md index dfa17b4..29e826e 100644 --- a/application/installing/updating.md +++ b/application/installing/updating.md @@ -1,20 +1,30 @@ # Updating -This process is for instances already running **Chevereto V4**. To update Chevereto provide the updated software files and then proceed with database update. +This process is for instances already running **Chevereto V4**. The process consist in update software files and then proceed with database migrations. -## Update software files +## Software filesystem update -To update the software files depends on how you installed Chevereto: +To update the software files depends on how you installed Chevereto. Follow the instructions for your installation method. -### Docker +### Release package -When using Docker it will required to re-create the Chevereto image and then re-up the container. Refer to [UPDATING](https://github.com/chevereto/docker/blob/4.0/docs/UPDATING.md) for instructions. +This applies to any non-Docker installation. -### Release package +* Go to `/dashboard` +* Click on **Check upgrades** button +* Follow the on-screen upgrade instructions + +If you need to force upgrade (re-download software files) you can do it by accesing to `/dashboard/?upgrade`. + +For manual upgrade refer to [Installing](installation.md#using-release-package) for instructions on how to install the software files. + +### Docker + +When using Docker it will required to re-build the Chevereto image ([make image](https://github.com/chevereto/docker/blob/4.0/docs/BUILDING.md) or [docker build](https://github.com/chevereto/docker/blob/4.0/docs/PURE-DOCKER.md)) and then re-start the containers. -When using the release package it will required to override the previous version of the software files. Refer to [Installing](installation.md#using-release-package) (using release package) for instructions. +Refer to [UPDATING](https://github.com/chevereto/docker/blob/4.0/docs/UPDATING.md) for instructions. -## Database Update +## Database update Once the software files gets updated it will required to update the Chevereto database schema. This process can be carried on HTTP or command-line context. diff --git a/guides/cpanel/README.md b/guides/cpanel/README.md index 230b4ab..b76447a 100644 --- a/guides/cpanel/README.md +++ b/guides/cpanel/README.md @@ -1,8 +1,4 @@ -# cPanel guide - -::: tip -The *best* deploy alternative for Chevereto is [Docker](../docker/README.md). But Chevereto can be deployed anywhere and this guide may suit your needs. -::: +# Chevereto cPanel 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. @@ -11,7 +7,7 @@ This deploy alternative doesn't require tech knowledge. But it comes at a cost a ## Requirements * cPanel based hosting service -* Chevereto license +* Chevereto license (for paid edition) ## Purchase hosting diff --git a/guides/docker/README.md b/guides/docker/README.md index 51ae00e..1f05479 100644 --- a/guides/docker/README.md +++ b/guides/docker/README.md @@ -1,11 +1,7 @@ -# 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 -This is the **best way** to deploy Chevereto. Docker refers to container technology and is the way in which we ship the server infra needed to run Chevereto. -::: - 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. ## Advantages diff --git a/guides/plesk/README.md b/guides/plesk/README.md index 293b327..ac77f3f 100644 --- a/guides/plesk/README.md +++ b/guides/plesk/README.md @@ -1,8 +1,4 @@ -# Plesk - -::: tip -The *best* deploy alternative for Chevereto is [Docker](../docker/README.md). But Chevereto can be deployed anywhere and this guide may suit your needs. -::: +# Chevereto Plesk 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. @@ -11,7 +7,7 @@ This deploy alternative doesn't require tech knowledge. But it comes at a cost a ## Requirements * Plesk based hosting service -* Chevereto license +* Chevereto license (for paid edition) ## Purchase hosting diff --git a/guides/server/vps.md b/guides/server/vps.md index 59b2fc7..e200cbb 100644 --- a/guides/server/vps.md +++ b/guides/server/vps.md @@ -1,8 +1,4 @@ -# VPS - -::: tip -The *best* deploy alternative for Chevereto is [Docker](../docker/README.md). But Chevereto can be deployed anywhere and this guide may suit your needs. -::: +# Chevereto VPS 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. @@ -20,7 +16,7 @@ For this guide you will require a server. the following: * VPS machine ([Linode](https://chv.to/linode), [Vultr](https://chv.to/vultr), etc.) with Ubuntu 22.04 * Terminal software (iTerm, Windows Shell) -* Chevereto V4 license +* Chevereto license (for paid edition) ## Root login