Skip to content

Commit c7bee32

Browse files
author
Your Name
committed
Fix typos
1 parent a0684e9 commit c7bee32

2 files changed

Lines changed: 39 additions & 39 deletions

File tree

docs/install.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -116,17 +116,6 @@ You can fill in these settings according to your needs.
116116

117117
![](/img/install/install-completed.png)
118118

119-
## Installing Composer Dependencies for Third-Party Extensions and AWS Translations
120-
121-
From the `lhc_web` folder, run:
122-
123-
> `composer install`
124-
125-
Uncomment these two lines by removing the dashes in `lhc_web/index.php` and `lhc_web/cron.php`.
126-
127-
* https://github.com/LiveHelperChat/livehelperchat/blob/ee3aea143c3f57751206ca4b3cfeee95f4ba51d5/lhc_web/index.php#L31
128-
* https://github.com/LiveHelperChat/livehelperchat/blob/ee3aea143c3f57751206ca4b3cfeee95f4ba51d5/lhc_web/cron.php#L25
129-
130119
## Logging into the Application
131120

132121
After clicking `Login here`, you should be presented with a login window.

docs/upgrading.md

Lines changed: 39 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -3,47 +3,47 @@ id: upgrading
33
title: Upgrading
44
---
55

6-
Here is basic tutorial how to perform upgrades since 2.04 version. This version can update database automatically from any previous LHC version. Since 3.30v we require `composer` dependencies to be installed if you are installing from source code.
6+
This is a basic tutorial on how to perform upgrades since version 2.04. This version can automatically update the database from any previous LHC version. Since version 3.30, we require `composer` dependencies to be installed if you are installing from source code.
77

8-
If you are upgrading from older version to any version 3.30v and higher you have to install composer dependencies.
8+
If you are upgrading from an older version to any version 3.30 or higher, you must install composer dependencies.
99
```
1010
cd lhc_web
1111
composer.phar install
1212
```
1313

14-
If you don't have `composer.phar` you can download it from https://getcomposer.org/download/
14+
If you don't have `composer.phar`, you can download it from https://getcomposer.org/download/.
1515

16-
* You can download version with dependencies included https://github.com/LiveHelperChat/livehelperchat/releases look for newest file name `*.**v-with-dependencies.tgz` **8.2 PHP** version is required.
16+
* You can download a version with dependencies included from https://github.com/LiveHelperChat/livehelperchat/releases. Look for the newest file named `*.**v-with-dependencies.tgz`. **PHP version 8.2** is required.
1717

18-
It has a folder `lib/vendor` in it so you don't need to install composer thing yourself. Copy it to `lib/vendor`
18+
This file includes a folder `lib/vendor`, so you don't need to install composer yourself. Just copy it to `lib/vendor`.
1919

