From 5d9c6ffbf7266e608fc278af462c9c10d384d4ae Mon Sep 17 00:00:00 2001 From: Rodolfo Berrios <20590102+rodber@users.noreply.github.com> Date: Sat, 20 Nov 2021 20:45:15 -0300 Subject: [PATCH] doc improves --- README.md | 33 ++++++++++++--------------------- UPGRADING.md | 6 +++--- 2 files changed, 15 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 30f3981..1c0b65d 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,6 @@ Chevereto-Free allows you to create a full-featured image hosting website on your own server. It's your hosting and your rules, say goodbye to closures and restrictions. -## Project status - -Starting on **2021-10** the [Chevereto](https://chevereto.com) organization won't be in charge of this project and the repo ownership will be transferred to [@rodber](https://github.com/rodber). - ## Screens ![Homepage](.github/screen/1a.webp) @@ -38,8 +34,7 @@ Chevereto-Free is forked from [Chevereto V3.16.2](https://releases.chevereto.com 👉 **This fork misses** -* [Installer](https://github.com/chevereto/installer) tooling -* All non-security updates added in [V3.17](https://releases.chevereto.com/3.X/3.17/3.17.2.html), [V3.18](https://releases.chevereto.com/3.X/3.18/3.18.3.html) and [V3.20](https://releases.chevereto.com/3.X/3.20/3.20.12.html) including: +* All updates (non-security) added in [V3.17](https://releases.chevereto.com/3.X/3.17/3.17.2.html), [V3.18](https://releases.chevereto.com/3.X/3.18/3.18.3.html) and [V3.20](https://releases.chevereto.com/3.X/3.20/3.20.12.html) including: * 360 images * Nested albums * ImageMagick support @@ -48,16 +43,20 @@ Chevereto-Free is forked from [Chevereto V3.16.2](https://releases.chevereto.com * 12FA Support * CLI API -## Installation - -### Requirements +## Requirements * PHP 7.4 * MySQL 5.7 / 8 - MariaDB 10 * Apache HTTP Web Server * mod_rewrite -## Composer-based installation +## Installation + +### cPanel + +* Check the [Chevereto cPanel setup](https://v3-docs.chevereto.com/setup/server/cpanel.html). + +### Composer-based installation * Requires [Composer](https://getcomposer.org) @@ -71,23 +70,15 @@ composer create-project rodber/chevereto-free . \ --ignore-platform-reqs ``` -## Manual installation +### Manual installation * Pick the [latest release](https://github.com/rodber/chevereto-free/releases/latest) * Download the tagged `$TAG.zip` release artifact * Unzip the release in your target `public` web-server directory -## Updating +## Upgrading -### HTTP self-update - -* Go to `/dashboard` -* Click on "Check for updates" -* Follow the on-screen process - -### Manual update - -See [Manual Installation](#manual-installation) +* Check [UPGRADING](UPGRADING.md) ## License diff --git a/UPGRADING.md b/UPGRADING.md index e32f9ff..cadbe22 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -1,6 +1,6 @@ # Upgrading -To keep the software updated you have to simply keep the application files updated. You can update either: +👉 Keep the application files updated. You can update either by: * Using the built-in updater at `/dashboard` > Click **check for updates** * Downloading a [Release](https://github.com/rodber/chevereto-free/releases) and **Extract to** the application filesystem @@ -8,7 +8,7 @@ To keep the software updated you have to simply keep the application files updat ## Upgrade to Paid -🤑 There's a paid Chevereto version which you can update from Chevereto-Free. To upgrade to paid: +🤑 To upgrade to paid: * Purchase a [Chevereto License](https://chevereto.com/pricing) (if you don't have one already 💖) * Upload the [latest release](https://chevereto.com/panel/downloads) package to your server (usually in the `public_html` folder) @@ -16,4 +16,4 @@ To keep the software updated you have to simply keep the application files updat * Remove the `.zip` file * Open your website at `/install` -Docker users check [chevereto/docker](https://github.com/chevereto/docker) and [chevereto/container-builder](https://github.com/chevereto/container-builder) +Docker users check [chevereto/docker](https://github.com/chevereto/docker) and [chevereto/container-builder](https://github.com/chevereto/container-builder). \ No newline at end of file