From d6406d4d65bee9ba392d6010b2251509421ae837 Mon Sep 17 00:00:00 2001 From: ileyd Date: Mon, 27 Jun 2016 12:05:46 +1000 Subject: Improved MySQL to SQLite migration instructions (#38) The initial paragraph explaining why you may prefer to use SQLite was made more brief, and rephrased to sound more neutral (note that it already was neutral). The clarifying section prior to the actual migration instructions was rewritten to better convey that the changes are non-destructive, and that they do not affect the user's main site until the final command (whose purpose is made clear), after verifying there are no issues. The instructions themselves have been modified to clarify where some commands are run from, their purpose, and also made more brief (the section itself is very slightly longer, but something happened to or I forgot to commit an important paragraph that was initially there). --- README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 0220a53..2b06d60 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ Node, or NPM. So we'll just assume you already have them all running well. Assuming you already have Node and NPM working, compilation is easy. Use the following shell code: ```bash -git clone --recursive https://github.com/pomf/pomf +git clone https://github.com/pomf/pomf cd pomf/ make make install @@ -103,11 +103,17 @@ Remember to enable `deflate_module` and `filter_module` modules in your Apache configuration file. ### Migrating from MySQL to SQLite + , +Compared to SQLite, MySQL is relatively complicated to administer, brings in many unneeded dependencies, and consumes more resources. Additonally, as a network service, poorly configured installations have the potential +to pose a security risk. -For older versions of Pomf you may want to migrate to SQLite. Fortunately, it is incredibly simple to migrate your database. This may be done on a live server, and should require zero downtime. +For these reasons, you may wish to use SQLite rather than MySQL. -_If doing this on a live server, you way wish to work in a subdirectory (or vhost, or equivelant), so that any complications or mistakes do not affect your main site. -If you choose not to do so, know that mistakes in the changes outlined below, will only temporarily impact **uploading**, causing **Server error** to be displayed. None of these steps are destructive, and are easily reverted._ +Fortunately, it is incredibly simple to migrate your database. This may be done on a live server, if you desire, and requires zero downtime. + +The process described below involves running these commands on a live server. Nothing done here affects your main site, until running the very last command, which is done after verifying there are no issues. + +No changes described here are destructive, and are easily reverted. They only have the potential to cause uploading to fail gracefully, and will not affect downloading. Run the following commands as root, to dump your database, and make a SQLite database with the contents. ```bash @@ -118,14 +124,15 @@ rm /tmp/m2s chown -R nginx:nginx /var/db/pomf #replace user as appropriate chmod 0750 /var/db/pomf && chmod 0640 /var/db/pomf/sq3 ``` -Edit the file `php/includes/settings.inc.php`, in the subdirectory you just made, making the changes outlined below. +Edit the file `php/includes/settings.inc.php`, in your **source directory**, making the changes outlined below. Note, changing the second two lines is optional, as they are simply ignored when using SQLite. ```php define('POMF_DB_CONN', '[stuff]'); ---> define('POMF_DB_CONN', 'sqlite:/var/db/pomf/pomf.sq3');` define('POMF_DB_USER', '[stuff]'); ---> define('POMF_DB_USER', null); define('POMF_DB_PASS', '[stuff]'); ---> define('POMF_DB_PASS', null); ``` +Then, run `make DESTDIR=/path/to/main_site/testing_dir` (note the *testing_dir* component) to rebuild the website, and copy it into place, in a new testing subdirectory. -Then, run `make` to rebuild the website pages, and copy the new `settings.inc.php` file into place. +Now, navigate to this subdirectory in your web browser, e.g. https://try.pantsu.cat/testing_dir, and verify that uploading works fine. If so, excellent! You may rerun `make DESTDIR=/path/to/main_site` to update your main site. All done! You may disable or uninstall MySQL if you wish. -- cgit v1.2.3 From 186b9bf0aed3638845544c1dad9f54297cc23413 Mon Sep 17 00:00:00 2001 From: Austin Date: Mon, 27 Jun 2016 16:09:19 -0500 Subject: Fix cloning instructions (again..) caused by commit 7ea276bbdf881905c1e2ad42ea0501de623da223 in PR #38 author being ileyd --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 2b06d60..0b7d9a3 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ Node, or NPM. So we'll just assume you already have them all running well. Assuming you already have Node and NPM working, compilation is easy. Use the following shell code: ```bash -git clone https://github.com/pomf/pomf +git clone --recursive https://github.com/pomf/pomf cd pomf/ make make install -- cgit v1.2.3 From 4e16303887a65cf010983afa784036549362d254 Mon Sep 17 00:00:00 2001 From: ileyd Date: Wed, 29 Jun 2016 03:38:08 +1000 Subject: Explains how to compile submodules --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 0b7d9a3..6204981 100644 --- a/README.md +++ b/README.md @@ -39,12 +39,27 @@ Node, or NPM. So we'll just assume you already have them all running well. ### Compiling -Assuming you already have Node and NPM working, compilation is easy. Use the -following shell code: +First you must get a copy of the pomf code. To do so, clone this git repo. +If you have no desire for any submodules, which includes the PHP backend, simply run +```bash +git clone https://github.com/pomf/pomf +``` +else, run ```bash git clone --recursive https://github.com/pomf/pomf +``` +to automatically fetch all of the submodules as well + +Assuming you already have Node and NPM working, compilation is easy. If you would like any additional submodules, or to exclude the default PHP submodule, use the `MODULES="..."` variable. + +Run the following commands to do so. +```bash cd pomf/ make +# alternatively +make MODULES="" # compile no submodules; exclude the default php backend module +make MODULES="php moe" # compile the php and moe submodules +# make install ``` OR -- cgit v1.2.3 From 2e2708c050e7fd3de7fe2008c6ddf5e0d03454fd Mon Sep 17 00:00:00 2001 From: Austin Date: Tue, 28 Jun 2016 20:57:26 -0500 Subject: Reword cloning steps Users that skim thru the readme will just copy paste the first commands they see without reading, they shouldn't be hosted a clone, but should still be catered to in some case. This is just simply flipping the commands around. --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 6204981..81252d7 100644 --- a/README.md +++ b/README.md @@ -40,15 +40,15 @@ Node, or NPM. So we'll just assume you already have them all running well. ### Compiling First you must get a copy of the pomf code. To do so, clone this git repo. -If you have no desire for any submodules, which includes the PHP backend, simply run +You will need to recursively clone the repo to get the required PHP submodule, +and the optional user panel submodule. ```bash -git clone https://github.com/pomf/pomf +git clone --recursive https://github.com/pomf/pomf ``` -else, run +If you don't want either of the submodules run the following command, ```bash -git clone --recursive https://github.com/pomf/pomf +git clone https://github.com/pomf/pomf ``` -to automatically fetch all of the submodules as well Assuming you already have Node and NPM working, compilation is easy. If you would like any additional submodules, or to exclude the default PHP submodule, use the `MODULES="..."` variable. -- cgit v1.2.3