Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@irusri
irusri committed Sep 5, 2019
1 parent ec9fb36 commit e3a16c5
Showing 1 changed file with 35 additions and 35 deletions.
70 changes: 35 additions & 35 deletions docs/installation_updates.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,26 @@ Installation & Updates
=====================

------------------------
Download the GenIE-CMS
Download the GenIE-Sys
------------------------

You can download the latest version of GenIECMS by using the official download link:
You can download the latest version of GenIE-Sys by using the official download link:

[![](https://raw.githubusercontent.com/irusri/GenIECMS/master/docs/images/download.png)](https://github.com/irusri/GenIECMS/archive/master.zip)
[![](https://raw.githubusercontent.com/irusri/geniesys/master/docs/images/download.png)](https://github.com/irusri/geniesys/archive/master.zip)

Please note that the above link will onlu download the source code for the GenIE-CMS. If you need to download the parsing scripts, you need to download it [here](https://github.com/irusri/scripts/archive/master.zip).
Please note that the above link will onlu download the source code for the GenIE-Sys. If you need to download the parsing scripts, you need to download it [here](https://github.com/irusri/scripts/archive/master.zip).

If you prefer using the terminal please run to download both the CMS and parsing scripts:
If you prefer using the terminal please run to download both the GenIE-Sys and parsing scripts:

```
git clone --recursive https://github.com/irusri/GenIECMS.git
git clone --recursive https://github.com/irusri/geniesys.git
```

------------------
GenIECMS's folder structure
GenIE-Sys's folder structure
------------------
```shell
├── GenIECMS
├── geniesys
│   ├── data
│   ├── docs
│   ├── genie_files
Expand All @@ -35,41 +35,41 @@ GenIECMS's folder structure
```

------------------------
Installing GenIECMS on a Mac
Installing GenIE-Sys on a Mac
------------------------
Most Mac users will probably try GenIECMS with MAMP.
Most Mac users will probably try GenIE-Sys with MAMP.

[![](https://github.com/irusri/GenIECMS/blob/master/docs/images/mamp.png?raw=true )](http://www.mamp.info/en/downloads/)
[![](https://github.com/irusri/geniesys/blob/master/docs/images/mamp.png?raw=true )](http://www.mamp.info/en/downloads/)

**Installing MAMP**

Installing MAMP is just a matter of downloading the app from the MAMP website and running the installer. It will install a MAMP app in your Applications folder.

[![](https://github.com/irusri/GenIECMS/blob/master/docs/images/mamp-02.png?raw=true)](http://www.mamp.info/en/downloads/)
[![](https://github.com/irusri/geniesys/blob/master/docs/images/mamp-02.png?raw=true)](http://www.mamp.info/en/downloads/)

By starting the MAMP app you are also starting your Apache and MySQL server. You should now be able to reach your local server at ```http://localhost:8888```.

It is convenient to change the MySQL and Apache ports to 3306 and 80 respectively to use default MySQL and Apache ports.

[![](https://github.com/irusri/GenIECMS/blob/master/docs/images/mamp_settings.png?raw=true)](http://www.mamp.info/en/downloads/)
[![](https://github.com/irusri/geniesys/blob/master/docs/images/mamp_settings.png?raw=true)](http://www.mamp.info/en/downloads/)

**Download GenIECMS**
**Download GenIE-Sys**

[![](https://github.com/irusri/GenIECMS/blob/master/docs/images/download.png?raw=true)](https://github.com/irusri/GenIECMS/archive/master.zip)
[![](https://github.com/irusri/geniesys/blob/master/docs/images/download.png?raw=true)](https://github.com/irusri/geniesys/archive/master.zip)

**Copy GenIECMS to MAMP Web server**
**Copy GenIE-Sys to MAMP Web server**

You will find the source of GenIECMS in your download folder. So you just need to Copy GenIECMS folder into corresponding ```~/Applications/MAMP/htdocs/``` folder.
You will find the source of GenIE-Sys in your download folder. So you just need to Copy GenIE-Sys folder into corresponding ```~/Applications/MAMP/htdocs/``` folder.

That is basically what you need to do in order to install GenIECMS on your Mac's local server. You should now be able to access it at: ```http://localhost:8888/GenIECMS``` in your browser.
That is basically what you need to do in order to install GenIE-Sys on your Mac's local server. You should now be able to access it at: ```http://localhost:8888/geniesys``` in your browser.

-----------------
Docker installation
-----------------
For Developers and Contricutors

```
# Please comment the supporting_files/run.sh line to avoid download the geniecms.git
# Please comment the supporting_files/run.sh line to avoid download the geniesys.git
git clone https://github.com/irusri/docker4geniecms.git
cd docker4geniecms
git submodule add -f https://github.com/irusri/genie.git
Expand Down Expand Up @@ -99,23 +99,23 @@ Now we can start the real development and push changes into genie.
------------------------
Running from Command Line
------------------------
If you want to use PHP's built-in server (not recommended), just use following lines to install GenIECMS. This is only for the initial test installation, in order to make a full functional website you have to install Webbserver package such as MAMP or LAMP.
If you want to use PHP's built-in server (not recommended), just use following lines to install GenIE-Sys. This is only for the initial test installation, in order to make a full functional website you have to install Webbserver package such as MAMP or LAMP.

```
git clone --recursive https://github.com/irusri/GenIECMS.git
cd GenIECMS
git clone --recursive https://github.com/irusri/geniesys.git
cd geniesys
php -S localhost:3000
```
You should now be able to access GenIECMS at: ```http://localhost:3000``` in your browser.
You should now be able to access geniesys at: ```http://localhost:3000``` in your browser.

------------------------
Update configuration file
------------------------
We should update the settings file(```GenIECMS/plugins/settings.php```) right after the installtion. Especially the base URL depending on your webhost. For example:
We should update the settings file(```geniesys/plugins/settings.php```) right after the installtion. Especially the base URL depending on your webhost. For example:

```php
/*Define your base url with trailing slash*/
$GLOBALS["base_url"]='http://localhost:8888/GenIECMS/';
$GLOBALS["base_url"]='http://localhost:8888/geniesys/';

OR

Expand All @@ -129,23 +129,23 @@ Next, we need to create a MySQL database and load our data.
------------------------
Troubleshooting
------------------------
GenIECMS can easily be installed without an effort. Unfortunately there is always space for problems due to multiple server setups and PHP versions. In this section, we try to answer most frequent issues in order to install GenIECMS as effortless as possible. Please send us an email if you still get trouble with installation or updates: ```contact@geniecms.org```
GenIE-Sys can easily be installed without an effort. Unfortunately there is always space for problems due to multiple server setups and PHP versions. In this section, we try to answer most frequent issues in order to install GenIE-Sys as effortless as possible. Please send us an email if you still get trouble with installation or updates: ```contact@geniecms.org```

**Subfolder permissions**

Web server runs in a different group than your user account on most servers. Following subfolder permissions will necessary to grant write access from GenIECMS.:
Web server runs in a different group than your user account on most servers. Following subfolder permissions will necessary to grant write access from GenIE-Sys.:
```
chgrp -R www-data GenIECMS
chmod -R 775 GenIECMS/genie_files
chgrp -R www-data geniesys
chmod -R 775 geniesys/genie_files
```
Please make sure that the root folder is also readable by the webserver.

**Broken subpages**

Whenever you have problems(can not open or a server error) with subpages, you can try following steps.
* Make sure that the .htaccess file is present inside GenIECMS folder.
* Make sure that the .htaccess file is present inside GenIE-Sys folder.
* mod_rewrite should be enabled on your server.
* You need to check the .htaccess. You can test this by adding some extra characters into your .htaccess. If this cause an "Internal Server Error", the file gets loaded. Otherwise, you need to enable AllowOverride all in your Web server configuration file. An example of ```GenIECMS/.htaccess``` file shown below.
* You need to check the .htaccess. You can test this by adding some extra characters into your .htaccess. If this cause an "Internal Server Error", the file gets loaded. Otherwise, you need to enable AllowOverride all in your Web server configuration file. An example of ```geniesys/.htaccess``` file shown below.

```
RedirectMatch 403 ^.*/genie_files/
Expand All @@ -168,18 +168,18 @@ Please make sure that you are using the PHP 5.4 or higher.
Please contact us:```contact@geniecms.org```

-----------------
GenIECMS updates
GenIE-Sys updates
-----------------
**Manual updates**

GenIECMS can be updated manually using latest ZIP file from [GitHub](https://github.com/irusri/GenIECMS/archive/master.zip). Please backup your older version of ```GenIECMS/plugins/settings.php``` and ```GenIECMS/genie_files``` before you do the latest update. First unzip the genie.zip file from your download folder and move into the Web Server server. Finally copy the ```GenIECMS/plugins/settings.php``` and ```GenIECMS/genie_files``` into latest version of GenIECMS.
GenIE-Sys can be updated manually using latest ZIP file from [GitHub](https://github.com/irusri/geniesys/archive/master.zip). Please backup your older version of ```geniesys/plugins/settings.php``` and ```geniesys/genie_files``` before you do the latest update. First unzip the genie.zip file from your download folder and move into the Web Server server. Finally copy the ```geniesys/plugins/settings.php``` and ```geniesys/genie_files``` into latest version of GenIE-Sys.

**Updates using Git**

Here is the easy way to update GenIECMS using git submodules:
Here is the easy way to update GenIE-Sys using git submodules:

```
cd GenIECMS
cd GenIE-Sys
git checkout master
git pull
git submodule foreach --recursive git checkout master
Expand Down

0 comments on commit e3a16c5

Please sign in to comment.