2016-07-10 15:32:38 +00:00
# README #
2018-04-03 11:50:36 +00:00
A simple webinterface for users. This app uses [`admin_rest` ](https://github.com/snowblindroan/mod_admin_rest ) module of prosody. So [prosody.im ](http://prosody.im ) and this module are hard dependencies. The interface allows users
2016-07-11 14:57:48 +00:00
* to have two step verification (as an alternative to the integrated `register_web` module),
* to delete of their accounts and
* to change their password.
2016-07-10 15:32:38 +00:00
This app uses
* Slim Version 3
2016-07-11 14:57:48 +00:00
* Slim Auth
2016-07-10 15:32:38 +00:00
* Eloquent ORM
* PHPMigration
* GUMP Validation
* Twig
* Curl
* PHPMailer
* Symfony Translation
* Sqlite
as dependencies.
## Requirements ##
* admin_rest module of prosody
* composer
* sqlite pdo, mb_string
## Install ##
* Install composer
* Change directory to project home
* Copy `config/env.example` to `config/env` and adjust to your needs
2018-05-18 13:01:16 +00:00
* Copy `config/legal.example.md` to `config/legal.md` and adjust to your needs
2016-07-10 15:32:38 +00:00
* `composer install`
* `php bin/phpmig migrate`
## Deployment ##
* Set up a cron job using `php projectRootDir/bin/UsersAwaitingVerificationCleanUpCronJob.php` to clean up users who signed up but did not verify their account periodically.
* Point your document root to `public/` .
* Example nginx conf:
2016-07-11 20:29:44 +00:00
2018-05-24 11:49:28 +00:00
```
root .../public;
index index.php;
rewrite_log on;
location / {
try_files $uri $uri/ @ee ;
}
location @ee {
rewrite ^(.*) /index.php?$1 last;
}
# php fpm
location ~ \.php$ {
fastcgi_split_path_info ^(.+\.php)(/.+)$;
fastcgi_pass unix:/var/run/php-fpm/php-fpm.sock;
include fastcgi_params;
}
```
You should be able to set a very strict Content-Security-Policy.
2016-07-10 15:32:38 +00:00
## Upgrade ##
* Change directory to project home
* `git pull`
* `composer update`
* `php bin/phpmig migrate`
2016-07-11 20:29:44 +00:00
* look into Changelog for major changes
2016-07-10 15:32:38 +00:00
2018-04-03 11:49:57 +00:00
## Developers ##
* start server with `php -S localhost:8080 -t public public/index.php`
* point browser to [localhost:8080 ](http://localhost:8080 ) to have a preview
2016-07-10 15:32:38 +00:00
## Translations ##
2016-07-11 20:29:44 +00:00
This app uses Symfony Translator. It's bootstraped in `Util\BootstrapHelper` and locales are placed under `data/locale/` . Adjust to your needs or help translating.
2016-07-10 18:45:42 +00:00
## Changelog ##
2018-05-24 11:49:28 +00:00
- 0.3.0.1
- Remove cookie consent as session cookies should be allowed because they provide core functionality
- Adjust `legal.example.md` and add `PHPSESSID`
- Fix styles
2018-05-24 00:00:43 +00:00
- 0.3.0.0
- Fixes
- Cookie consent
2018-05-18 13:01:16 +00:00
- 0.2.0.1
- Design fixes
- GDPR adjustments (specify agreement in a `.md` file)
2018-05-17 11:38:51 +00:00
- 0.1.3.3 to 0.2.0.0
- update to latest yaml
- Force to lower on email and username
- Update README and htaccess for Apache
- Change to bootstrap4 theme
- Add legal information hint on sign up page
2016-07-11 20:29:44 +00:00
- 0.1.3.2:
- Refactor
- Bugfixes
- Add possibility to determine LogLevel and logger name in environment
- 0.1.3.1:
- Bugfixes
2016-07-11 15:02:27 +00:00
- 0.1.3:
2016-07-11 14:57:48 +00:00
- add authentication after sign up
- only logged in users can delete their account (with the help of the token)
- only logged in users can change their account password
2016-07-11 15:02:27 +00:00
- 0.1.2:
- Bugfixes
2016-07-10 18:45:42 +00:00
- 0.1.1:
- updated readme and `env.example`
- fix some language validator inconsistencies
- added admin notifications
2016-07-11 20:29:44 +00:00
- added possibility for users to delete their account
2016-07-10 18:45:42 +00:00
- added back index page
- works with mod_admin_rest version [afc42d7 ](https://github.com/snowblindroan/mod_admin_rest/commit/afc42d70f0aceb2351a1bc786d61e3f4dbdfb948 )
- 0.1:
- initial release
- works with mod_admin_rest version [afc42d7 ](https://github.com/snowblindroan/mod_admin_rest/commit/afc42d70f0aceb2351a1bc786d61e3f4dbdfb948 )