20-
1. Read the new version announcement article for any possible changes in settings/settings.ini.php. If the article does not mention anything, you do not have to do anything.
20+
1. Read the new version announcement article for any possible changes in `settings/settings.ini.php`. If the article does not mention anything, you do not have to do anything.
2121
2. Go to "System" -> "Update information" and check if LHC finds any differences in the database. If it does, click on "Update database." You may not see differences if your server does not allow making requests to remote URLs.
22-
* You need to run these commands from the root folder (where index.php is located)
22+
* You need to run these commands from the root folder (where `index.php` is located).
2323
* `php cron.php -s site_admin -c cron/util/update_database` tries to update the database from a remote URL. If this does not work, run:
2424
* `php cron.php -s site_admin -c cron/util/update_database -p local` after replacing all files.
25-
3. If you accidentally override files before updating the database, you can:
26-
1. [Update the database from the local definition](system/command.md#updates-live-helper-chat-database-directly-from-console)
27-
2. Copy `doc/shell/upgrade.php` to the root folder, the same folder where `index.php` exists.
25+
3. If you accidentally overwrite files before updating the database, you can:
26+
1. [Update the database from the local definition](system/command.md#updates-live-helper-chat-database-directly-from-console).
27+
2. Copy `doc/shell/upgrade.php` to the root folder, the same folder where `index.php` exists.
2828
1. In your browser, enter `https://example.com/upgrade.php` to update the database directly.
2929
4. Log out from LHC.
30-
5. [Download the most recent LHC version](http://livehelperchat.com/article/static/5) Overwrite `doc`,`ezcomponents`,`lib`,`modules`,`pos`,`translations`,`design` folders. Also, overwrite `index.php` and `cron.php` files with the new version.
31-
1. https://github.com/remdex/livehelperchat/archive/master.zip - latest master branch zip without composer denpendencies
30+
5. [Download the most recent LHC version](http://livehelperchat.com/article/static/5). Overwrite the following folders: `doc`, `ezcomponents`, `lib`, `modules`, `pos`, `translations`, and `design`. Also, overwrite `index.php` and `cron.php` files with the new version.
31+
1. https://github.com/remdex/livehelperchat/archive/master.zip - latest master branch zip without composer dependencies.
3232
2. https://github.com/LiveHelperChat/livehelperchat/releases - latest release with composer dependencies.
3333
6. Overwrite `composer.json` and `composer.lock` files and run `composer.phar install` or `composer.phar update` command.
34-
7. Disable [cache in settings.ini.php](debug.md#disabling-cache)
35-
8. Log in to LHC again and go to `"System configuration" -> "Clear Cache" and click Clear Cache`
36-
1. You can also clear the cache by executing this command from the command line: `php cron.php -s site_admin -c cron/util/clear_cache`
37-
9. Now you can re-enable the cache in your `settings.ini.php`
38-
10. If you still encounter errors, then [Enable debug output](debug.md)
34+
7. Disable [cache in `settings.ini.php`](debug.md#disabling-cache).
35+
8. Log in to LHC again and go to `"System configuration" -> "Clear Cache"` and click "Clear Cache."
36+
1. You can also clear the cache by executing this command from the command line: `php cron.php -s site_admin -c cron/util/clear_cache`.
37+
9. Now you can re-enable the cache in your `settings.ini.php`.
38+
10. If you still encounter errors, then [Enable debug output](debug.md).
3939

4040
If you are updating from any older version, you can follow this pattern, which can also be applied to new versions:
4141

42-
1. [Download the most recent LHC version](http://livehelperchat.com/article/static/5) Overwrite the following folders `doc`,`ezcomponents`,`lib`,`modules`,`pos`,`translations`,`design` folders. Also, overwrite `index.php` and `cron.php` files with the new version.
43-
2. Install composer dependencies as described above. You can just download most recent https://github.com/LiveHelperChat/livehelperchat/releases `*.**v-with-dependencies.tgz` file and copy `lhc_web/lib/vendor` to your existing installation. This folder should be non existing if you are upgrading from older version than 4.29v
44-
3. Copy from doc/shell/upgrade.php file to the root folder of LHC.
45-
4. In your browser, type chatfolder/upgrade.php. It will update the database to the most recent version and clear the cache automatically.
46-
5. Delete upgrade.php from the root folder.
42+
1. [Download the most recent LHC version](http://livehelperchat.com/article/static/5). Overwrite the following folders: `doc`, `ezcomponents`, `lib`, `modules`, `pos`, `translations`, and `design`. Also, overwrite `index.php` and `cron.php` files with the new version.
43+
2. Install composer dependencies as described above. You can just download the most recent `*.**v-with-dependencies.tgz` file from https://github.com/LiveHelperChat/livehelperchat/releases and copy `lhc_web/lib/vendor` to your existing installation. This folder should not exist if you are upgrading from a version older than 4.29.
44+
3. Copy `doc/shell/upgrade.php` to the root folder of LHC.
45+
4. In your browser, type `chatfolder/upgrade.php`. It will update the database to the most recent version and clear the cache automatically.
46+
5. Delete `upgrade.php` from the root folder.
4747

4848
In all cases, I suggest making a backup.
4949

@@ -52,21 +52,32 @@ In all cases, I suggest making a backup.
5252

5353
## How to make PHP 8.1 version compatible?
5454

55-
You will loose facebook messenger compatibility.
55+
You will lose Facebook Messenger compatibility.
5656

57-
* Modify `lhc_web/composer.json` file and
58-
* Change `"php": ">=8.2"` to `"php": ">=8.1"
57+
* Modify the `lhc_web/composer.json` file and
58+
* Change `"php": ">=8.2"` to `"php": ">=8.1"`.
5959
* Remove
6060

6161
```
6262
"tgallice/fb-messenger-sdk": "dev-master#47498e9926df01f2633835ff3ffb310f88ac444f",
6363
"symfony/event-dispatcher": "^7.1",
6464
```
6565

66-
* Execute `composer.phar update`
66+
* Execute `composer.phar update`.
6767

6868
## Permissions
6969

70-
To be able to see `Update information` operator has to have
70+
To be able to see `Update information`, the operator must have
71+
72+
> 'lhsystem', 'performupdate'.
73+
74+
## Troubleshooting Upgrade Issues
75+
76+
If you encounter issues during the upgrade process, consider the following steps:
77+
78+
1. Ensure that all files have been correctly uploaded and that there are no missing files.
79+
2. Check the server error logs for any specific error messages that may indicate what went wrong.
80+
3. Verify that your PHP version meets the requirements specified in the documentation.
81+
4. If the upgrade fails, you can revert to the previous version by restoring from the backup you created before starting the upgrade.
82+
5. Consult the community forums or support channels for assistance if you are unable to resolve the issue.
7183

72-
> 'lhsystem','performupdate'

0 commit comments

Comments
 (0)