Skip to content

Commit 25e0113

Browse files
committed
wow, many improves. very handsome.
1 parent 4bf69e9 commit 25e0113

36 files changed

+218
-6
lines changed

application/installing/installation.md

+8
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,14 @@ Use [chevereto/v4-docker-production](https://github.com/chevereto/v4-docker-prod
3838

3939
Use [chevereto/v4-docker](https://github.com/chevereto/v4-docker) for our development standard provisioning. This is preferred when requiring to try, debug or test the software.
4040

41+
## Using panels
42+
43+
Web panels can ease the system provisioning for you as all the requirements are provided by the web panel software.
44+
45+
👉 This is recommended for newcomers.
46+
47+
* [cPanel](../../resources/guides/cpanel.md)
48+
4149
## Other methods
4250

4351
These methods consists in to provide the application files in a file system compatible with the following requirements:
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

developer/naming.php

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
<?php
22

33
return [
4-
'how-to/' => 'How-to Guides',
4+
'api/' => 'API',
5+
'how-to/' => 'How-to',
56
'plugins/' => 'Plugins',
67
'customization/' => 'Customization',
7-
];
8+
];

guides/cpanel/application-files.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# 📂 cPanel Application files
2+
3+
## Installing Chevereto
4+
5+
* Go to **File Manager** under **Files**.
6+
7+
![Files](../../src/manuals/cpanel/files.png)
8+
9+
* Navigate to your home `/home/user/` home directory.
10+
11+
`🚧 picture outdated:`
12+
13+
![File Manager](../../src/manuals/cpanel/file-manager.png)
14+
15+
* Click on **Upload** and on **Select File**
16+
* Upload the release zip file downloaded from [chevereto.com/panel/downloads](https://chevereto.com/panel/downloads) (normal package)
17+
* Once uploaded, go back to the file manager at `/home/user/` directory.
18+
* Right-click on the zip file file and select **Extract**.
19+
20+
![File Manager Extract](../../src/manuals/cpanel/file-manager-extract.png)
21+
22+
* A prompt appears, enter path `/public_html` and click on **Extract Files**
23+
24+
💡 You can customize `/public_html` to reflect the path for your configured website.
25+
26+
![File Manager Extract Files](../../src/manuals/cpanel/file-manager-extract-files.png)
27+
28+
## Updating Chevereto
29+
30+
To update Chevereto on cPanel simply follow the steps described above. That process only alters the application files, it won't touch the website contents.
31+
32+
💡 If you made modifications to the software you may want to review these changes before.

guides/cpanel/cron.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# ⏲️ cPanel CRON
2+
3+
## Add new CRON job
4+
5+
* Go to **Cron Jobs** under **Advanced**
6+
* Scroll to **Add New Cron Job**
7+
8+
![File Manager Delete File](../../src/manuals/cpanel/cronjob.png)
9+
10+
* Under **Common Settings** pick `Once Per Minute (* * * * *)`
11+
12+
The **Command** varies on each installation, you need to create your own command based on the following general form:
13+
14+
```sh
15+
php-binary cli-path -C cron >/dev/null 2>&1
16+
```
17+
18+
* **php-binary** Check the `PHP command examples` section under **Add New Cron Job** where you can learn about the PHP path for your system.
19+
* **cli-path** The Chevereto CLI path can be found on your Dashboard panel under **Installation details**.
20+
21+
### Command examples
22+
23+
<code-group>
24+
<code-block title="General">
25+
```sh
26+
/usr/local/bin/ea-php81 /home/chevereto/public_html/app/bin/legacy -C cron >/dev/null 2>&1
27+
```
28+
</code-block>
29+
30+
<code-block title="CloudLinux">
31+
```sh
32+
/opt/alt/php81/usr/bin/php /home/chevereto/public_html/app/bin/legacy -C cron >/dev/null 2>&1
33+
```
34+
</code-block>
35+
</code-group>

guides/cpanel/database.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# 🐬 cPanel Database
2+
3+
## Creating a database
4+
5+
Go to the **MySQL Database Wizard** under **Databases**. Follow the process to create a database and its user.
6+
7+
![databases](../../src/manuals/cpanel/databases.png)
8+
9+
✅ Take note on the MySQL **database name**, **username** and **password**.
10+
11+
![MySQL wizard create](../../src/manuals/cpanel/mysql-wizard-create-database.png)
12+
13+
Grant `ALL PRIVILEGES` on the newly created database and user.
14+
15+
![MySQL wizard privileges](../../src/manuals/cpanel/mysql-wizard-privileges.png)

guides/cpanel/naming.php

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<?php
2+
3+
return [
4+
'cron.md' => '⏲️ CRON',
5+
'database.md' => '🐬 Database',
6+
'application-files.md' => '📂 Filesystem',
7+
'php.md' => '🐘 PHP',
8+
];

guides/cpanel/php.md

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# 🐘 cPanel PHP
2+
3+
## MultiPHP INI Editor
4+
5+
Go to **MultiPHP INI Editor** under **Software**.
6+
7+
![Software](../../src/manuals/cpanel/software.png)
8+
9+
Select your website under **Configure PHP INI basic settings**.
10+
11+
![MultiPHP INI editor](../../src/manuals/cpanel/mutliphp-ini-editor.png)
12+
13+
Take note on the following configurable keys:
14+
15+
![MultiPHP INI keys](../../src/manuals/cpanel/multiphp-ini-keys.png)
16+
17+
* `max_execution_time` 30
18+
* `memory_limit` 256M (min)
19+
* Use `post_max_size` and `upload_max_filesize` to limit the file upload max. size allowed for uploads
20+
21+
## MultiPHP Manager
22+
23+
Go to **MultiPHP Manager** and select `PHP 8.1` for your website.
24+
25+
![MultiPHP manager](../../src/manuals/cpanel/multiphp-manager.png)
26+
27+
* From here you can also enable the [extensions required](requirements.md#php-extensions) by Chevereto.
28+
29+
::: danger PHP Extensions
30+
Refer to the cPanel [PHP Extensions and Applications Package](https://docs.cpanel.net/whm/software/php-extensions-and-applications-package/) and WHM [How to install a PHP extension in WHM](https://support.cpanel.net/hc/en-us/articles/360050971633) documentation if your cPanel provisioning lacks the extensions required by Chevereto.
31+
:::
32+
33+
## PHP Versioning
34+
35+
::: tip Did you know?
36+
cPanel uses root `.htaccess` file to add rules that enable to override the default cPanel PHP versioning. This may cause issues in your Chevereto installation.
37+
:::
38+
39+
If you have PHP versioning issues make sure that the root `.htaccess` file contains the following:
40+
41+
<code-group>
42+
<code-block title="Apache">
43+
```apacheconf
44+
<IfModule mime_module>
45+
AddHandler application/x-httpd-ea-php81 .php
46+
</IfModule>
47+
```
48+
</code-block>
49+
50+
<code-block title="LiteSpeed">
51+
```apacheconf
52+
<IfModule mime_module>
53+
AddHandler application/x-httpd-ea-php81___lsphp .php
54+
</IfModule>
55+
```
56+
</code-block>
57+
</code-group>
58+
59+
Note that the configuration in your system may vary. Double-check with your service provider.

guides/cpanel/sorting.php

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<?php
2+
3+
return [
4+
'database.md',
5+
'application-files.md',
6+
'php.md',
7+
'cron.md',
8+
];

guides/docker/bootstrap.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# 🛸 Docker Bootstrap
2+
3+
With our Docker bootstrapped repo you can quickly spawn Chevereto on Docker as it uses our public available system layers.
4+
5+
👉 Check the repository at [chevereto/v4-docker](https://github.com/chevereto/v4-docker) for instructions.
6+
7+
Bootstrap means that the application layer is provided on container run (not at container image layer). This method is recommended when you install Chevereto in your local computer, for testing and development purposes as it doesn't require to build any image.

guides/docker/naming.php

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<?php
2+
3+
return [
4+
'bootstrap.md' => '🛸 Bootstrap',
5+
'production.md' => '🌎 Production',
6+
];

guides/docker/production.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# 🌎 Docker Production
2+
3+
With our Docker production repo you can quickly spawn Chevereto for production usage.
4+
5+
👉 Check the repository at [chevereto/v4-docker-production](https://github.com/chevereto/v4-docker-production) for instructions.
6+
7+
Production differs from [bootstrap](bootstrap.md) as the application files are provided at container image layer. In this context, you have to create your own private Chevereto container images.

guides/docker/sorting.php

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<?php
2+
3+
return [
4+
'production.md',
5+
'bootstrap.md',
6+
];

guides/naming.php

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<?php
2+
3+
return [
4+
'cpanel/' => 'cPanel',
5+
'docker/' => 'Docker',
6+
];

guides/sorting.php

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<?php
2+
3+
return [
4+
'docker/',
5+
'cpanel/',
6+
];

manuals/admin.md manual/admin.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
sidebar: false
3+
---
4+
15
# 👸 Admin Manual
26

37
## Description
File renamed without changes.
File renamed without changes.

manuals/user.md manual/user.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
sidebar: false
3+
---
4+
15
# 👩‍💻 User Manual
26

37
## Description

naming.php

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
return [
44
'introduction/' => '🎉 Intro',
55
'application/' => '🦄 App',
6-
'developer/' => '🛸 Dev',
7-
'api/' => '🌎 API',
8-
'manuals/' => '📚 Manuals',
9-
];
6+
'developer/' => '👩‍💻 Dev',
7+
'guides/' => '🕹 Guides',
8+
'manual/' => '📚 Manual',
9+
];

src/manuals/cpanel/cronjob.png

298 KB
Loading

src/manuals/cpanel/databases.png

239 KB
Loading
Loading
Loading
155 KB
Loading

src/manuals/cpanel/file-manager.png

446 KB
Loading

src/manuals/cpanel/files.png

306 KB
Loading
620 KB
Loading
494 KB
Loading
511 KB
Loading
Loading
888 KB
Loading

src/manuals/cpanel/software.png

298 KB
Loading

0 commit comments

Comments
 (0)