From 302b320c59bda7a1e6dd5bae8a3fe060a1b23a0b Mon Sep 17 00:00:00 2001 From: Marcu Vadim <48514651+MarcuV@users.noreply.github.com> Date: Tue, 4 Jun 2019 10:19:58 +0300 Subject: [PATCH 1/3] Update README.md Added flavor text and the installation proccess to the readme.md file --- README.md | 44 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 43 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 68a5408..a7a0d62 100644 --- a/README.md +++ b/README.md @@ -5,5 +5,47 @@ ![Docker Build](https://img.shields.io/docker/cloud/build/trydirect/modx.svg) [![Gitter chat](https://badges.gitter.im/trydirect/community.png)](https://gitter.im/try-direct/community) -# modx +# MODX +The MODX Digital Experience Platform gives you complete control over your creative vision and the experiences you deliver. Have peace of mind that your sites will be easily maintained, delivered with unparalleled performance and security, and that if you need help along the way, it’s there. + +# Installation + +First off, download MODX and extract the files to your server. In the setup/ directory, copy the file "config.dist.new.xml" and rename it to "config.xml". MODX will automatically look for the setup/config.xml file during installation. You can move it outside of the setup/ directory (and the MODX webroot, if you choose), and specify its location with the "--config=/path/to/config.xml" argument. + +Next, edit the XML file and set the appropriate database information, MODX paths, and other configuration parameters, and then in your command line prompt, browse to the MODX setup/ directory, and type: + +``` +$ php ./index.php --installmode=new +``` +MODX will proceed to install, and when finished will display the time it took to run the installation, as well as any errors that occurred (which will also be logged in an install log file in core/cache/logs/). + +Note : if your core folder is in a "non-standard" location, you might want to use: +``` +$ --core_path=/path/to/core/ +``` +# Basic Upgrade + +Follow the same steps as new installations, but this time in your XML file you need only specify the following attributes: +- inplace +- unpacked +- language +- remove_setup_directory + +And any other attributes you would like to change during the upgrade. There is an example upgrade xml file named "config.dist.upgrade.xml". Then, once you are ready, browse to the MODX setup directory, and type: +``` +$ php ./index.php --installmode=upgrade +``` +This will upgrade your MODX installation, and when finished will display the time it took to run the installation, as well as any errors that occurred (which will also be logged in an install log file in core/cache/logs/). + +# Advance Upgrade + +Follow the same steps as basic upgrade, but this time in your XML file you need all the attributes included in the config.dist.upgrade-advanced.xml file, as all can be changed in an advanced upgrade. + +Then, once you are ready, browse to the MODX setup directory, and type: +``` +$ php ./index.php --installmode=upgrade-advanced +``` +This will upgrade your MODX installation, and when finished will display the time it took to run the installation, as well as any errors that occurred (which will also be logged in an install log file in core/cache/logs/). + +# Deployment Deploy MODX with docker-compose.yml From 713455b772b0af2686c5943134324150e921af1e Mon Sep 17 00:00:00 2001 From: Marcu Vadim <48514651+MarcuV@users.noreply.github.com> Date: Tue, 4 Jun 2019 16:12:54 +0300 Subject: [PATCH 2/3] Updated README.md --- README.md | 60 +++++++++++++++++++++++-------------------------------- 1 file changed, 25 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index a7a0d62..143ed15 100644 --- a/README.md +++ b/README.md @@ -5,47 +5,37 @@ ![Docker Build](https://img.shields.io/docker/cloud/build/trydirect/modx.svg) [![Gitter chat](https://badges.gitter.im/trydirect/community.png)](https://gitter.im/try-direct/community) -# MODX -The MODX Digital Experience Platform gives you complete control over your creative vision and the experiences you deliver. Have peace of mind that your sites will be easily maintained, delivered with unparalleled performance and security, and that if you need help along the way, it’s there. - -# Installation - -First off, download MODX and extract the files to your server. In the setup/ directory, copy the file "config.dist.new.xml" and rename it to "config.xml". MODX will automatically look for the setup/config.xml file during installation. You can move it outside of the setup/ directory (and the MODX webroot, if you choose), and specify its location with the "--config=/path/to/config.xml" argument. - -Next, edit the XML file and set the appropriate database information, MODX paths, and other configuration parameters, and then in your command line prompt, browse to the MODX setup/ directory, and type: - -``` -$ php ./index.php --installmode=new -``` -MODX will proceed to install, and when finished will display the time it took to run the installation, as well as any errors that occurred (which will also be logged in an install log file in core/cache/logs/). +## Note +Before installing this project, please, make sure you have installed docker and docker-compose -Note : if your core folder is in a "non-standard" location, you might want to use: -``` -$ --core_path=/path/to/core/ +To install docker execute: +```sh +$ curl -fsSL https://get.docker.com -o get-docker.sh +$ sh get-docker.sh +$ pip install docker-compose ``` -# Basic Upgrade -Follow the same steps as new installations, but this time in your XML file you need only specify the following attributes: -- inplace -- unpacked -- language -- remove_setup_directory +# MODX +This project allows developers to quickly start the development of MODX. -And any other attributes you would like to change during the upgrade. There is an example upgrade xml file named "config.dist.upgrade.xml". Then, once you are ready, browse to the MODX setup directory, and type: +# Installation +Clone this project into your work directory: +```sh +$ git clone "https://github.com/trydirect/modx.git" +$ cd modx ``` -$ php ./index.php --installmode=upgrade +Run stack with: +```sh +$ docker-compose up -d ``` -This will upgrade your MODX installation, and when finished will display the time it took to run the installation, as well as any errors that occurred (which will also be logged in an install log file in core/cache/logs/). +## Contributing -# Advance Upgrade +1. Fork it (https://github.com/trydirect/modx/fork) +2. Create your feature branch (git checkout -b feature/fooBar) +3. Commit your changes (git commit -am 'Add some fooBar') +4. Push to the branch (git push origin feature/fooBar) +5. Create a new Pull Request -Follow the same steps as basic upgrade, but this time in your XML file you need all the attributes included in the config.dist.upgrade-advanced.xml file, as all can be changed in an advanced upgrade. - -Then, once you are ready, browse to the MODX setup directory, and type: -``` -$ php ./index.php --installmode=upgrade-advanced -``` -This will upgrade your MODX installation, and when finished will display the time it took to run the installation, as well as any errors that occurred (which will also be logged in an install log file in core/cache/logs/). +## Support Development -# Deployment -Deploy MODX with docker-compose.yml +[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=2BH8ED2AUU2RL) From 65df895dfc80b123dfbf440fac7929a93c68c29b Mon Sep 17 00:00:00 2001 From: Marcu Vadim <48514651+MarcuV@users.noreply.github.com> Date: Tue, 4 Jun 2019 16:17:13 +0300 Subject: [PATCH 3/3] Delete README.md --- README.md | 41 ----------------------------------------- 1 file changed, 41 deletions(-) delete mode 100644 README.md diff --git a/README.md b/README.md deleted file mode 100644 index 143ed15..0000000 --- a/README.md +++ /dev/null @@ -1,41 +0,0 @@ -[![Build Status](https://travis-ci.com/trydirect/modx.svg?branch=master)](https://travis-ci.com/trydirect/modx) -![Docker Stars](https://img.shields.io/docker/stars/trydirect/modx.svg) -![Docker Pulls](https://img.shields.io/docker/pulls/trydirect/modx.svg) -![Docker Automated](https://img.shields.io/docker/cloud/automated/trydirect/modx.svg) -![Docker Build](https://img.shields.io/docker/cloud/build/trydirect/modx.svg) -[![Gitter chat](https://badges.gitter.im/trydirect/community.png)](https://gitter.im/try-direct/community) - -## Note -Before installing this project, please, make sure you have installed docker and docker-compose - -To install docker execute: -```sh -$ curl -fsSL https://get.docker.com -o get-docker.sh -$ sh get-docker.sh -$ pip install docker-compose -``` - -# MODX -This project allows developers to quickly start the development of MODX. - -# Installation -Clone this project into your work directory: -```sh -$ git clone "https://github.com/trydirect/modx.git" -$ cd modx -``` -Run stack with: -```sh -$ docker-compose up -d -``` -## Contributing - -1. Fork it (https://github.com/trydirect/modx/fork) -2. Create your feature branch (git checkout -b feature/fooBar) -3. Commit your changes (git commit -am 'Add some fooBar') -4. Push to the branch (git push origin feature/fooBar) -5. Create a new Pull Request - -## Support Development - -[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=2BH8ED2AUU2RL)