install.html updated according to the last migration of cypht to dotenv #49
Conversation
Shadow243
force-pushed
the
env-file-support
branch
from
0a3ee7d to
a5da80c
Compare
|
Some people use Cypht 1.4.x Given the massive changes we made for 2.0, we will support 1.4.x for a while after the release of 2.0 So I guess we need two pages? |
|
See also: #46 |
|
One with hm3.ini(the old structure) and the other one for dotenv updates? configuration structure has completely changed, it will indeed be difficult for someone using version 1.4.x to find the documentation with hm3.ini. It may be necessary to give it the opportunity to choose the version to read here: install.html (2 pages).
|
Yes |
|
And please keep in mind recent changes like #46 |
Shadow243
force-pushed
the
env-file-support
branch
from
a5da80c to
125a3c2
Compare
|
install-dotenv.html add in separation with install.html which explains the installation of the version that supports hm3.ini |
|
In 4-8 weeks, we will release Cypht 2.0 which has many enhancements including environment variables. Once Cypht 2.0 is released, we will continue to maintain Cypht 1.4.x for security fixes (and maybe bug fixes) for a few months, maybe more. Tiki 24x bundles Cypht 1.4.x Then, Cypht master will evolve from which we will release 2.1 or 3.0 install-dotenv.html will confuse some users as they have no idea what is an environment variable. I suggest to spli as follows
|
Shadow243
force-pushed
the
env-file-support
branch
from
125a3c2 to
b93f2ae
Compare
Renamed to install-1x.html and install-2x.html Done. |
marclaporte
requested review from
IrAlfred,
aggestor,
Baraka24 and
Bienvenumoringa
and removed request for
josaphatim
|
What if users are on windows operating systems? This install documentation fits Linux, Debian, Mac users only... shouldn't we provide windows users steps too? @Shadow243. |
Good point @Baraka24 Please handle in a different MR with @aggestor @IrAlfred @Bienvenumoringa as part of your dev documentation review. |
install-2x.html
Outdated
| # List installed PHP extensions. at least OpenSSL, mbstring and cURL should be in the list | ||
| php -m</pre></p> | ||
| <h4>2. Download and prepare the code</h4> | ||
| <p>It's important to consider where you put the Cypht source. The web-server will need read-only access to it, and moving it from one place to another requires re-running the configuration script. Do NOT put the source in the document root as this could create a security risk. On Debian, it's common to use the /usr/local/share/ sub-directory for a situation like this. Here is short bash script that will download the latest code, setup the correct permissions and ownership, put the source in /usr/local/share/cypht, and create a default hm3.ini file. It requires sudo access: |
There was a problem hiding this comment.
@Shadow243, in version 2, we no longer use hm3.ini file, instead we use .env file
There was a problem hiding this comment.
@Shadow243 So you will update?
| <p>The /var/lib/hm3/users directory is only required if you are using the file-system and not a database to store user settings (user_config_type = file in the hm3.ini). You can put these directories anywhere, just make sure the values in the ini file point to the right place. | ||
| </p> | ||
| <h4>4. Generate Dynamic Run-Time Configuration</h4> | ||
| <p>Cypht utilizes a build process to create an optimized configuration and to combine and minimize page assets. Previously, after editing the hm3.ini file, the configuration and asset minimization were generated using the following steps:</p> |
There was a problem hiding this comment.
I hope in version 2, we no longer use hm3.ini file, instead we use .env file
There was a problem hiding this comment.
We are now using dotenv in Cypht.
MR: https://github.com/cypht-org/cypht/pull/846
MR: cypht-org/cypht#823
Shadow243
force-pushed
the
env-file-support
branch
from
b93f2ae to
76a99db
Compare
install-1x.html
Outdated
There was a problem hiding this comment.
This page needs to be adapted to have instructions for Cypht 1.4.x and not have instructions like wget https://github.com/cypht-org/cypht/archive/master.zip
There was a problem hiding this comment.
Do we keep Docker installation instructions ??
There was a problem hiding this comment.
Do we keep Docker installation instructions ??
@rodriguezny Please!
There was a problem hiding this comment.
Yes, please keep Docker and YunoHost installation instructions as they are, they are not affected by the migration to .env as in Docker and YunoHost we do all the process of the manual installation for the user when building images for Docker and packages for YunoHost.
There was a problem hiding this comment.
Copy that @rodriguezny.
@Baraka24 @marclaporte the PR is okay now I guess
Shadow243
force-pushed
the
env-file-support
branch
from
76a99db to
316aa41
Compare
| </pre> | ||
| <p>The /var/lib/hm3/users directory is only required if you are using the file-system and not a database to store user settings (user_config_type = file in the .env). You can put these directories anywhere, just make sure the values in the ini file point to the right place. | ||
| </p> | ||
| <h4>4. Generate Dynamic Run-Time Configuration</h4> |
There was a problem hiding this comment.
Is step 4 still required? I expect no, Last time while sharing with @josaphatim, he told me that We have to be reloading after updating .enve file. Please @Shadow243 see together If I am right.
There was a problem hiding this comment.
Yes @Baraka24.
This why we will keep it:
Recent updates have streamlined the process, and running the command above will now specifically generate the config/dynamic.php file. This file incorporates dynamic configurations, including 'handler_modules,' 'output_modules,' and 'input_filters.' Furthermore, the command continues to optimize the configuration and combine/minimize page assets, ensuring efficient runtime operation.
Additionally, executing this command will create a sub-directory called 'site' that contains the code and page assets required within the document root. If you ever relocate the source location, you'll need to re-run the config_gen script to update the program.
|
First issue: There are links to https://www.cypht.org/install.html that are now broken. When a page is deleted, it's a good practice to put a permanent redirect. Second issue: We should also have a page to install Cypht master (future Cypht 3.0) which now requires PHP 8.1 I suggest to put back a page at https://www.cypht.org/install.html and on there, offer links to Cypht 1.x, 2.x and master |
Cypht Migration Updates
As requested https://avan.tech/item98840, the install.html has been updated to accommodate updates related to Cypht's migration from hm3.ini to .env file configurations.