Update docs
This commit is contained in:
38
README.md
38
README.md
@@ -21,11 +21,15 @@ For example:
|
||||
|
||||
Next, install the database:
|
||||
|
||||
./manage.py syncdb --migrate --noinput
|
||||
$ ./manage.py syncdb --migrate --noinput
|
||||
|
||||
Finally, create a superuser account:
|
||||
Then, create a superuser account:
|
||||
|
||||
./manage.py createsuperuser
|
||||
$ ./manage.py createsuperuser
|
||||
|
||||
If you're using beanstalkd for webchat and server events, start it up:
|
||||
|
||||
$ beanstalkd
|
||||
|
||||
# Updating
|
||||
|
||||
@@ -36,3 +40,31 @@ Finally, create a superuser account:
|
||||
Check out the pip-requirements file. You can install them with:
|
||||
|
||||
# pip install -r pip-requirements
|
||||
|
||||
beanstalkd is a soft dependency. It provides webchat and server
|
||||
event processing.
|
||||
|
||||
# Tools
|
||||
|
||||
There are a couple of tools that come with caminus.
|
||||
|
||||
## Event Stats
|
||||
|
||||
$ ./manage.py event_stats
|
||||
|
||||
This prints out various statistics about the beanstalkd event queues.
|
||||
|
||||
## Flush Events
|
||||
|
||||
$ ./manage.py flush_events
|
||||
|
||||
This flushes out all the beanstalkd event queues. All of them, not just caminus
|
||||
ones. Forever. It can break things and cause lost data if you aren't careful
|
||||
and know exactly why you need to flush the queue.
|
||||
|
||||
## Server Broadcast
|
||||
|
||||
$ ./manage.py server_broadcast "Your Message"
|
||||
|
||||
Sends a universe-wide broadcast that shows up in all servers and active
|
||||
webchats.
|
||||
|
Reference in New Issue
Block a user