chore: sync module from working instance and add install guide

This commit is contained in:
Kelin Rescue Hub
2026-04-09 14:16:53 -04:00
parent 87a59e5a0a
commit 69c348ce27
9 changed files with 360 additions and 59 deletions

55
INSTALL.md Normal file
View File

@@ -0,0 +1,55 @@
# Space Profiles Installation Guide
This guide installs the `space_profiles` module in a reusable way for any HumHub instance.
## 1. Requirements
- HumHub `1.14+`
- Module directory access on the target instance
- Optional but recommended: `rescue_foundation` module
## 2. Clone into HumHub Modules Directory
The folder name must be exactly `space_profiles`.
```bash
git clone https://gitea.kelinreij.duckdns.org/humhub-modules/space-profiles.git \
/var/www/localhost/htdocs/protected/modules/space_profiles
```
If the folder already exists:
```bash
cd /var/www/localhost/htdocs/protected/modules/space_profiles
git pull
```
## 3. Enable the Module
In HumHub UI:
1. Go to `Administration` -> `Modules`.
2. Enable `Space Profiles`.
3. Enable it per space where needed.
## 4. Run Migrations
From the HumHub app host/container:
```bash
php /var/www/localhost/htdocs/protected/yii migrate/up \
--include-module-migrations=1 --interactive=0
```
## 5. Verify
1. Open a space with module enabled.
2. Confirm profile page renders the template sections.
3. Confirm space settings page saves expected profile fields.
## Docker Example
```bash
docker exec humhub php /var/www/localhost/htdocs/protected/yii migrate/up \
--include-module-migrations=1 --interactive=0
```