diff --git a/README.md b/README.md index fb3e6d4..d834529 100644 --- a/README.md +++ b/README.md @@ -15,27 +15,27 @@ 2. Navigate to the install folder `cd install` 3. Run the install bash script. Note that you must specify the web user which apache is serving as, e.g. www-root or http etc.. +The install.sh script will automatically pull the latest version so it can be run at any time to update the system. +The first time install.sh is run, it will require the presence of conf.php. You will need to fill this in with specific information +relative to your setup. An template file is supplied as conf-sample.php. -Add this line in the sudoers file (use visudo) and it must go AFTER the %sudo line +The last thing which needs to be done is to edit the sudoers file using visudo. The following line should be added: +> www-data ALL=(ALL) NOPASSWD: /usr/bin/php /var/www/html/bin/run-bu-by-id.php * -www-data ALL=(ALL) NOPASSWD: /usr/bin/php /var/www/html/bin/run-bu-by-id.php * +This line shoul be towards the end of the file, e.g. AFTER the %sudo line if you have one. -> [!NOTE] -> A test note - +``` Test by switching user to www-data: su -s /bin/bash www-data cd /var/www/html php bin/run-bu-by-id.php 19 0 where 19 is the backup id and 0/1 is not-test/test - -Comment out /inc/secure.php in post_handler.php if the login is not required - -Highlighted `wxallowed` +``` -html anchor [mount(8)](https://man.openbsd.org/mount.8)) - +Comment out /inc/secure.php in post_handler.php if the login is not required + + ### Project directory structure ```sh @@ -45,20 +45,12 @@ ├─css All CSS files ├─img All image files ├─inc All php files. This directory is NOT served - └─js All JS files + ├─data All data files. This directory is NOT served + └─js All JS files └─install Install and update scripts ``` -### Updating the App - -To pull down the latest changes from the repo, navigate to you project directory (where the original clone was -performed) and then the install folder. In there, run the bash script install.sh - -Note that you need to specify the user which your web-server is running as. - -This script will pull the latest changes from the repo and perform any additionally required data/file updates - TODO: create an install script: -- currently all manually done