Add prereq check to README. Remove installation by cloning. Fix CI typos. (#31)

Reviewed-on: https://gitea.subcultureofone.org/greg/tkr/pulls/31
Co-authored-by: Greg Sarjeant <greg@subcultureofone.org>
Co-committed-by: Greg Sarjeant <greg@subcultureofone.org>
This commit is contained in:
Greg Sarjeant 2025-07-28 01:04:46 +00:00 committed by greg
parent dc44d51479
commit 681f64c527
2 changed files with 13 additions and 16 deletions

View File

@ -40,7 +40,7 @@ jobs:
container: ${{ matrix.container }}
steps:
- name: Install Node.js fnd git or actions
- name: Install Node.js and git
run: |
if [ -f /etc/fedora-release ]; then
dnf install -y nodejs npm git
@ -154,7 +154,7 @@ jobs:
- name: Test with missing directories
run: |
# Remove required directories
rm -rf src templates config
rm -rf src templates
# Should fail
if php check-prerequisites.php; then

View File

@ -65,22 +65,19 @@ I'm trying to make sure that the HTML is both semantically valid and accessible,
* The SSL configurations are basic, but should work. For more robust SSL configurations, see https://ssl-config.mozilla.org
### From git
If you'd prefer to install from git:
1. Clone this directory and copy the `/tkr` directory to your web server.
* Required subdirectories are:
1. `config`
1. `public`
1. `src`
1. `storage`
1. `templates`
* Exclude the other directories
2. Follow the main installation from step 4.
## Initial configuration
1. Run `php tkr/prerequisites.php`. This will confirm that:
1. PHP 8.2+ is installed
1. All required PHP extensions are installed
1. PDO
1. PDO::sqlite
1. All required directories exist
1. The `tkr/storage` directory exists and is writable
1. If `tkr/storage` is writable, then it will create the required subdirectories
1. `tkr/storage/db`
1. `tkr/storage/upload`
1. The script will write a summary to stdout and will save a log at `tkr/storage/prerequisite-check.log`
1. Edit `config/init.php` to set the domain and base path correctly for your configuration.
* subdirectory installation (e.g. https://my-domain.com/tkr)
```