diff --git a/README.md b/README.md index 947abf3..7134e72 100644 --- a/README.md +++ b/README.md @@ -23,13 +23,16 @@ Running - Install all dependencies listed above. You might want to use a [virtualenv](http://virtualenv.readthedocs.org/). + - Create the SQL database defined in `schema.sql`. Also create the `cache` and `cache_data` tables defined by [earwigbot-plugins](https://github.com/earwig/earwigbot-plugins/blob/develop/tasks/schema/afc_copyvios.sql); this can be in the same or a different database. + - Create an earwigbot instance in `.earwigbot` (run `earwigbot .earwigbot`). In `.earwigbot/config.yml`, fill out the connection info for the database(s) above by adding the following to the `wiki` section: + _copyviosSQL: globals: host: @@ -37,11 +40,16 @@ Running cache: host: db: + If additional arguments are needed by `oursql.connect()`, like usernames or passwords, they should be added to the `globals` and `cache` sections. + - Copy `.lighttpd.conf` to the relevant location (on Tool Labs, this is in the root of the project's home directory) and adjust its contents as necessary. + - Run `./build.py` to minify JS and CSS files. + - Adjust the hashbang in `app.fcgi` to point to the correct Python interpreter or virtual environment. + - Start lighttpd (on Tool Labs, `webservice start`).