diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/client.txt | 12 | ||||
| -rw-r--r-- | docs/server.txt | 31 | ||||
| -rw-r--r-- | docs/setup.txt | 48 |
3 files changed, 43 insertions, 48 deletions
diff --git a/docs/client.txt b/docs/client.txt new file mode 100644 index 0000000..c0dbd23 --- /dev/null +++ b/docs/client.txt @@ -0,0 +1,12 @@ + +To install the client, use the ebuild found in the +overlay/app-portage/gentoostats directory. + +An uuid and password will be automagically generated and saved in +/etc/gentoostats/auth.cfg + +To restrict submission of specific stats, edit /etc/gentoostats/payload.cfg + +To submit your stats, run gentoostats-send as root. + +To access stats on the command line, use gentoostats-cli. diff --git a/docs/server.txt b/docs/server.txt new file mode 100644 index 0000000..586933f --- /dev/null +++ b/docs/server.txt @@ -0,0 +1,31 @@ + +Installing the server using the www-apps/gentoostats ebuild, or copy the files +in the server directory to a location. + +Plugin the following wsgi script in some subdirectory of /var/www/ + + import sys + sys.path.append('<path to webapp directory>') + from app import app + application = app.wsgifunc() + +Edit mod_wsgi.conf and add the following lines or similar, depending upon the +appropriate path. + + <IfDefine WSGI> + LoadModule wsgi_module modules/mod_wsgi.so + WSGIScriptAlias <prefix> <path to wsgi handler> + Alias /<prefix>/static /var/www/<prefix>/static/ + AddType text/html .py + <Directory /var/www/<prefix>/> + Order deny,allow + Allow from all + </Directory> + </IfDefine> + +Copy db.cfg.example to db.cfg in the webapp directory, and modify the database +configuration as necessary. The database should be initialized using the sql +scripts in the sql/ subdirectory. + +To run tests, make sure the server is running, and execute the runtests.py +script in the webapp directory. diff --git a/docs/setup.txt b/docs/setup.txt deleted file mode 100644 index ef2cc35..0000000 --- a/docs/setup.txt +++ /dev/null @@ -1,48 +0,0 @@ - -Gentoostats -=========== - -Server -====== -Dependencies ------------- -dev-db/mysql -dev-python/mysql-python -dev-python/webpy -=dev-lang/python-2.* - -Instructions ------------- -* Start the mysql server -* Execute server/sql/setup.sql as mysql root user - - mysql -u root -p < server/sql/setup.sql - -* Execute server/sql/init.sql as user gentoo, password gentoo - - mysql -u gentoo -p < server/sql/init.sql - -* Start the main.py script, either from the server/ directory or - by exporting PYTHONPATH - - export PYTHONPATH=server/ - server/main.py - - -Client -====== -Dependencies ------------- -=dev-lang/python-2.* -app-portage/gentoolkit - -Instructions ------------- -* Set host uuid and password in client/bin/client -* Execute client/bin/client as root or some user in portage group - - export PYTHONPATH=client/ - client/bin/client - - -P.S. All paths are relative to source directory |