Add TESTING instructions for web interface

Add instructions to test aurweb's web interface via the PHP built-in web
server.

Signed-off-by: Mark Weiman <mark.weiman@markzz.com>
Signed-off-by: Lukas Fleischer <lfleischer@archlinux.org>
This commit is contained in:
Mark Weiman 2017-04-12 00:56:16 -04:00 committed by Lukas Fleischer
parent 2c3c8417fb
commit 906a8f12cc
2 changed files with 40 additions and 0 deletions

View file

@ -1,6 +1,14 @@
Setup on Arch Linux
===================
For testing aurweb patches before submission, you can use the instructions in
TESTING for testing the web interface only.
Note that you can only do limited testing using the PHP built-in web server.
In particular, the cgit interface will be unusable as well as the ssh+git
interface. For a detailed description on how to setup a full aurweb server,
read the instructions below.
1) Clone the aurweb project:
$ cd /srv/http/

32
TESTING Normal file
View file

@ -0,0 +1,32 @@
Setup Testing Environment
=========================
Note that this setup is only to test the web interface. If you need to have a
full aurweb instance with cgit, ssh interface, etc, follow the directions in
INSTALL.
1) Clone the aurweb project:
$ git clone git://git.archlinux.org/aurweb.git
2) Install php and necessary modules:
# pacman -S php php-sqlite sqlite
3) Prepare the testing database:
$ cd /path/to/aurweb/schema
$ make
$ ./gendummydata.py out.sql
$ sqlite3 ../aurweb.sqlite3 < aur-schema-sqlite.sql
$ sqlite3 ../aurweb.sqlite3 < out.sql
4) Copy conf/config.proto to conf/config and adjust the configuration
(pay attention to disable_http_login, enable_maintenance and aur_location).
Be sure to change backend to sqlite and name to the file location of your
created test database.
5) Run the PHP built-in web server:
$ AUR_CONFIG='/path/to/aurweb/conf/config' php -S localhost:8080 -t /path/to/aurweb/web/html