Skip to content

Commit

Permalink
typos
Browse files Browse the repository at this point in the history
  • Loading branch information
rodber committed Feb 16, 2024
1 parent d82a4a5 commit fd28094
Show file tree
Hide file tree
Showing 62 changed files with 299 additions and 321 deletions.
10 changes: 5 additions & 5 deletions .vuepress/config-project.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
module.exports = {
title: 'Chevereto V4 docs',
description: 'Self-hosted media hosting',
title: 'Chevereto V4 Docs',
description: 'Image hosting software',
head: [
['link', {
rel: 'icon',
href: `/logo.svg`
href: '/logo.png'
}],
['link', {
rel: 'manifest',
Expand All @@ -24,7 +24,7 @@ module.exports = {
}],
['link', {
rel: 'apple-touch-icon',
href: '/logo.svg'
href: '/logo.png'
}],
['link', {
rel: 'mask-icon',
Expand All @@ -33,7 +33,7 @@ module.exports = {
}],
['meta', {
name: 'msapplication-TileImage',
content: '/logo.svg'
content: '/logo.png'
}],
['meta', {
name: 'msapplication-TileColor',
Expand Down
27 changes: 10 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,37 @@
---
home: true
heroImage: /logo.svg
heroText: Chevereto V4 Documentation
heroText: Chevereto V4 Docs
tagline: Image hosting software
actionText: Get Started →
actionLink: /introduction/get-started/welcome
features:
- title: 🦄 Self-hosted
details: Own and control your online media.
- title: ✨ Turnkey
details: Configure it to meet your needs.
- title: 😎 Full-featured
details: With incremental updates.
footer: Created by Rodolfo Berrios
---

# 📦 Install
# Install

Install Chevereto following our guides for:

* [🐋 Docker](./guides/docker/README.md)
* [🏝 VPS](./guides/server/vps.md)
* [🎛 cPanel](./guides/cpanel/README.md)
* [🎛 Plesk](./guides/plesk/README.md)
* [Docker](./guides/docker/README.md)
* [VPS](./guides/server/vps.md)
* [cPanel](./guides/cpanel/README.md)
* [Plesk](./guides/plesk/README.md)

Review our [Installation](application/installing/installation.md) for all alternatives.

## 🚀 Upgrading
## Upgrading

For Chevereto V3 users:

* Follow the [Upgrading](application/installing/upgrading.md) guide.
* Check the [Welcome Back](introduction/changelog/welcome-back.md#chevereto-v4-vs-v3) comparison.
* Check the [Welcome Back](introduction/changelog/welcome-back.md#chevereto-v4-vs-v3) guide.

## 🆙 Updating
## Updating

For Chevereto V4 users:

* Follow the [Updating](application/installing/updating.md) guide to keep your system updated.

## 🛟 Support
## Support

Go to [chevereto.com/support](https://chevereto.com/support).
6 changes: 3 additions & 3 deletions application/configuration/configuring.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# ⚙️ Configuring
# Configuring

Chevereto V4 uses [environment variables](environment.md) for configuring system level settings.

💡 Environment variables configured at `ENV` system level will **override** the configuration at `app/env.php`.
Environment variables configured at `ENV` system level will **override** the configuration at `app/env.php`.

## Using `app/env.php`

Expand All @@ -28,7 +28,7 @@ For these you will be running [PHP-FPM](https://www.php.net/manual/en/install.fp

For these you will be running PHP CLI so you should be able to pass those at `php.ini` for your CLI. You can also `export` those in your shell.

👉 Refer to the documentation of each application server for the best way to pass environment variables to Chevereto.
Refer to the documentation of each application server for the best way to pass environment variables to Chevereto.

### Container

Expand Down
6 changes: 3 additions & 3 deletions application/configuration/env.php.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# 📌 app/env.php
# app/env.php

The file at `app/env.php` contains the application system level settings.

💡 This applies for `ENV` variables not set as `app/env.php` has **lower priority** than [ENV](environment.md).
This applies for `ENV` variables not set as `app/env.php` has **lower priority** than [ENV](environment.md).

## Creating the file

👉 The system requires to pass only the values that **overrides** the [defaults](#defaults).
The system requires to pass only the values that **overrides** the [defaults](#defaults).

This file will be created on installation after submitting the database details. You can also manually create it. It may look like this:

Expand Down
8 changes: 4 additions & 4 deletions application/configuration/environment.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# 🗿 Environment
# Environment

## Assets variables

Environment variables for storing assets that can be uploaded to any of the supported external storage APIs. Assets refers to user provided assets such as avatars and backgrounds, also website graphics like logos and homepage covers.

💡 Check [External storage](https://v4-admin.chevereto.com/features/external-storage.html) for adding external storage servers for user content uploads.
Check [External storage](https://v4-admin.chevereto.com/features/external-storage.html) for adding external storage servers for user content uploads.

| Variable | Example |
| ------------------------------------ | -------------- |
Expand Down Expand Up @@ -105,7 +105,7 @@ Environment variables for the context where Chevereto system is being provided.

Environment variables that limits the use for Chevereto

💡 Zero `0` means no limit.
Zero `0` means no limit.

| Variable | Example |
| ------------------------------ | ------- |
Expand All @@ -120,7 +120,7 @@ Environment variables that limits the use for Chevereto

Environment variables for the file uploading limits. It applies only for our container provisioning.

👉 For **non-container** based provisioning you need to change these settings at [php.ini configuration](../stack/php.md#php-configuration).
For **non-container** based provisioning you need to change these settings at [php.ini configuration](../stack/php.md#configuration).

| Variable | Example |
| ------------------------------------ | ------- |
Expand Down
8 changes: 4 additions & 4 deletions application/configuration/naming.php
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?php

return [
'configuring.md' => '⚙️ Configuring',
'environment.md' => '🗿 Environment',
'env.php.md' => '📌 app/env.php',
];
'configuring.md' => 'Configuring',
'environment.md' => 'Environment',
'env.php.md' => 'app/env.php',
];
2 changes: 1 addition & 1 deletion application/installing/from-free.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 😌 From free
# From free

You can upgrade from any free edition to paid Chevereto V4.

Expand Down
14 changes: 7 additions & 7 deletions application/installing/installation.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 📦 Installation
# Installation

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

Expand All @@ -10,17 +10,17 @@ To run Chevereto it will require [PHP](../stack/php.md), [Web Server](../stack/w

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.
* [cPanel](../../guides/cpanel/README.md) for cPanel servers.
* [Plesk](../../guides/plesk/README.md) for Plesk servers.

## Using release package

The release package is a `zip` file containing the software files.

* 👑 Paid edition package available at your [client panel](https://chevereto.com/panel/downloads).
* 💡 Free edition package available at [chevereto/chevereto](https://github.com/chevereto/chevereto/releases).
* Paid edition package available at your [client panel](https://chevereto.com/panel/downloads).
* Free edition package available at [chevereto/chevereto](https://github.com/chevereto/chevereto/releases).

### Manual (CLI)

Expand Down
8 changes: 4 additions & 4 deletions application/installing/naming.php
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<?php

return [
'installation.md' => '📦 Installation',
'updating.md' => '🆙 Updating',
'upgrading.md' => '🚀 Upgrading',
'from-free.md' => '😌 From free',
'installation.md' => 'Installation',
'updating.md' => 'Updating',
'upgrading.md' => 'Upgrading',
'from-free.md' => 'From free',
];
2 changes: 1 addition & 1 deletion application/installing/updating.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 🆙 Updating
# Updating

This process is for instances already running **Chevereto V4**. To update Chevereto provide the updated software files and then proceed with database update.

Expand Down
8 changes: 4 additions & 4 deletions application/installing/upgrading.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# 🚀 Upgrading
# Upgrading

This process is for upgrading to Chevereto V4 from **Chevereto V3.20** (previous major release). Check [Upgrading Free](upgrading-free.md) if you need to upgrade from a free edition.
This process is for upgrading to Chevereto V4 from **Chevereto V3.20** (previous major release). Check [Upgrading Free](./from-free.md) if you need to upgrade from a free edition.

💡 Review [Chevereto V4 vs V3](../../introduction/changelog/welcome-back.md#chevereto-v4-vs-v3) comparison tables for a better understanding of changes in V4.
Review [Chevereto V4 vs V3](../../introduction/changelog/welcome-back.md#chevereto-v4-vs-v3) comparison tables for a better understanding of changes in V4.

## Requirements

Expand All @@ -19,7 +19,7 @@ Follow these step:
* Override Chevereto V3 files with Chevereto V4 files
* Switch to PHP 8
* Create [app/env.php](../configuration/env.php.md) (see remark below)
* Proceed with [database update](updating.md##database-update)
* Proceed with [database update](updating.md#database-update)

### Application settings

Expand Down
4 changes: 2 additions & 2 deletions application/reference/cli.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 💻 CLI
# CLI

`app/bin/legacy`

Expand Down Expand Up @@ -103,7 +103,7 @@ The `decrypt-secrets` command decrypts the application secrets stored as cipher
app/bin/legacy -C decrypt-secrets
```

💡 After running the above command set `CHEVERETO_ENCRYPTION_KEY` to **empty string** to disable encryption.
After running the above command set `CHEVERETO_ENCRYPTION_KEY` to **empty string** to disable encryption.

## Htaccess

Expand Down
4 changes: 2 additions & 2 deletions application/reference/encryption.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 🔑 Encryption
# Encryption

Chevereto uses [ChaCha20](https://datatracker.ietf.org/doc/html/rfc7539) algorithm to cipher secrets and sensitive data. When enabled, Chevereto will store these values encrypted in the database.

Expand Down Expand Up @@ -64,7 +64,7 @@ Handle the encryption key with the same discretion of a password.

To enable encryption provide the [CHEVERETO_ENCRYPTION_KEY](../configuration/environment.md#encryption-key) environment variable.

🪶 This key is automatic provided when using [HTTP setup](../installing/installation.md#http-setup), stored in the [env.php](../configuration/env.php.md) file.
This key is automatic provided when using [HTTP setup](../installing/installation.md#http-setup), stored in the [env.php](../configuration/env.php.md) file.

### From previous versions

Expand Down
6 changes: 3 additions & 3 deletions application/reference/errors.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 😖 Errors
# Errors

Chevereto application errors can happen by several causes, including server issues. In a multi-layered system like this is crucial to understand when an error is caused by Chevereto and not *something else*.

Expand Down Expand Up @@ -28,7 +28,7 @@ The id is randomly generated and is unique per error event.

> Please try again later. If the problem persist don't hesitate to contact the system administrator.
💡 **Note:** You are the system administrator.
**Note:** You are the system administrator.

This [silent message](https://chevere.github.io/throwable-handler/demo/output/html-silent.html) indicates an error caught by Chevereto, but without disclosing the actual cause of error. Go to [Debug](../../developer/how-to/debug.md) to learn how to retrieve these from the [configured log device](../configuration/environment.md#error-logging-variables).

Expand All @@ -50,6 +50,6 @@ If at `/update` you see a message which reads `# Dumped update query (...)` it m

A generic error response emitted by the [web server](../stack/web-server.md), indicates the existence of an error but it doesn't specify any concrete explication for it.

As these may spawn in any layer, check the system [error log](../../developer/how-to/debug.md#accessing-logs) device to determine if it is triggered in the application layer. If is not there then check for the error log for your web server.
As these may spawn in any layer, check the system [error log](../../developer/how-to/debug.md#finding-the-logs) device to determine if it is triggered in the application layer. If is not there then check for the error log for your web server.

Refer to your web server provisioning documentation for retrieving its logs.
8 changes: 4 additions & 4 deletions application/reference/naming.php
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<?php

return [
'cli.md' => '💻 CLI',
'errors.md' => '😖 Errors',
'security.md' => '👮‍♀️ Security',
'encryption.md' => '🔑 Encryption',
'cli.md' => 'CLI',
'errors.md' => 'Errors',
'security.md' => 'Security',
'encryption.md' => 'Encryption',
];
8 changes: 4 additions & 4 deletions application/reference/security.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# 👮‍♀️ Security
# Security

## Security Checklist

Must **constantly double-checking** the following:

* [PHP Filesystem](../stack/php.md#php-filesystem)
* [PHP Filesystem](../stack/php.md#filesystem)
* [Real connecting IP](../stack/web-server.md#real-connecting-ip)
* [Restrict access to PHP files](../stack/web-server.md#restrict-direct-access-to-php-files)
* [Restrict access to PHP files](../stack/web-server.md#restrict-php)
* [CRON setup](../stack/cron.md)
* [Email setup](https://v4-admin.chevereto.com/settings/email.html)

Expand Down Expand Up @@ -46,7 +46,7 @@ Entering an integer value like `5000` will instruct the system to generate IDs u

#### Altering `chv_images` table

💡 This method won't affect any previous generated links.
This method won't affect any previous generated links.

Go to the database, find the `chv_images` table and change the `AUTOINCREMENT` to the ID padding you want to use.

Expand Down
8 changes: 4 additions & 4 deletions application/stack/cron.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# ⏲️ CRON
# CRON

Chevereto requires to setup [cron](https://en.wikipedia.org/wiki/Cron) to run background jobs.

💡 This cron setup reference applies *mostly* for **Debian-based** systems. We **recommend** checking your server documentation on how to setup and run cron.
This cron setup reference applies *mostly* for **Debian-based** systems. We **recommend** checking your server documentation on how to setup and run cron.

👏 Consider to contribute to this documentation by improving this document with alternative cron setup alternatives.
Consider to contribute to this documentation with alternative cron setup alternatives.

## What it does?

Expand All @@ -28,7 +28,7 @@ Having issues? Check the following common pitfalls:

The command should be run by the web-server user which is `www-data` (may vary). To run the command in Chevereto it requires to call PHP binary at the Chevereto CLI.

💡 Use `which php` to locate the PHP binary as its location.
Use `which php` to locate the PHP binary as its location.

Refer to [CLI Cron](../reference/cli.md#cron).

Expand Down
6 changes: 3 additions & 3 deletions application/stack/mysql-server.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# 🐬 MySQL Server
# MySQL Server

| Version | MySQL | MariaDB |
| ------- | ------ | ------- |
| 4.0 | 5.7, 8 | 10 |

💡 Chevereto support both MySQL/MariaDB database servers but we refer indistinctly as **MySQL**.
Chevereto support both MySQL/MariaDB database servers but we refer indistinctly as **MySQL**.

Chevereto V4 rely in a [RDBMS](https://en.wikipedia.org/wiki/Relational_database) provided by a MySQL server.

Expand Down Expand Up @@ -35,7 +35,7 @@ Database user must have `ALL PRIVILEGES` over the target database.

InnoDB table storage engine.

👉 Old versions using MyISAM table storage engine will require to convert the old tables to InnoDB. Read [Convert MyISAM tables to InnoDB](https://dev.mysql.com/doc/refman/8.0/en/converting-tables-to-innodb.html)
Old versions using MyISAM table storage engine will require to convert the old tables to InnoDB. Read [Convert MyISAM tables to InnoDB](https://dev.mysql.com/doc/refman/8.0/en/converting-tables-to-innodb.html)

## Creating the database

Expand Down
12 changes: 6 additions & 6 deletions application/stack/naming.php
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<?php

return [
'php.md' => '🐘 PHP',
'mysql-server.md' => '🐬 MySQL Server',
'web-server.md' => '🪶 Web Server',
'cron.md' => 'CRON',
'operating-system.md' => '🐧 Operating system',
];
'php.md' => 'PHP',
'mysql-server.md' => 'MySQL Server',
'web-server.md' => 'Web Server',
'cron.md' => '⏲CRON',
'operating-system.md' => 'Operating system',
];
Loading

0 comments on commit fd28094

Please sign in to comment.