Warning, /frameworks/kuserfeedback/INSTALL is written in an unsupported language. File is not indexed.

0001 # Telemetry library, management/analysis console
0002 
0003 The usual cmake/make/make install.
0004 
0005 # Server
0006 
0007 Requires PHP >= 5.5 and Sqlite, MySQL or PostgreSQL, Apache with SSL set up.
0008 
0009 - copy src/server to your webserver
0010 - (alternatively) use "make deploy", after setting the SERVER_DEPLOY_HOST and SERVER_DEPLOY_PATH
0011   cmake options accordingly
0012 - make sure .htaccess files are enabled by your Apache settings
0013 - set up authentication:
0014     - users with access to the analytics sub-folder have read-only access to all product settings
0015       and telemetry data
0016     - users with additional access to the admin sub-folder have write access to all products
0017 - rename config/localconfig.php.example to config/localconfig.php and adjust
0018   settings in there based on your database setup
0019 - connect to the server using either UserFeedbackConsole or the userfeedbackctl command line tool,
0020   that will trigger the database
0021 - (optional) verify that access controls a set up correctly using the 'userfeedbackctl scan-server'
0022   command
0023 
0024 Docker users might find https://github.com/KDAB/kuserfeedbackdocker useful.
0025 
0026 
0027 ## Local Development
0028 
0029 The following setup works locally without the need of a full webserver with SSL and authentication
0030 setup. It's also used by the automated tests.
0031 
0032 - configure database access via src/server/config/localconfig.php as described above
0033 - in src/testserver, run: 'php -S localhost:1984 router.php'
0034 - connect via UserFeedbackConsole to trigger database setup